介绍

Koa 是由 Express 背后的团队设计的一个新的 Web 框架，旨在成为 Web 应用和 API 的更小、更具表现力和更强大的基础。通过利用异步函数，Koa 允许你放弃回调并大大提高错误处理能力。 Koa 的核心中没有捆绑任何中间件，它提供了一套优雅的方法，使编写服务器变得快速而愉快。

安装

Koa 需要 Node v12 或更高版本才能支持 ES2015 和异步函数。

你可以使用你最喜欢的版本管理器快速安装受支持的 Node 版本：

$ nvm install 12
$ npm i koa
$ node my-koa-app.js

应用

Koa 应用是一个包含中间件函数数组的对象，这些中间件函数根据请求以类似堆栈的方式组合和执行。 Koa 与你可能遇到的许多其他中间件系统类似，例如 Ruby 的 Rack、Connect 等 - 然而，一个关键的设计决策是在底层中间件层提供高级 "糖"。这提高了互操作性、健壮性，并使编写中间件变得更加愉快。

这包括用于常见任务的方法，例如内容协商、缓存新鲜度、代理支持和重定向等。尽管提供了相当多的有用方法，Koa 仍然占用很小的空间，因为没有打包任何中间件。

惯常的 hello world 应用：

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

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

app.listen(3000);

级联

Koa 中间件以更传统的方式级联，就像你可能习惯使用类似的工具一样 - 以前很难通过 Node 使用回调来使用户友好。然而，通过异步函数，我们可以实现 "真正的" 中间件。对比 Connect 的实现，它只是通过一系列函数传递控制直到一个返回，Koa 调用 "下游"，然后控制流回 "上游"。

以下示例使用 "Hello World" 进行响应，但请求首先流经 x-response-time 和 logging 中间件以标记请求何时开始，然后通过响应中间件交出控制权。当中间件调用 next() 时，该函数会挂起并将控制权传递给定义的下一个中间件。当下游不再有中间件执行时，堆栈将展开，每个中间件将恢复执行其上游行为。

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

// logger

app.use(async (ctx, next) => {
  await next();
  const rt = ctx.response.get('X-Response-Time');
  console.log(`${ctx.method} ${ctx.url} - ${rt}`);
});

// x-response-time

app.use(async (ctx, next) => {
  const start = Date.now();
  await next();
  const ms = Date.now() - start;
  ctx.set('X-Response-Time', `${ms}ms`);
});

// response

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

app.listen(3000);

设置

应用设置是 app 实例上的属性，目前支持以下内容：

app.env 默认为 NODE_ENV 或 "development"
app.keys 签名 cookie 密钥数组
app.proxy 当为 true 时信任代理标头字段
app.subdomainOffset 要忽略的 .subdomains 的偏移量，默认为 2
app.proxyIpHeader 代理 ip 标头，默认为 X-Forwarded-For
app.maxIpsCount 从代理 ip 标头读取的最大 ip 数，默认为 0（表示无穷大）

你可以将设置传递给构造函数：
```
const Koa = require('koa');
const app = new Koa({ proxy: true });
```
或动态地：
```
const Koa = require('koa');
const app = new Koa();
app.proxy = true;
```

app.listen(...)

Koa 应用不是 HTTP 服务器的一对一表示。一个或多个 Koa 应用可以挂载在一起，以使用单个 HTTP 服务器形成更大的应用。

创建并返回一个 HTTP 服务器，将给定参数传递给 Server#listen()。这些参数记录在 nodejs.org 上。以下是绑定到 3000 端口的无用 Koa 应用：

const Koa = require('koa');
const app = new Koa();
app.listen(3000);

app.listen(...) 方法只是以下内容的语法糖：

const http = require('http');
const Koa = require('koa');
const app = new Koa();
http.createServer(app.callback()).listen(3000);

这意味着你可以将同一个应用启动为 HTTP 和 HTTPS，或者在多个地址上启动：

const http = require('http');
const https = require('https');
const Koa = require('koa');
const app = new Koa();
http.createServer(app.callback()).listen(3000);
https.createServer(app.callback()).listen(3001);

app.callback()

返回适合 http.createServer() 方法处理请求的回调函数。你还可以使用此回调函数将你的 Koa 应用挂载到 Connect/Express 应用中。

app.use(function)

将给定的中间件函数添加到该应用。 app.use() 返回 this，因此是可链式的。

app.use(someMiddleware)
app.use(someOtherMiddleware)
app.listen(3000)

是相同的

app.use(someMiddleware)
  .use(someOtherMiddleware)
  .listen(3000)

请参阅中间件了解更多信息。

app.keys=

设置签名的 cookie 密钥。

这些将传递给 KeyGrip，但是你也可以传递你自己的 KeyGrip 实例。例如，以下内容是可以接受的：

app.keys = ['OEK5zjaAMPc3L6iK7PyUjCOziUH3rsrMKB9u8H07La1SkfwtuBoDnHaaPCkG5Brg', 'MNKeIebviQnCPo38ufHcSfw3FFv8EtnAe1xE02xkN1wkCV1B2z126U44yk2BQVK7'];
app.keys = new KeyGrip(['OEK5zjaAMPc3L6iK7PyUjCOziUH3rsrMKB9u8H07La1SkfwtuBoDnHaaPCkG5Brg', 'MNKeIebviQnCPo38ufHcSfw3FFv8EtnAe1xE02xkN1wkCV1B2z126U44yk2BQVK7'], 'sha256');

出于安全考虑，请确保密钥足够长且随机。

这些密钥可以轮换，并在使用 { signed: true } 选项签署 cookie 时使用：

ctx.cookies.set('name', 'tobi', { signed: true });

app.context

app.context 是创建 ctx 的原型。你可以通过编辑 app.context 向 ctx 添加其他属性。这对于向 ctx 添加要在整个应用中使用的属性或方法很有用，这可能会提高性能（无中间件）和/或更容易（更少 require()），但代价是更多地依赖 ctx，这可以被视为反模式。

例如，要从 ctx 添加对数据库的引用：

app.context.db = db();

app.use(async ctx => {
  console.log(ctx.db);
});

注意：

ctx 上的许多属性都是使用 getter、setter 和 Object.defineProperty() 定义的。你只能通过在 app.context 上使用 Object.defineProperty() 来编辑这些属性（不推荐）。参见 https://github.com/koajs/koa/issues/652。
已挂载的应用当前使用其父级的 ctx 和设置。因此，挂载的应用实际上只是中间件组。

错误处理

默认情况下，除非 app.silent 是 true，否则将所有错误输出到 stderr。当 err.status 是 404 或 err.expose 是 true 时，默认错误处理程序也不会输出错误。要执行自定义错误处理逻辑（例如集中式日志记录），你可以添加 "error" 事件监听器：

app.on('error', err => {
  log.error('server error', err)
});

如果 req/res 循环出现错误，无法响应客户端，也会传递 Context 实例：

app.on('error', (err, ctx) => {
  log.error('server error', err, ctx)
});

当发生错误并且仍然可以响应客户端时，即没有数据写入套接字时，Koa 将使用 500 "内部服务器错误" 进行适当响应。在任何一种情况下，都会触发应用级别 "error" 以用于记录目的。

上下文

Koa Context 将 Node 的 request 和 response 对象封装到一个对象中，该对象为编写 Web 应用和 API 提供了许多有用的方法。这些操作在 HTTP 服务器开发中使用得非常频繁，因此它们是在此级别添加的，而不是更高级别的框架，这将迫使中间件重新实现此通用功能。

每个请求都会创建一个 Context，并在中间件中作为接收者或 ctx 标识符进行引用，如以下代码片段所示：

app.use(async ctx => {
  ctx; // is the Context
  ctx.request; // is a Koa Request
  ctx.response; // is a Koa Response
});

为了方便起见，许多上下文的访问器和方法只是委托给它们的 ctx.request 或 ctx.response 等效项，并且在其他方面是相同的。例如，ctx.type 和 ctx.length 委托给 response 对象，ctx.path 和 ctx.method 委托给 request。

API

Context 特定方法和访问器。

ctx.req

节点的 request 对象。

ctx.res

节点的 response 对象。

不支持绕过 Koa 的响应处理。避免使用以下节点属性：

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

ctx.request

一个 Koa Request 对象。

ctx.response

一个 Koa Response 对象。

ctx.state

推荐的命名空间，用于通过中间件传递信息并将信息传递到前端视图。

ctx.state.user = await User.find(id);

ctx.app

应用实例参考。

ctx.app.emit

Koa 应用扩展了内部 EventEmitter。 ctx.app.emit 触发一个事件，其类型由第一个参数定义。对于每个事件，你可以连接 "listeners"，这是在事件触发时调用的函数。请参阅错误处理文档了解更多信息。

ctx.cookies.get(name, [options])

获取 cookie name 和 options：

signed 请求的 cookie 应该被签名

Koa 使用 cookies 模块，其中选项被简单地传递。

ctx.cookies.set(name, value, [options])

将 cookie name 设置为 value 和 options：

maxAge：一个数字，表示从 Date.now() 到到期的毫秒数。
expires：一个 Date 对象，指示 cookie 的到期日期（默认在会话结束时到期）。
path：指示 cookie 路径的字符串（默认为 /）。
domain：指示 cookie 域的字符串（无默认值）。
secure：一个布尔值，指示 cookie 是否仅通过 HTTPS 发送（HTTP 默认为 false，HTTPS 默认为 true）。阅读有关此选项的更多信息。
httpOnly：一个布尔值，指示 cookie 是否仅通过 HTTP(S) 发送，而不可供客户端 JavaScript 使用（默认为 true）。
sameSite：一个布尔值或字符串，指示 cookie 是否为 "同一站点" cookie（默认为 false）。可以将其设置为 'strict'、'lax'、'none' 或 true（映射到 'strict'）。
signed：一个布尔值，指示 cookie 是否要签名（默认为 false）。如果这是 true，则还将发送附加有 .sig 后缀的另一个同名 cookie，其中包含 27 字节 url 安全的 base64 SHA1 值，表示 cookie-name=_cookie-value 与第一个要点密钥的哈希值。该签名密钥用于在下次接收到 cookie 时检测篡改情况。
overwrite：一个布尔值，指示是否覆盖先前设置的同名 cookie（默认为 false）。如果这是 true，则在设置此 cookie 时，在同一请求期间设置的具有相同名称（无论路径或域）的所有 cookie 都会从 Set-Cookie 标头中过滤掉。

Koa 使用 cookies 模块，其中选项被简单地传递。

ctx.throw([status], [msg], [properties])

Helper 方法抛出一个错误，.status 属性默认为 500，这将允许 Koa 做出适当的响应。允许以下组合：

ctx.throw(400);
ctx.throw(400, 'name required');
ctx.throw(400, 'name required', { user: user });

例如 ctx.throw(400, 'name required') 相当于：

const err = new Error('name required');
err.status = 400;
err.expose = true;
throw err;

请注意，这些是用户级错误，并用 err.expose 标记，这意味着这些消息适合客户端响应，但错误消息通常不是这种情况，因为你不想泄漏故障详细信息。

你可以选择传递一个按原样合并到错误中的 properties 对象，这对于装饰向上游请求者报告的机器友好错误很有用。

ctx.throw(401, 'access_denied', { user: user });

Koa 使用 http-errors 来创建错误。 status 只能作为第一个参数传递。

ctx.assert(value, [status], [msg], [properties])

Helper 方法在 !value 时抛出类似于 .throw() 的错误。类似于 Node 的 assert() 方法。

ctx.assert(ctx.state.user, 401, 'User not found. Please login!');

Koa 使用 http-assert 进行断言。

ctx.respond

要绕过 Koa 的内置响应处理，你可以显式设置 ctx.respond = false;。如果你想写入原始 res 对象而不是让 Koa 为你处理响应，请使用此选项。

请注意，Koa 不支持使用此功能。这可能会破坏 Koa 中间件和 Koa 本身的预期功能。使用此属性被认为是一种 hack，并且只是为那些希望在 Koa 中使用传统 fn(req, res) 功能和中间件的人提供便利。

请求别名

以下访问器和别名请求等效项：

ctx.header
ctx.headers
ctx.method
ctx.method=
ctx.url
ctx.url=
ctx.originalUrl
ctx.origin
ctx.href
ctx.path
ctx.path=
ctx.query
ctx.query=
ctx.querystring
ctx.querystring=
ctx.host
ctx.hostname
ctx.fresh
ctx.stale
ctx.socket
ctx.protocol
ctx.secure
ctx.ip
ctx.ips
ctx.subdomains
ctx.is()
ctx.accepts()
ctx.acceptsEncodings()
ctx.acceptsCharsets()
ctx.acceptsLanguages()
ctx.get()

响应别名

以下访问器和别名响应等效项：

ctx.body
ctx.body=
ctx.status
ctx.status=
ctx.message
ctx.message=
ctx.length=
ctx.length
ctx.type=
ctx.type
ctx.headerSent
ctx.redirect()
ctx.attachment()
ctx.set()
ctx.append()
ctx.remove()
ctx.lastModified=
ctx.etag=

请求

Koa Request 对象是 Node 的普通请求对象之上的抽象，提供对日常 HTTP 服务器开发有用的附加功能。

API

request.header

请求标头对象。这与节点的 http.IncomingMessage 上的 headers 字段相同。

request.header=

设置请求头对象。

request.headers

请求标头对象。别名为 request.header。

request.headers=

设置请求头对象。别名为 request.header=。

request.method

请求方法。

request.method=

设置请求方法，对于实现 methodOverride() 等中间件很有用。

request.length

将请求内容长度返回为数字（如果存在）或 undefined。

request.url

获取请求 URL。

request.url=

设置请求 URL，对于 url 重写很有用。

request.originalUrl

获取请求原始 URL。

request.origin

获取 URL 的来源，包括 protocol 和 host。

ctx.request.origin
// => http://example.com

request.href

获取完整的请求 URL，包括 protocol、host 和 url。

ctx.request.href;
// => http://example.com/foo/bar?q=1

request.path

获取请求路径名。

request.path=

设置请求路径名并保留查询字符串（如果存在）。

request.querystring

获取不含 ? 的原始查询字符串。

request.querystring=

设置原始查询字符串。

request.search

使用 ? 获取原始查询字符串。

request.search=

设置原始查询字符串。

request.host

获取主机（主机名：端口）（如果存在）。当 app.proxy 为真时支持 X-Forwarded-Host，否则使用 Host。

request.hostname

获取主机名（如果存在）。当 app.proxy 为真时支持 X-Forwarded-Host，否则使用 Host。

如果 host 是 IPv6，Koa 将解析委托给 WHATWG URL API，注意这可能会影响性能。

request.URL

获取 WHATWG 解析的 URL 对象。

request.type

获取请求 Content-Type 不含 "charset" 等参数。

const ct = ctx.request.type;
// => "image/png"

request.charset

获取请求字符集（如果存在）或 undefined：

ctx.request.charset;
// => "utf-8"

request.query

获取解析的查询字符串，当不存在查询字符串时返回空对象。请注意，此 getter 不支持嵌套解析。

例如 "color=blue&size=small"：

{
  color: 'blue',
  size: 'small'
}

request.query=

将查询字符串设置为给定对象。请注意，此设置器不支持嵌套对象。

ctx.query = { next: '/login' };

request.fresh

检查请求缓存是否为 "fresh"，即内容未更改。该方法用于 If-None-Match/ETag、If-Modified-Since、Last-Modified 之间的缓存协商。应在设置其中一个或多个响应标头后引用它。

// freshness check requires status 20x or 304
ctx.status = 200;
ctx.set('ETag', '123');

// cache is ok
if (ctx.fresh) {
  ctx.status = 304;
  return;
}

// cache is stale
// fetch new data
ctx.body = await db.find('something');

request.stale

request.fresh 的倒数。

request.protocol

返回请求协议，"https" 或 "http"。当 app.proxy 为真时支持 X-Forwarded-Proto。

request.secure

ctx.protocol == "https" 的简写，用于检查请求是否通过 TLS 发送。

request.ip

请求远程地址。当 app.proxy 为真时支持 X-Forwarded-For。

request.ips

当 X-Forwarded-For 存在并且 app.proxy 启用时，将返回这些 ip 的数组，按从上游 -> 下游的顺序排列。禁用时返回空数组。

例如，如果值为 "客户端、代理 1、代理 2"，你将收到数组 ["client", "proxy1", "proxy2"]。

大多数反向代理（nginx）通过 proxy_add_x_forwarded_for 设置 x-forwarded-for，存在一定的安全风险。恶意攻击者可以通过伪造 X-Forwarded-Forrequest 标头来伪造客户端的 IP 地址。客户端发送的请求有一个 X-Forwarded-For 的请求头为 'forged'。经过反向代理转发后，request.ips 将被['伪造', 'client', 'proxy1', 'proxy2']。

Koa 提供了两种避免被绕过的选项。

如果可以控制反向代理，可以通过调整配置来避免绕过，或者使用 koa 提供的 app.proxyIpHeader 来避免读取 x-forwarded-for 来获取 ips。

  const app = new Koa({
    proxy: true,
    proxyIpHeader: 'X-Real-IP',
  });

如果你确切知道服务器前面有多少个反向代理，你可以通过配置 app.maxIpsCount 来避免读取用户伪造的请求头：

  const app = new Koa({
    proxy: true,
    maxIpsCount: 1, // only one proxy in front of the server
  });

  // request.header['X-Forwarded-For'] === [ '127.0.0.1', '127.0.0.2' ];
  // ctx.ips === [ '127.0.0.2' ];

request.subdomains

以数组形式返回子域。

子域是应用主域之前主机的以点分隔的部分。默认情况下，应用的域被假定为主机的最后两个部分。这可以通过设置 app.subdomainOffset 来更改。

例如，如果域是 "tobi.ferrets.example.com"：如果未设置 app.subdomainOffset，则 ctx.subdomains 为 ["ferrets", "tobi"]。如果 app.subdomainOffset 为 3，则 ctx.subdomains 为 ["tobi"]。

request.is(types...)

检查传入请求是否包含 "Content-Type" 标头字段，以及是否包含任何给定的 mime type。如果没有请求体，则返回 null。如果没有内容类型，或者匹配失败，则返回 false。否则，它返回匹配的内容类型。

// With Content-Type: text/html; charset=utf-8
ctx.is('html'); // => 'html'
ctx.is('text/html'); // => 'text/html'
ctx.is('text/*', 'text/html'); // => 'text/html'

// When Content-Type is application/json
ctx.is('json', 'urlencoded'); // => 'json'
ctx.is('application/json'); // => 'application/json'
ctx.is('html', 'application/*'); // => 'application/json'

ctx.is('html'); // => false

例如，如果你想确保仅将图片发送到给定路由：

if (ctx.is('image/*')) {
  // process
} else {
  ctx.throw(415, 'images only!');
}

内容协商

Koa 的 request 对象包括由 accepts 和 negotiator 提供支持的有用的内容协商实用程序。这些实用程序是：

request.accepts(types)
request.acceptsEncodings(types)
request.acceptsCharsets(charsets)
request.acceptsLanguages(langs)

如果未提供类型，则返回所有可接受的类型。

如果提供多种类型，将返回最佳匹配。如果未找到匹配项，则返回 false，并且你应该向客户端发送 406 "Not Acceptable" 响应。

如果缺少可接受任何类型的接受标头，则将返回第一个类型。因此，你提供的类型的顺序很重要。

request.accepts(types)

检查给定的 type(s) 是否可接受，为 true 时返回最佳匹配，否则返回 false。 type 值可以是一个或多个 mime 类型字符串（例如 "application/json"）、扩展名（例如 "json"）或数组 ["json", "html", "text/plain"]。

// Accept: text/html
ctx.accepts('html');
// => "html"

// Accept: text/*, application/json
ctx.accepts('html');
// => "html"
ctx.accepts('text/html');
// => "text/html"
ctx.accepts('json', 'text');
// => "json"
ctx.accepts('application/json');
// => "application/json"

// Accept: text/*, application/json
ctx.accepts('image/png');
ctx.accepts('png');
// => false

// Accept: text/*;q=.5, application/json
ctx.accepts(['html', 'json']);
ctx.accepts('html', 'json');
// => "json"

// No Accept header
ctx.accepts('html', 'json');
// => "html"
ctx.accepts('json', 'html');
// => "json"

你可以根据需要多次调用 ctx.accepts()，或者使用开关：

switch (ctx.accepts('json', 'html', 'text')) {
  case 'json': break;
  case 'html': break;
  case 'text': break;
  default: ctx.throw(406, 'json, html, or text only');
}

request.acceptsEncodings(encodings)

检查 encodings 是否可接受，为真时返回最佳匹配，否则返回 false。请注意，你应该包含 identity 作为编码之一！

// Accept-Encoding: gzip
ctx.acceptsEncodings('gzip', 'deflate', 'identity');
// => "gzip"

ctx.acceptsEncodings(['gzip', 'deflate', 'identity']);
// => "gzip"

当没有给出参数时，所有接受的编码都作为数组返回：

// Accept-Encoding: gzip, deflate
ctx.acceptsEncodings();
// => ["gzip", "deflate", "identity"]

请注意，如果客户端显式发送 identity;q=0，则 identity 编码（意味着无编码）可能不可接受。尽管这是一种边缘情况，但你仍然应该处理此方法返回 false 的情况。

request.acceptsCharsets(charsets)

检查 charsets 是否可接受，为真时返回最佳匹配，否则返回 false。

// Accept-Charset: utf-8, iso-8859-1;q=0.2, utf-7;q=0.5
ctx.acceptsCharsets('utf-8', 'utf-7');
// => "utf-8"

ctx.acceptsCharsets(['utf-7', 'utf-8']);
// => "utf-8"

当没有给出参数时，所有接受的字符集都作为数组返回：

// Accept-Charset: utf-8, iso-8859-1;q=0.2, utf-7;q=0.5
ctx.acceptsCharsets();
// => ["utf-8", "utf-7", "iso-8859-1"]

request.acceptsLanguages(langs)

检查 langs 是否可接受，为真时返回最佳匹配，否则返回 false。

// Accept-Language: en;q=0.8, es, pt
ctx.acceptsLanguages('es', 'en');
// => "es"

ctx.acceptsLanguages(['en', 'es']);
// => "es"

当没有给出参数时，所有接受的语言都作为数组返回：

// Accept-Language: en;q=0.8, es, pt
ctx.acceptsLanguages();
// => ["es", "pt", "en"]

request.idempotent

检查请求是否幂等。

request.socket

返回请求套接字。

request.get(field)

返回请求头，不区分大小写 field。

响应

Koa Response 对象是 Node 的普通响应对象之上的抽象，提供对日常 HTTP 服务器开发有用的附加功能。

API

response.header

响应头对象。

response.headers

响应头对象。别名为 response.header。

response.socket

响应套接字。指向 request.socket 的 net.Socket 实例。

response.status

获取响应状态。默认情况下，response.status 设置为 404，与 Node 的 res.statusCode 默认设置为 200 不同。

response.status=

通过数字代码设置响应状态：

100 "继续"
101 "切换协议"
102 "处理中"
200 "ok"
201 "已创建"
202 "已接受"
203 "非权威信息"
204 "无内容"
205 "重置内容"
206 "部分内容"
207 "多状态"
208 "已上报"
226 "已使用"
300 "多项选择"
301 "永久移动"
302 "已找到"
303 "查看其他"
304 "未修改"
305 "使用代理服务器"
307 "临时重定向"
308 "永久重定向"
400 "错误的请求"
401 "未授权"
402 "需要付款"
403 "已禁止"
404 "未找到"
405 "方法不允许"
406 "不被接受的"
407 "需要代理身份验证"
408 "请求超时"
409 "冲突"
410 "已失去"
411 "需要长度"
412 "前提条件失败"
413 "有效载荷太大"
414 "uri 太长"
415 "不支持的媒体类型"
416 "范围不满足"
417 "期望失败"
418 "我是茶壶"
422 "不可处理的实体"
423 "已上锁"
424 "失败的依赖"
426 "需要升级"
428 "需要先决条件"
429 "请求太多"
431 "请求头字段太大"
500 "内部服务器错误"
501 "未实现"
502 "错误的网关"
503 "暂停服务"
504 "网关超时"
505 "不支持 http 版本"
506 "变体也协商"
507 "存储空间不足"
508 "检测到循环"
510 "未扩展"
511 "需要网络认证"

注意：不要太担心记住这些字符串，如果你有拼写错误，将会抛出错误，显示此列表以便你可以进行更正。

由于 response.status 默认设置为 404，因此要发送不带正文且具有不同状态的响应，请按如下方式完成：

ctx.response.status = 200;

// Or whatever other status
ctx.response.status = 204;

response.message

获取响应状态消息。默认情况下，response.message 与 response.status 关联。

response.message=

将响应状态消息设置为给定值。

response.length=

将响应内容长度设置为给定值。

response.length

如果存在，则以数字形式返回响应内容长度，或者在可能的情况下从 ctx.body 或 undefined 中推导出来。

response.body

获取响应正文。

response.body=

将响应正文设置为以下内容之一：

string 已写
Buffer 已写
Stream 管道式
Object || Array json 字符串化
null || undefined 无内容响应

如果没有设置 response.status，Koa 会根据 response.body 自动将状态设置为 200 或 204。具体来说，如果 response.body 没有设置或者已经设置为 null 或 undefined，Koa 会自动将 response.status 设置为 204。如果你确实想发送其他状态的无内容响应，则应按以下方式覆盖 204 状态：

// This must be always set first before status, since null | undefined
// body automatically sets the status to 204
ctx.body = null;
// Now we override the 204 status with the desired one
ctx.status = 200;

Koa 并不防范所有可以作为响应主体的内容 - 函数没有有意义的序列化，根据你的应用返回一个布尔值可能有意义，并且虽然错误有效，但它可能不会像某些人预期的那样工作错误的属性是不可枚举的。我们建议在你的应用中添加中间件来断言每个应用的正文类型。示例中间件可能是：

app.use(async (ctx, next) => {
  await next()

  ctx.assert.equal('object', typeof ctx.body, 500, 'some dev did something wrong')
})

字符串

Content-Type 默认为 text/html 或 text/plain，两者的默认字符集均为 utf-8。还设置了内容长度字段。

缓冲

Content-Type 默认为 application/octet-stream，并且还设置了 Content-Length。

流

Content-Type 默认为 application/octet-stream。

每当将流设置为响应正文时，.onerror 就会自动添加为 error 事件的监听器以捕获任何错误。此外，每当请求关闭（甚至过早）时，流都会被销毁。如果你不需要这两个功能，请不要直接将流设置为正文。例如，当将主体设置为代理中的 HTTP 流时，你可能不希望这样做，因为这会破坏底层连接。

看： https://github.com/koajs/koa/pull/612 了解更多信息。

下面是一个在不自动销毁流的情况下进行流错误处理的示例：

const PassThrough = require('stream').PassThrough;

app.use(async ctx => {
  ctx.body = someHTTPStream.on('error', (err) => ctx.onerror(err)).pipe(PassThrough());
});

对象

Content-Type 默认为 application/json。这包括普通对象 { foo: 'bar' } 和数组 ['foo', 'bar']。

response.get(field)

获取响应头字段值，不区分大小写 field。

const etag = ctx.response.get('ETag');

response.has(field)

如果当前在传出标头中设置了由名称标识的标头，则返回 true。标头名称匹配不区分大小写。

const rateLimited = ctx.response.has('X-RateLimit-Limit');

response.set(field, value)

将响应标头 field 设置为 value：

ctx.set('Cache-Control', 'no-cache');

response.append(field, value)

附加带有值 val 的附加标头 field。

ctx.append('Link', '<http://127.0.0.1/>');

response.set(fields)

用一个对象设置几个响应头 fields：

ctx.set({
  'Etag': '1234',
  'Last-Modified': date
});

这委托给 setHeader，它通过指定的键设置或更新标头，并且不会重置整个标头。

response.remove(field)

删除标头 field。

response.type

获取响应 Content-Type，不含 "charset" 等参数。

const ct = ctx.type;
// => "image/png"

response.type=

通过 mime 字符串或文件扩展名设置响应 Content-Type。

ctx.type = 'text/plain; charset=utf-8';
ctx.type = 'image/png';
ctx.type = '.png';
ctx.type = 'png';

注意：如果合适，会为你选择 charset，例如 response.type = 'html' 将默认为 "utf-8"。如果需要覆盖 charset，可以使用 ctx.set('Content-Type', 'text/html') 直接将响应头字段设置为值。

response.is(types...)

与 ctx.request.is() 非常相似。检查响应类型是否是提供的类型之一。这对于创建操纵响应的中间件特别有用。

例如，这是一个缩小除流之外的所有 HTML 响应的中间件。

const minify = require('html-minifier');

app.use(async (ctx, next) => {
  await next();

  if (!ctx.response.is('html')) return;

  let body = ctx.body;
  if (!body || body.pipe) return;

  if (Buffer.isBuffer(body)) body = body.toString();
  ctx.body = minify(body);
});

response.redirect(url, [alt])

执行 [302] 重定向到 url。

字符串 "back" 是特殊大小写的，用于在引用者不存在时提供引用者支持，而使用 alt 或 "/"。

ctx.redirect('back');
ctx.redirect('back', '/index.html');
ctx.redirect('/login');
ctx.redirect('http://google.com');

要更改 302 的默认状态，只需在调用之前或之后指定状态即可。要更改主体，请在此调用后分配它：

ctx.status = 301;
ctx.redirect('/cart');
ctx.body = 'Redirecting to shopping cart';

response.attachment([filename], [options])

将 Content-Disposition 设置为 "attachment" 以指示客户端提示下载。可以选择指定下载的 filename 和一些 options。

response.headerSent

检查响应标头是否已发送。对于查看是否可以通知客户端错误很有用。

response.lastModified

将 Last-Modified 标头作为 Date 返回（如果存在）。

response.lastModified=

将 Last-Modified 标头设置为适当的 UTC 字符串。你可以将其设置为 Date 或日期字符串。

ctx.response.lastModified = new Date();

response.etag=

设置包含封装的 " 的响应的 ETag。请注意，没有相应的 response.etag getter。

ctx.response.etag = crypto.createHash('md5').update(ctx.body).digest('hex');

response.vary(field)

随 field 变化。

response.flushHeaders()

刷新所有设置的标头，然后开始正文。

链接

用于发现 Koa 第三方中间件、完整可运行示例、详尽指南等的社区链接！如果你有疑问，请加入我们的 IRC！