基础

GodX...大约 10 分钟

介绍

Koa 是一个新的 web 框架，由 Express 幕后的原班人马打造，致力于成为 web 应用和 API 开发领域中的一个更小、更富有表现力、更健壮的基石。
- 官网：https://koajs.com/
- GitHub 仓库：https://github.com/koajs/koa
- 一个翻译的中文网：Koa 中文网 (nodejs.cn)
Koa 的原理和内部结构很像 Express，但是语法和内部结构进行了升级
Koa 内部使用 ES6 编写，号称是下一代 Node.js Web 框架
它的主要特点是通过利用 async 函数，帮你丢弃回调函数
- Koa 1 是基于 ES2015 中的 Generator 生成器函数结合 CO 模块
- Koa 2 完全抛弃了 Generator 和 co，升级为了 ES2017 中的 async/await 函数
正是由于 Koa 内部基于最新的异步处理方式，所以使用 Koa 处理异常更加简单
Koa 中提供了 CTX 上下文对象
- Express 是扩展了 req 和 res
Koa 并没有捆绑任何中间件，而是提供了一套优雅的方法，帮助您快速而愉快地编写服务端应用程序。
有很多开发工具/框架都是基于 Koa 的
- Egg.js
- 构建工具 Vite
Koa vs Express
个人评价
- koa 2 好用，设计上的确有优势。优势不在能实现更强的功能，而是可以更简单地完成功能。
- koa 2 社区远不如 express
- koa 1 在思想上与 koa 2 是一致的，但是 koa 2 的实现更漂亮
Koa 相关资源推荐
- Awesome Koa

Koa 基本用法

1、安装 koa

npm i koa

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

2、app.js

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

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

app.listen(3000);

Koa 应用程序是一个包含一组中间件函数的对象
它是按照类似堆栈的方式组织和执行的
Koa 内部没有捆绑任何中间件，甚至是路由功能

Koa 中的 Context 对象

参见：https://koa.bootcss.com/#context。

Koa 中的路由

原生路由

网站一般都有多个页面。通过ctx.request.path可以获取用户请求的路径，由此实现简单的路由。

const main = ctx => {
  if (ctx.request.path !== '/') {
    ctx.response.type = 'html';
    ctx.response.body = '<a href="/">Index Page</a>';
  } else {
    ctx.response.body = 'Hello World';
  }
};

koa-router 模块

原生路由用起来不太方便，我们可以使用封装好的 koa-router 模块。

Express 路由风格（app.get、app.put、app.post ...）
命名动态 URL 参数
具有 URL 生成的命名路由
使用允许的请求方法响应 OPTIONS 请求
支持 405 和 501 响应处理
支持多路由中间件
支持多个嵌套的路由中间件
支持 async/awai 语法

1、安装

npm i @koa/router

2、示例

const Koa = require('koa');
const Router = require('@koa/router');

const app = new Koa();
const router = new Router();

router.get('/', (ctx, next) => {
  // ctx.router available
});

app
  .use(router.routes())
  .use(router.allowedMethods());

静态资源托管

如果网站提供静态资源（图片、字体、样式表、脚本......），为它们一个个写路由就很麻烦，也没必要。koa-static 模块封装了这部分的请求。

1、安装

npm install koa-static

2、示例

const serve = require('koa-static');
const Koa = require('koa');
const app = new Koa();

// $ GET /package.json
app.use(serve('.'));

// $ GET /hello.txt
app.use(serve('test/fixtures'));

// or use absolute paths
app.use(serve(__dirname + '/test/fixtures'));

app.listen(3000);

console.log('listening on port 3000');

给静态资源设置虚拟路径

使用 Koa 提供的 koa-mount 。

重定向

有些场合，服务器需要重定向（redirect）访问请求。比如，用户登陆以后，将他重定向到登陆前的页面。ctx.response.redirect()方法可以发出一个302跳转，将用户导向另一个路由。

ctx.response.redirect('/');
ctx.response.body = '<a href="/">Index Page</a>';

Koa 中间件

Logger 功能

Koa 的最大特色，也是最重要的一个设计，就是中间件（middleware）。为了理解中间件，我们先看一下 Logger （打印日志）功能的实现。

const main = ctx => {
  console.log(`${Date.now()} ${ctx.request.method} ${ctx.request.url}`);
  ctx.response.body = 'Hello World';
};

中间件栈

多个中间件会形成一个栈结构（middle stack），以"先进后出"（first-in-last-out）的顺序执行。
最外层的中间件首先执行。
调用next函数，把执行权交给下一个中间件。
...
最内层的中间件最后执行。
执行结束后，把执行权交回上一层的中间件。
...
最外层的中间件收回执行权之后，执行next函数后面的代码。

中间件栈结构示例如下：

const one = (ctx, next) => {
  console.log('>> one');
  next();
  console.log('<< one');
}

const two = (ctx, next) => {
  console.log('>> two');
  next(); 
  console.log('<< two');
}

const three = (ctx, next) => {
  console.log('>> three');
  next();
  console.log('<< three');
}

app.use(one);
app.use(two);
app.use(three);

如果中间件内部没有调用 next 函数，那么执行权就不会传递下去。作为练习，你可以将 two 函数里面 next() 这一行注释掉再执行，看看会有什么结果。

Koa 的洋葱圈模型是什么？

Koa 的洋葱圈模型是一种中间件架构，它允许你以一种特定的方式组织和执行代码。在这个模型中，每个中间件都可以执行两个动作：一个在处理请求（Request）时，另一个在发送响应（Response）时。这就像剥洋葱一样，层层深入，然后再层层返回。

当一个请求到达 Koa 应用程序时，它会从最外层的中间件开始执行，然后逐层向内传递，直到达到最内层的中间件。每个中间件在调用 next() 函数之前都有机会对请求进行处理。一旦 next() 被调用，控制权就会传递到下一个中间件，直到没有更多的中间件执行。

在所有的中间件执行完毕后，事件循环会逆转方向，从最内层的中间件开始，逐层向外执行每个中间件的第二部分代码。这允许中间件在响应发送回客户端之前执行后续操作。

这种模型的优点是：

灵活性：你可以根据请求和响应的不同阶段灵活地添加代码。
错误处理：可以在外层中间件中捕获和处理内层中间件抛出的错误。
可维护性：代码的结构清晰，易于理解和维护。

例如，如果你有一个记录请求时间的中间件和一个处理数据库查询的中间件，洋葱圈模型允许你在请求开始时记录时间，在所有数据库查询完成后再次记录时间，从而计算出处理请求所需的总时间。这种模式非常适合处理那些需要在请求处理的前后执行的逻辑。

为什么 Koa 要使用洋葱圈模型?

Koa 使用洋葱圈模型的主要原因是为了提高代码的可读性和可维护性，同时确保中间件的执行顺序和依赖关系得到正确处理。洋葱圈模型允许中间件以一种嵌套的方式执行，这意味着请求（Request）和响应（Response）可以在不同的中间件层次中被捕获和处理。

在 Koa 的洋葱圈模型中，中间件的执行流程如下：

请求开始时，从最外层的中间件开始执行。
每个中间件可以执行一些操作，然后通过调用 next() 函数将控制权传递给下一个中间件。
当控制权传递到最内层的中间件后，它开始逐层返回，每个中间件都有机会在响应发送回客户端之前执行更多的操作。

这种模型的优点包括：

错误处理：可以在外层中间件中捕获内层中间件抛出的错误，从而集中处理错误。
代码组织：中间件的层次结构使得代码更加模块化和组织化，便于管理和维护。
灵活性：开发者可以根据需要在请求和响应阶段添加、修改或删除中间件。
性能优化：可以在请求的早期阶段快速响应，或者在响应的后期阶段进行必要的清理工作。

洋葱圈模型确保了中间件的执行顺序，使得每个中间件都可以在请求进入和退出时执行代码，这对于诸如日志记录、请求处理、响应处理等功能至关重要。这种模式也使得异步操作更加直观，因为它允许开发者以同步的方式编写代码，而底层实现则是异步的。

异步中间件

迄今为止，所有例子的中间件都是同步的，不包含异步操作。如果有异步操作（比如读取数据库），中间件就必须写成 async 函数。

app.use(async (ctx, next) => {
  const data = await util.promisify(fs.readFile)('./views/index.html')
  ctx.type = 'html'
  ctx.body = data
  next()
})

上面代码中，fs.readFile 是一个异步操作，必须写成 await fs.readFile()，然后中间件必须写成 async 函数。

中间件的合成

koa-compose 模块可以将多个中间件合成为一个。

1、安装

npm install koa-compose

2、示例

const compose = require('koa-compose');

const logger = (ctx, next) => {
  console.log(`${Date.now()} ${ctx.request.method} ${ctx.request.url}`);
  next();
}

const main = ctx => {
  ctx.response.body = 'Hello World';
};

const middlewares = compose([logger, main]);
app.use(middlewares);

Koa 中的错误处理

500 错误

如果代码运行过程中发生错误，我们需要把错误信息返回给用户。HTTP 协定约定这时要返回500状态码。Koa 提供了ctx.throw()方法，用来抛出错误，ctx.throw(500)就是抛出500错误。

const main = ctx => {
  ctx.throw(500);
};

404 错误

如果将ctx.response.status设置成404，就相当于ctx.throw(404)，返回404错误。

const main = ctx => {
  ctx.response.status = 404;
  ctx.response.body = 'Page Not Found';
};

处理错误的中间件

为了方便处理错误，最好使用 try...catch 将其捕获。但是，为每个中间件都写 try...catch 太麻烦，我们可以让最外层的中间件，负责所有中间件的错误处理。

const handler = async (ctx, next) => {
  try {
    await next();
  } catch (err) {
    ctx.response.status = err.statusCode || err.status || 500;
    ctx.response.body = {
      message: err.message
    };
  }
};

const main = ctx => {
  ctx.throw(500);
};

app.use(handler);
app.use(main);

error 事件的监听

运行过程中一旦出错，Koa 会触发一个error事件。监听这个事件，也可以处理错误。

const main = ctx => {
  ctx.throw(500);
};

app.on('error', (err, ctx) =>
  console.error('server error', err);
);

如果 req/res 期间出现错误，并且无法响应客户端，Context实例仍然被传递：

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

当发生错误并且仍然可以响应客户端时，也没有数据被写入 socket 中，Koa 将用一个 500 “内部服务器错误” 进行适当的响应。在任一情况下，为了记录目的，都会发出应用级 “错误”。

释放 error 事件

需要注意的是，如果错误被try...catch捕获，就不会触发error事件。这时，必须调用ctx.app.emit()，手动释放error事件，才能让监听函数生效。

const handler = async (ctx, next) => {
  try {
    await next();
  } catch (err) {
    ctx.response.status = err.statusCode || err.status || 500;
    ctx.response.type = 'html';
    ctx.response.body = '<p>Something wrong, please contact administrator.</p>';
    ctx.app.emit('error', err, ctx);
  }
};

const main = ctx => {
  ctx.throw(500);
};

app.on('error', function(err) {
  console.log('logging error ', err.message);
  console.log(err);
});

上面代码中，main 函数抛出错误，被 handler 函数捕获。catch 代码块里面使用 ctx.app.emit() 手动释放 error 事件，才能让监听函数监听到。

Koa 开发 Web App 功能

Cookies

ctx.cookies 用来读写 Cookie。

const main = function(ctx) {
  const n = Number(ctx.cookies.get('view') || 0) + 1;
  ctx.cookies.set('view', n);
  ctx.response.body = n + ' views';
}

访问 http://127.0.0.1:3000 ，你会看到1 views。刷新一次页面，就变成了2 views。再刷新，每次都会计数增加1。

表单

Web 应用离不开处理表单。本质上，表单就是 POST 方法发送到服务器的键值对。koa-body模块可以用来从 POST 请求的数据体里面提取键值对。

const koaBody = require('koa-body');

const main = async function(ctx) {
  const body = ctx.request.body;
  if (!body.name) ctx.throw(400, '.name required');
  ctx.body = { name: body.name };
};

app.use(koaBody());

文件上传

koa-body 模块还可以用来处理文件上传。

const os = require('os');
const path = require('path');
const koaBody = require('koa-body');

const main = async function(ctx) {
  const tmpdir = os.tmpdir();
  const filePaths = [];
  const files = ctx.request.body.files || {};

  for (let key in files) {
    const file = files[key];
    const filePath = path.join(tmpdir, file.name);
    const reader = fs.createReadStream(file.path);
    const writer = fs.createWriteStream(filePath);
    reader.pipe(writer);
    filePaths.push(filePath);
  }

  ctx.body = filePaths;
};

app.use(koaBody({ multipart: true }));

完整代码

查看

昵称

邮箱

网址

按正序
按倒序
按热度

基础

预览: