Koa 源码介绍

发布于：

Koa 号称为 Node.js 的下一代 Web 框架。从多年以前的 Express 一枝独秀来看，确实如此，相比 Express 的函数回调写法，使用异步函数（或生成器函数）逻辑更符合人的思维，也避免回调嵌套。另外，虽然叫“框架”，但是与其他语言大而全的框架明显不同，Koa 相当轻量，大概提供了两个核心功能：

  • 简化 HTTP 请求行、状态行、请求与响应头部处理
  • 中间件机制，处理与控制数据流

其他 Web 开发常用的模块都需要通过中间件方式来实现，比如请求内容解析、路由、缓存、压缩等，当然数据库的访问也需要单独的包。

一个简单的 HTTP Server

不使用任何框架也可以写 Web 应用，Web 框架只是集成了 Web 开发当中常用的模式、功能，提供了友好的使用方式。下面是使用 Node.js http 模块创建的一个简单的 HTTP Server。

const http = require('http')

const server = http.createServer((req, res) => {
  res.end('hello world')
})

server.listen(8000)

其中req是一个 http.IncomingMessage 对象，包含 HTTP 请求相关信息。res是一个 http.ServerResponse 对象，包含 HTTP 响应相关信息以及操作方法。

Koa 的核心之一是简化了我们对 HTTP 请求与响应的访问与操作，比如：

  • 请求行信息：请求方法、请求路径（path）的解析、查询参数（querystring）解析
  • 请求状态信息获取与响应状态信息设置
  • Cookie 解析与设置
  • Accept-* 相关头部解析
  • Content-Type 头部解析与设置
  • 缓存相关头部判断与设置
  • HTTP 头部获取与设置
  • HTTP 响应内容设置

而上面的所有事情都是围绕 hello world 示例当中req和res两个对象。另外，Koa 当中的中间件（Middleware）也并不神奇，就是函数的层层调用，只不过每个函数都可以选择是否调用下一层函数，具体实现细节下面再讲。

Koa 当中用到的一些 JavaScript 语法

如果对下面几个语法不太熟悉，可以查看链接相关内容。

核心模块

request

request 模块主要是对 HTTP 请求信息获取与设置方法封装：

  • HTTP 请求行：请求方法、请求协议、请求路径、请求 URL、请求查询参数
  • HTTP 请求头部
  • 主机名
  • IP
  • 缓存新鲜度判断
  • Accept/Accept-Encoding/Accept-Language头部解析
  • Content-Type头部解析

response

response 模块主要是对 HTTP 响应信息获取与设置方法封装：

  • HTTP 状态码及状态信息
  • HTTP 响应头部
  • HTTP 响应内容
  • Content-Length计算
  • 重定向方法
  • Content-Type设置
  • Content-Disposition设置
  • Vary设置

context

Koa 的 middleware 是一个函数，其第一个参数为 context 对象，context 模块定义了一个 context 原型对象，其上面挂载 request 与 response 对象，另外通过 delegates 模块将 request 与 response 对象上面的方法代理到了 context 对象上面，便于使用。

除了代理 request 与 response 对象方法，也提供了一些错误处理、异常响应、Cookie 处理等方法。

application

application 模块用于创建 koa 应用，const Koa = require('koa')当中的Koa即为application模块。

中间件 middleware

中间件通过 koa-compose 模块实现。Koa middleware 就是一个异步函数，或者说其返回值为 Promise 对象的函数，如下形式：

async function middleware(ctx, next) {
  if (condition1) {
    await next()
  }
}

其中ctx为context对象，next为下一个中间件函数。

HTTP 请求（context 对象）的流向如下图所示，每一个中间件当中都可以选择是否将执行控制交给下一个中间件，直到最后一个中间执行完毕之后会执行 controller（异步函数）。

receive request
    |
middleware1
    |
    |--------|
    |   middleware2
    |        |
    |        |---------|
    |        |         |
    |        |    middleware3
    |        |         |
    |        |---------|
    |--------|
    |
controller
    |
send response

依赖模块

Koa 项目本身代码没有多少，依赖了不少三方模块，比如

  • accepts：主要对 HTTP 头部Accept/Accept-Encoding/Accept-Language/Content-Type解析处理。
  • content-disposition：对Content-Disposition头部解析处理。
  • content-type：对Content-Type头部解析处理。
  • cookies：对Cookie和Set-Cookie头部解析与处理。
  • fresh：响应新鲜度判断。
  • parseurl：解析 URL，并具有 memoization 功能。
  • statues：HTTP 状态码与状态信息处理。
  • vary：Vary头部处理。

总结

个人认为 Koa 两个核心的亮点是：

  • 异步函数形式中间件
  • 挂载在 context 对象上面的统一的 getter 与 setter

当然了，要想开发实际的 Web 应用，Koa 本身还欠缺很多，需要使用中间件来弥补，另外 Koa 及 Koa 中间件的维护状态近一两年不太活跃，中间件也没有 express 丰富。

源码KoaHTTP