Koa笔记 01：基础入门

目的

Node.js最基本的是用来搭建HTTP服务器使用，它内置的模块基本上可以满足基础的HTTP服务器功能，但是如果要实现比较完整的HTTP服务器功能体验的话开发者还需要编写更多的代码。所以通常使用的话可以选择现成的框架，Koa就是一个现在比较流行的框架。这篇文章将对Koa使用做个入门介绍。

Koa 通过 node.js 实现了一个十分具有表现力的 HTTP 中间件框架，力求让 Web 应用开发和 API 使用更加地愉快。Koa 的中间件之间按照编码顺序在栈内依次执行，允许您执行操作并向下传递请求（downstream），之后过滤并逆序返回响应（upstream）。


几乎所有 HTTP 服务器通用的方法都被直接集成到 Koa 大约570行源码的代码库中。其中包括内容协商，节点不一致性的规范化，重定向等等操作。


Koa没有捆绑任何中间件。

官网地址：https://koajs.com/
项目地址：https://github.com/koajs/koa

基础介绍

Koa 依赖 Node.js v7.6.0 或 ES2015及更高版本和 async 方法支持，在安装了Node.js、建立并初始化项目后就可以使用npm安装Koa：npm install koa ，目前Koa版本为 2.13.4 。

下面是个最基本的Koa使用：

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

// response
app.use(ctx => {
  ctx.body = 'Hello Koa';
});

app.listen(3000);

Koa最重要的一点就是它是一个 HTTP 中间件框架 ，这是Koa最重要的一点，只要理解这点Koa就算入门了。Koa是基于HTTP功能的，首先看下Node.js中http模块的使用：

上面的演示和前面Koa的演示结构上是很像的，无非就是编写相应的HTTP请求处理方法，然后启动监听，我们写代码主要就是关注于中间处理部分。事实上前面的Koa演示的代码也可以写成下面这样：

const http = require('http');
const Koa = require('koa');

const app = new Koa();

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

http.createServer(app.callback()).listen(3000); // 相当于 app.listen(3000);

到这里就可以认识到Koa就是在http模块模块的基础上接管了来自客户端的HTTP请求，接下来所有操作就都是在Koa的基础上进行了。

Koa对象的use方法中可以传入回调函数用来处理来自客户端的HTTP请求，该回调函数可以传入两个参数，依次通常写作 ctx 、 next 。 ctx 可以看成是HTTP请求和响应的整体封装，而 next 为下一步的异步处理。

Koa对于每个HTTP请求都可以分为多步来处理， 也就是多可以有多个 app.use() ，实际处理时按照调用 app.use() 的先后顺序执行，并且在每个 app.use() 的回调函数中又可以以异步方式调用下一步处理。下面是个简单的演示：

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

app.use(async (ctx, next) => {
    console.log('1');
    await next();
    console.log('5');
});

app.use(async (ctx, next) => {
    console.log('2');
    await next();
    console.log('4');
});

app.use(ctx => {
    console.log('3');
    ctx.body = 'Hello Koa';
});

app.listen(3000);

Koa的对象除了上面出现的 use() 、 listen() 、 callback() 方法外，常用的还有 keys 、 context 对象 和 错误处理。 keys 对象用于设置 signed cookie keys，比如下面两种方式：

app.keys = ['im a newer secret', 'i like turtle'];
app.keys = new KeyGrip(['im a newer secret', 'i like turtle'], 'sha256');

context 对象是我们最常用的对象了，一般在使用时变量名为 ctx ，它封装了http请求和响应等内容。你也可以向其中添加属性共全局使用。 context 对象内容比较多，将再下一节单独介绍。

错误处理相关内容将在再下面一节进行介绍。

Koa提供的功能几乎就是上面介绍的这些部分了，它本身提供的功能并不多，很多功能都需要依靠各种中间件来实现。Koa的中间件就是一个个的函数，在 app.use() 中被调用。根据Koa的机制，每个HTTP请求可以使用多个中间件分步进行处理。

Koa Context

Koa的 context 对象是我们最常用的对象，一般在使用时变量名为 ctx ，它封装了http请求和响应等内容，比如 ctx.req 就是 Node.js HTTP模块的 request 对象，ctx.res 就是 Node.js HTTP模块的 response 对象。 context 对象可用的一些属性和方法如下：

Request

Koa Request 对象是对 node 的 request 进一步抽象和封装，提供了日常 HTTP 服务器开发中一些有用的功能。Koa Request 大多数属性支持简写，比如 ctx.request.headers 等价于 ctx.headers 。

Response

Koa Response 对象是对 node 的 response 进一步抽象和封装，提供了日常 HTTP 服务器开发中一些有用的功能。Koa Response 大多数属性支持简写，比如 ctx.response.body 等价于 ctx.body 。

错误处理

Koa对象可以使用下面的方式捕获异常：

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

// 错误发生在 请求/响应 环节
app.on('error', (err, ctx) => {
    console.error('error', err, ctx)
});

对于发生在 请求/响应 环节的错误也可以使用 try { } catch { } 进行捕获，这种方式捕获的错误不会再传递给上面的onerror事件，如果有需求可以使用Koa对象的emit()方法释放捕获的错误：

app.use(async (ctx, next) => {
    try {
        await next();
    } catch (err) {
        console.error('error', err);
        ctx.app.emit('error', err, ctx);
    }
});

在 请求/响应 环节中可以使用 throw([status], [msg], [properties]) 来抛出异常。

下面是个错误处理的演示：

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

app.use(async (ctx, next) => {
    try {
        await next();
    } catch (err) {
        console.error('error 1', err);
        ctx.app.emit('error', err, ctx);
    }
});

app.use(ctx => {
    ctx.throw(500);
});

app.on('error', (err, ctx) => {
    console.error('error 2', err)
});

app.listen(3000);

总结

本篇文章基本介绍完了Koa本体所涉及的大部分功能，Koa是一个中间件框架，主要提供的功能也并不多，更多Web服务器常用的功能比如 路由、静态文件、模板 等功能都需要通过中间件来提供。接下来的文章会介绍些常用的中间件及使用方法 —— 《Koa笔记 02：常用中间件》。