Node 主要用在开发 Web 应用。这决定了使用 Node,往往离不开 Web 应用框架。
Koa 就是一种简单好用的 Web 框架。它的特点是优雅、简洁、表达力强、自由度高。本身代码只有1000多行,所有功能都通过插件实现,很符合 Unix 哲学。
Koa 是一个新的 web 框架,由 Express 幕后的原班人马打造, 致力于成为 web 应用和 API 开发领域中的一个更小、更富有表现力、更健壮的基石。 通过利用 async 函数,Koa 帮你丢弃回调函数,并有力地增强错误处理。 Koa 并没有捆绑任何中间件, 而是提供了一套优雅的方法,帮助您快速而愉快地编写服务端应用程序。
本文从零开始,循序渐进,教会你如何使用 Koa 写出自己的 Web 应用。每一步都有简洁易懂的示例,希望让大家一看就懂
零,准备
首先,检查 Node 版本。
$ node -v
v10.15.0
Koa 必须使用 7.6 以上的版本。如果你的版本低于这个要求,就要先升级 Node。
然后,克隆本文的配套示例库。(如果不方便使用 Git,也可以下载 zip 文件解压。)
$ git clone https://github.com/ruanyf/koa-demos.git
接着,进入示例库,安装依赖。
$ cd koa-demos
$ npm install
所有示例源码,都在 demos 目录下面。
一、基本用法
1.1 架设 HTTP 服务
只要三行代码,就可以用 Koa 架设一个 HTTP 服务。
// demos/01.js
const Koa = require('koa');
const app = new Koa();
app.listen(3000);
运行这个脚本。
$ node demos/01.js
打开浏览器,访问 http://127.0.0.1:3000 。你会看到页面显示"Not Found",表示没有发现任何内容。这是因为我们并没有告诉 Koa 应该显示什么内容。
1.2 Context 对象
Koa 提供一个 Context 对象,表示一次对话的上下文(包括 HTTP 请求和 HTTP 回复)。通过加工这个对象,就可以控制返回给用户的内容。
Context.response.body
属性就是发送给用户的内容。请看下面的例子(完整的代码看这里)。
// demos/02.js
const Koa = require('koa');
const app = new Koa();
const main = ctx => {
ctx.response.body = 'Hello World';
};
app.use(main);
app.listen(3000);
上面代码中,main函数用来设置ctx.response.body。然后,使用app.use方法加载main函数。
你可能已经猜到了,ctx.response代表 HTTP Response。同样地,ctx.request代表 HTTP Request。
运行这个 demo。
$ node demos/02.js
访问 http://127.0.0.1:3000 ,现在就可以看到"Hello World"了。
二、路由
2.1 原生路由
网站一般都有多个页面。通过ctx.request.path
可以获取用户请求的路径,由此实现简单的路由。请看下面的例子(完整代码看这里)
// demos/05.js
const main = ctx => {
if (ctx.request.path !== '/') {
ctx.response.type = 'html';
ctx.response.body = 'Index Page';
} else {
ctx.response.body = 'Hello World';
}
};
运行这个 demo。
$ node demos/05.js
访问 http://127.0.0.1:3000/about ,可以看到一个链接,点击后就跳到首页。
2.2 koa-route 模块
原生路由用起来不太方便,我们可以使用封装好的koa-route
模块。请看下面的例子(完整代码看这里)。
// demos/06.js
const route = require('koa-route');
const about = ctx => {
ctx.response.type = 'html';
ctx.response.body = 'Index Page';
};
const main = ctx => {
ctx.response.body = 'Hello World';
};
app.use(route.get('/', main));
app.use(route.get('/about', about));
上面代码中,根路径/的处理函数是main,/about路径的处理函数是about。
运行这个 demo。
$ node demos/06.js
三、中间件
3.1 Logger 功能
Koa 的最大特色,也是最重要的一个设计,就是中间件(middleware)。为了理解中间件,我们先看一下 Logger (打印日志)功能的实现。
最简单的写法就是在main
函数里面增加一行(完整代码看这里)。
// demos/07.js
const main = ctx => {
console.log(`${Date.now()} ${ctx.request.method} ${ctx.request.url}`);
ctx.response.body = 'Hello World';
};
运行这个 Demo。
$ node demos/07.js
访问 http://127.0.0.1:3000 ,命令行就会输出日志。
1502144902843 GET /
3.2 中间件的概念
上一个例子里面的 Logger 功能,可以拆分成一个独立函数(完整代码看这里)。
// demos/08.js
const logger = (ctx, next) => {
console.log(`${Date.now()} ${ctx.request.method} ${ctx.request.url}`);
next();
}
app.use(logger);
像上面代码中的logger
函数就叫做"中间件"(middleware),因为它处在 HTTP Request 和 HTTP Response 中间,用来实现某种中间功能。app.use()
用来加载中间件。
基本上,Koa 所有的功能都是通过中间件实现的,前面例子里面的main
也是中间件。每个中间件默认接受两个参数,第一个参数是 Context 对象,第二个参数是next
函数。只要调用next
函数,就可以把执行权转交给下一个中间件。
运行这个 demo。
$ node demos/08.js
访问 http://127.0.0.1:3000 ,命令行窗口会显示与上一个例子相同的日志输出。
3.3 中间件栈
多个中间件会形成一个栈结构(middle stack),以"先进后出"(first-in-last-out)的顺序执行。
- 最外层的中间件首先执行。
- 调用
next
函数,把执行权交给下一个中间件。- ...
- 最内层的中间件最后执行。
- 执行结束后,把执行权交回上一层的中间件。
- ...
- 最外层的中间件收回执行权之后,执行
next
函数后面的代码。
请看下面的例子(完整代码看这里)。
// demos/09.js
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);
运行这个 demo。
$ node demos/09.js
访问 http://127.0.0.1:3000 ,命令行窗口会有如下输出。
>> one
>> two
>> three
<< three
<< two
<< one
如果中间件内部没有调用next
函数,那么执行权就不会传递下去。作为练习,你可以将two
函数里面next()
这一行注释掉再执行,看看会有什么结果。
3.4 异步中间件
迄今为止,所有例子的中间件都是同步的,不包含异步操作。如果有异步操作(比如读取数据库),中间件就必须写成 async 函数。请看下面的例子(完整代码看这里)。
// demos/10.js
const fs = require('fs.promised');
const Koa = require('koa');
const app = new Koa();
const main = async function (ctx, next) {
ctx.response.type = 'html';
ctx.response.body = await fs.readFile('./demos/template.html', 'utf8');
};
app.use(main);
app.listen(3000);
上面代码中,fs.readFile
是一个异步操作,必须写成await fs.readFile()
,然后中间件必须写成 async 函数。
运行这个 demo。
$ node demos/10.js
访问 http://127.0.0.1:3000 ,就可以看到模板文件的内容。
五、常用库
koa-router 路由
koa-bodyparser 请求解析
koa2-cors 跨域处理
koa-static 静态资源
六、示例项目
前端页面:NodeTemplate-todoList
后端服务:NodeTemplateKoa
参考
Koa 框架教程