相关 API此系列文章的应用示例已发布于 GitHub: koa-docs-Zh-CN. 可以 Fork 帮助改进或 Star 关注更新. 欢迎 Star.
上下文(Context)
请求(Request)
响应(Response)
安装Koa 依赖 node v7.6.0 或 ES2015及更高版本和 async 方法支持.
你可以使用自己喜欢的版本管理器快速安装支持的 node 版本：
$ nvm install 7 $ npm i koa $ node my-koa-app.js使用 Babel 实现 Async 方法
要在 node < 7.6 版本的 Koa 中使用 async 方法, 我们推荐使用 babel"s require hook.
require("babel-register");
// 应用的其余 require 需要被放到 hook 后面
const app = require("./app");
要解析和编译 async 方法, 你至少应该有 transform-async-to-generator
或 transform-async-to-module-method 插件.
例如, 在你的 .babelrc 文件中, 你应该有:
{
"plugins": ["transform-async-to-generator"]
}
你也可以用 env preset 的 target 参数 "node": "current" 替代.
应用程序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 的回调。然而，使用 async 功能，我们可以实现 “真实” 的中间件。对比 Connect 的实现，通过一系列功能直接传递控制，直到一个返回，Koa 调用“下游”，然后控制流回“上游”。
下面以 “Hello World” 的响应作为示例，首先请求流通过 x-response-time 和 logging 中间件来请求何时开始，然后继续移交控制给 response 中间件。当一个中间件调用 next() 则该函数暂停并将控制传递给定义的下一个中间件。当在下游没有更多的中间件执行后，堆栈将展开并且每个中间件恢复执行其上游行为。
const Koa = require("koa");
const app = new Koa();
// 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`);
});
// logger
app.use(async (ctx, next) => {
const start = Date.now();
await next();
const ms = Date.now() - start;
console.log(`${ctx.method} ${ctx.url} - ${ms}`);
});
// response
app.use(async ctx => {
ctx.body = "Hello World";
});
app.listen(3000);
设置
应用程序设置是 app 实例上的属性，目前支持如下：
app.env 默认是 NODE_ENV 或 "development"
app.proxy 当真正的代理头字段将被信任时
app.subdomainOffset 对于要忽略的 .subdomains 偏移[2]
app.listen(...)Koa 应用程序不是 HTTP 服务器的1对1展现。
可以将一个或多个 Koa 应用程序安装在一起以形成具有单个HTTP服务器的更大应用程序。
创建并返回 HTTP 服务器，将给定的参数传递给 Server#listen()。这些内容都记录在 nodejs.org.
以下是一个无作用的 Koa 应用程序被绑定到 3000 端口：
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)将给定的中间件方法添加到此应用程序。参阅 Middleware 获取更多信息.
app.keys=设置签名的 Cookie 密钥。
这些被传递给 KeyGrip，但是你也可以传递你自己的 KeyGrip 实例。
例如，以下是可以接受的：
app.keys = ["im a newer secret", "i like turtle"]; app.keys = new KeyGrip(["im a newer secret", "i like turtle"], "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/...
安装的应用程序目前使用其父级的 ctx 和设置。 因此，安装的应用程序只是一组中间件。
错误处理默认情况下，将所有错误输出到 stderr，除非 app.silent 为 true。
当 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)
});
当发生错误 并且 仍然可以响应客户端时，也没有数据被写入 socket 中，Koa 将用一个 500 “内部服务器错误” 进行适当的响应。在任一情况下，为了记录目的，都会发出应用级 “错误”。
如果这篇文章对您有帮助, 感谢 下方点赞 或 Star GitHub: koa-docs-Zh-CN 支持, 谢谢.
文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。
转载请注明本文地址：https://www.ucloud.cn/yun/89472.html
摘要：的对象提供了用于处理响应的方法，该响应委托给。应用对象是与的服务器和处理中间件注册的接口，从发送到中间件，默认错误处理，以及上下文，请求和响应对象的配置。 此系列文章的应用示例已发布于 GitHub: koa-docs-Zh-CN. 可以 Fork 帮助改进或 Star 关注更新. 欢迎 Star. showImg(https://segmentfault.com/img/bVNQYf...
摘要：方法抛出一个属性默认为的错误，这将允许做出适当地响应。这用于修饰其人机友好型错误并向上游的请求者报告非常有用。请注意，不支持使用此功能。这可能会破坏中间件和本身的预期功能。 上下文(Context) 此系列文章的应用示例已发布于 GitHub: koa-docs-Zh-CN. 可以 Fork 帮助改进或 Star 关注更新. 欢迎 Star. Koa Context 将 node 的 ...
摘要：当中间件运行时，它必须手动调用来运行下游中间件。例如，这个中间件从读取文件名，然后在将给指定合并结果之前并行读取每个文件的内容。当你无法控制中间件的名称时，这很有用。 指南 此系列文章的应用示例已发布于 GitHub: koa-docs-Zh-CN. 可以 Fork 帮助改进或 Star 关注更新. 欢迎 Star. 本指南涵盖的 Koa 主题不与 API 直接相关，例如编写中间件的最...
摘要：一个迁移方式是逐个更新它们。删除特定的日志记录行为对于环境的显式检查从错误处理中删除。直接或它不再使用并已废弃。支持仍然支持分支，但应该不会得到功能性更新。除了此迁移指南外，文档将针对最新版本。 从 Koa v1.x 迁移到 v2.x 此系列文章的应用示例已发布于 GitHub: koa-docs-Zh-CN. 可以 Fork 帮助改进或 Star 关注更新. 欢迎 Star. 新的中...
摘要：别名为设置请求标头对象。获取请求路径名。设置请求路径名，并在存在时保留查询字符串。请注意，此不支持嵌套对象。检查请求缓存是否新鲜，也就是内容没有改变。通过来检查请求是否通过发出。返回请求套接字。 请求(Request) 此系列文章的应用示例已发布于 GitHub: koa-docs-Zh-CN. 可以 Fork 帮助改进或 Star 关注更新. 欢迎 Star. Koa Request...
阅读 2577·2019-08-30 10:53
阅读 3183·2019-08-29 16:20
阅读 2933·2019-08-29 15:35
阅读 1751·2019-08-29 12:24
阅读 2865·2019-08-28 18:19
阅读 1838·2019-08-23 18:07
阅读 2314·2019-08-23 15:31
阅读 1158·2019-08-23 14:05
