Koa 基础使用 #

koa -- 基于 Node.js 平台下一代 web 开发框架

Koa 简介 #

Koa 是一个新的 web 框架, 由 Express 幕后的原班人马打造。

通过利用 async 函数, Koa 丢弃了回调函数, 并有力地增强错误处理。Koa 并没有捆绑任何中间件, 而是提供了一套更优雅的方法编写服务端应用程序。

安装 #

Koa 依赖 node v7.6.0 或 ES2015 及更高版本和 async 方法支持。

npm install koa

核心概念 #

应用 #

Koa 应用程序是一个包含一组中间件函数的对象, 它是按照类似堆栈的方式组织执行的。

const Koa = require('koa')
const app = new Koa()

app.use(async (ctx) => {
  ctx.body = 'Hello World'
})

app.listen(3000)

中间件函数 #

中间件函数能够访问上下文(ctx)以及应用程序请求/响应循环中的下一个中间件函数(next)。

const middleware = async (ctx, next) => {
  // ...
  next()
  //...
}

中间件函数可以执行以下任务：

• 执行任何代码
• 对上下文进行修改
• 结束请求/响应循环
• 调用堆栈中的下一个中间件

如果当前中间件函数没有结束请求/响应循环, 那么它必须调用 next(), 以将控制权传递给下一个中间件函数。否则, 请求将保持挂起状态。

级联 #

上下文 #

Koa Context 将 node 的 request 和 response 对象封装到单个对象中, 为编写 Web 应用程序和 API 提供了许多有用的方法。

app.use(async (ctx) => {
  ctx // context
  ctx.request // koa request
  ctx.response // koa response
  ctx.req // node request
  ctx.res // node response
})

绕过 Koa 的 resopnse 处理是不被支持的。应 避免使用 以下 node 属性：

• ctx.res.statusCode
• ctx.res.writeHead()
• ctx.res.write()
• ctx.res.end()

Request 和 Response 上属性或方法 ctx 大多都可 直接 访问, 如 ctx.body。

但需要注意的是, 有关获取消息头的一般是请求头, 设置消息头的一般是响应头。如

• ctx.headers 指的是 request.headers
• ctx.set() 指的是 response.set()

请求 #

Koa Request 对象是 node 原生请求对象之上的抽象, 提供了诸多对 HTTP 服务器开发有用的功能。

响应 #

Koa Response 对象是 node 原生响应对象之上的抽象, 提供了诸多对 HTTP 服务器开发有用的功能。

路由 #

通过 ctx.request.path 可以获取用户请求的路径, 从而实现简单的路由。但是, 推荐使用 @koa/router 中间件。

错误处理 #

全局错误处理可以通过 app.on('error', cb) 捕获, 如果是客户端错误可以使用 app.throw() 方法。