koa-docs-Zh-CN
koa-docs-Zh-CN copied to clipboard
demopark
Koa 文档的中文版本 , 更新至 v2.13.4 版本.
Koa 通过 node.js 实现了一个十分具有表现力的 HTTP 中间件框架，力求让 Web 应用开发和 API 使用更加地愉快。Koa 的中间件之间按照编码顺序在栈内依次执行，允许您执行操作并向下传递请求（downstream），之后过滤并逆序返回响应（upstream）。
几乎所有 HTTP 服务器通用的方法都被直接集成到 Koa 大约570行源码的代码库中。其中包括内容协商，节点不一致性的规范化，重定向等等操作。
Koa没有捆绑任何中间件。
安装
Koa 依赖 node v7.6.0 或 ES2015及更高版本和 async 方法支持.
$ npm install koa
Hello koa
const Koa = require('koa');
const app = new Koa();
// 响应
app.use(ctx => {
ctx.body = 'Hello Koa';
});
app.listen(3000);
入门
- Kick-Off-Koa - 通过一系列自身指引的讲解介绍了 Koa。
- Workshop - 通过学习 Koa 的讲解，快速领会精髓。
- Introduction Screencast - 关于 Koa 安装入门的介绍。
中间件
Koa 是一个中间件框架，可以采用两种不同的方法来实现中间件：
- async function
- common function
以下是使用两种不同方法实现一个日志中间件的示例：
async functions (node v7.6+)
app.use(async (ctx, next) => {
const start = Date.now();
await next();
const ms = Date.now() - start;
console.log(`${ctx.method} ${ctx.url} - ${ms}ms`);
});
Common function
// 中间件通常带有两个参数 (ctx, next), ctx 是一个请求的上下文（context）,
// next 是调用执行下游中间件的函数. 在代码执行完成后通过 then 方法返回一个 Promise.
app.use((ctx, next) => {
const start = Date.now();
return next().then(() => {
const ms = Date.now() - start;
console.log(`${ctx.method} ${ctx.url} - ${ms}ms`);
});
});
Koa v1.x 中间件签名
中间件签名在 v1.x 和 v2.x 之间已经被更改. 旧的签名已经被弃用.
旧的签名中间件支持将在 v3 中删除
请参阅 迁移指南 获取有关从 v1.x 升级并使用 v2.x 中间件的更多信息。
上下文, 请求和响应
每个中间件都接收一个 Koa 的 Context 对象，该对象封装了一个传入的 http 消息，并对该消息进行了相应的响应。 ctx 通常用作上下文对象的参数名称。
app.use(async (ctx, next) => { await next(); });
Koa 提供了一个 Request 对象作为 Context 的 request 属性。
Koa的 Request 对象提供了用于处理 http 请求的方法，该请求委托给 node http 模块的IncomingMessage。
这是一个检查请求客户端 xml 支持的示例。
app.use(async (ctx, next) => {
ctx.assert(ctx.request.accepts('xml'), 406);
// 相当于:
// if (!ctx.request.accepts('xml')) ctx.throw(406);
await next();
});
Koa提供了一个 Response 对象作为 Context 的 response 属性。
Koa的 Response 对象提供了用于处理 http 响应的方法，该响应委托给 ServerResponse。
Koa 对 Node 的请求和响应对象进行委托而不是扩展它们。这种模式提供了更清晰的接口，并减少了不同中间件与 Node 本身之间的冲突，并为流处理提供了更好的支持。
IncomingMessage 仍然可以作为 Context 上的 req 属性被直接访问，并且ServerResponse也可以作为Context 上的 res 属性被直接访问。
这里是一个使用 Koa 的 Response 对象将文件作为响应体流式传输的示例。
app.use(async (ctx, next) => {
await next();
ctx.response.type = 'xml';
ctx.response.body = fs.createReadStream('really_large.xml');
});
Context 对象还提供了其 request 和 response 方法的快捷方式。在前面的例子中，可以使用 ctx.type 而不是 ctx.response.type，而 ctx.accepts 可以用来代替 ctx.request.accepts。
关于 Request, Response 和 Context 更多详细信息, 参阅 请求 API 参考,
响应 API 参考 和 上下文 API 参考.
Koa 应用程序
在执行 new Koa() 时创建的对象被称为 Koa 应用对象。
应用对象是带有 node http 服务的 Koa 接口，它可以处理中间件的注册，将http请求分发到中间件，进行默认错误处理，以及对上下文，请求和响应对象进行配置。
了解有关应用程序对象的更多信息请到 应用 API 参考.
文档
-
使用指南
-
错误处理
-
Koa 与 Express
-
常见问题
-
从 Koa v1.x 迁移到 v2.x
-
API 文档
- 上下文(Context)
- 请求(Request)
- 响应(Response)
Babel 配置
如果你正在使用的不是 node v7.6+, 我们推荐你用 @babel/preset-env 配置 babel :
$ npm install @babel/register @babel/preset-env @babel/cli --save-dev
在开发环境中, 你可能想要使用 @babel/register:
node --require @babel/register <your-entry-file>
在生产环境中, 你可能想要使用 @babel/cli 构建文件. 假设你正在编译 src 文件夹且想要输出 non-javascript 文件拷贝到新的 dist 文件夹中:
babel src --out-dir dist --copy-files
还有你的 .babelrc 配置:
{
"presets": [
["@babel/preset-env", {
"targets": {
"node": true
}
}]
]
}
故障排除
在 Koa 指南中查阅 故障排除指南 或 调试 Koa.
运行测试
$ npm test
赞赏支持
demopark