Koa学习（二）—— Koa概念

最新推荐文章于 2024-07-03 16:58:10 发布

lime2019

最新推荐文章于 2024-07-03 16:58:10 发布

阅读量760

点赞数 3

分类专栏： Node开发学习文章标签： Koa

本文链接：https://blog.csdn.net/weixin_44171004/article/details/114287799

版权

Node开发学习专栏收录该内容

12 篇文章 1 订阅

订阅专栏

本文为我个人对Koa官网语法介绍的学习笔记，部分小节复制粘贴自官网。
安装Koa，官网有很明确的介绍，直接在项目目录下终端中运行npm i koa就行。

Koa概念目录

1. Koa概念
2. 应用程序
3. 上下文
4. 请求（Request）
- 4.1 API
5. 响应（Response）
- 5.1 响应头API
- 5.2 响应状态与响应信息API

1. Koa概念

官网将Koa相关知识分为：

应用（Application）
上下文（Context）
请求（Request）
响应（Responds）

2. 应用程序

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

2.1 Koa洋葱模型（级联）

Koa中间件使用传统的方式级联，使用async/await来实现。下图为Koa的洋葱模型。

Koa工作原理

参考官网所给示例：

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

// logger

app.use(async (ctx, next) => {
  await next(); // 请求到达此处后，跳转到下一个中间件x-response-time
  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(); // 请求流执行到此处，跳转到下一个中间件response
  // response中间件执行完成后，继续执行下面代码。下面代码执行完成后回到上一个中间件回调函数处。
  const ms = Date.now() - start;
  ctx.set('X-Response-Time', `${ms}ms`);
});

// response

app.use(async ctx => {
  ctx.body = 'Hello World'; // 请求流到此处，执行完成，回到上一个中间件回调函数处。
});

app.listen(3000);

2.2 应用程序设置

应用程序设置是 app 实例上的属性。

应用程序设置包括：

app.env
app.keys
app.proxy
app.proxyIpHeader
app.maxIpsCount

应用程序设置有两种方式：

第一种：在初始化app实例时，将设置传递给构造函数；
第二种：初始化app实例完成后，动态的设置app实例上的属性；

2.3 常用的应用程序设置

app.listen()：Koa应用程序不是HTTP服务器的1对1展现，因此可以将同一个程序作为HTTP和HTTPS或多个地址，其是下面代码的语法糖：

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

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
app.keys = ['im a newer secret', 'i like turtle'];
app.keys = new KeyGrip(['im a newer secret', 'i like turtle'], 'sha256');

app.context：即上下文，从app.context创建ctx的原型，可以通过编辑 app.context 为 ctx 添加其他属性。

2.4 错误处理

默认情况下，将所有错误输出到 stderr，除非 app.silent 为 true。当 err.status 是 404 或 err.expose 是 true 时默认错误处理程序也不会输出错误。

要执行自定义错误处理逻辑，如集中式日志记录，您可以添加一个 “error” 事件侦听器：

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

如果在请求/响应期间出现错误，则无法响应客户端，但是Context实例仍然被传递：

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

如果发生错误，但是可以响应客户端，且没有数据被写入socket中，则Koa将用“内部服务器错误”（500）进行响应。

3. 上下文

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

// 每一个请求都将创建一个Context，并且在中间件中作为接收器引用（ctx标识符）
app.use(async ctx => {
  ctx; // 这是 Context
  ctx.request; // 这是 koa Request
  ctx.response; // 这是 koa Response
})