node主要用于开发web应用,所以使用node往往离不开web框架。koa就是很好的web框架,本身只有1000多行,所有功能都通过插件实现,很符合Unix哲学。
一、基本用法
1、koa可被视为node中http模块的抽象,
const Koa = require('koa');
const app = new Koa();
app.listen(3000);
三行代码就可假设一个http服务。
2、context对象 -> ctx
koa提供一个context对象,表示一次对话的上下文(包括http请求和http回复)。通过加工这个对象就可以控制返回给用户的内容。context.response.body就是返回给用户的东西。
const Koa = require('koa');
const app = new Koa();
const main = ctx => {
ctx.response.body = 'Hello World';
};
app.use(main);
app.listen(3000);
main函数可以用来设置context.response.body的值,使用use方法调用中间件main函数。ctx.response代表HTTP response,ctx.request代表HTTP request。
3、HTTP response
koa默认返回类型是text/plain,如果想返回其他类型的内容,可以先用ctx.resquest.accepts判断一下客户端希望接受什么格式的数据,然后用ctx.response.type指定返回类型。
4、网页模板
实际开发中,返回给用户的网页往往都写成模板文件,我们可以让koa先读取模板文件,然后将这个模板返回给用户。
const fs = require('fs');
const main = ctx => {
ctx.response.type = 'html';
ctx.response.body = fs.createReadStream('./demos/template.html');
};
二、路由
1、原生路由:网站一般有很多页面,通过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';
}
};
2、koa-router模块:使用模块来处理路由问题
const route = require('koa-route');
const about = ctx => {
ctx.response.type = 'html';
ctx.response.body = '<a href="/">Index Page</a>';
};
const main = ctx => {
ctx.response.body = 'Hello World';
};
app.use(route.get('/', main));
app.use(route.get('/about', about));
3、静态资源:静态资源访问使用koa-static模块
const path = require('path');
const serve = require('koa-static');
const main = serve(path.join(__dirname));
app.use(main);
4、重定向:
const redirect = ctx => {
ctx.response.redirect('/');
ctx.response.body = '<a href="/">Index Page</a>';
};
app.use(route.get('/redirect', redirect));
三、中间件
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';
};
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函数就叫做“中间件”,因为它处在HTTP request 和 HTTP response 中间,用来实现某种中间功能。app.use()用来加载中间件。基本上koa的所有功能都是通过中间件实现的。前面例子里面的main也是中间件,每个中间件某人接受两个参数,第一个参数是context 对象,第二个参数是next函数,只要调用next函数,就可以把执行权转交给下一个中间件。
3.3 中间件栈:多个中间件会形成一个栈结构,以“先进后出”的顺序执行。最外层的中间件首先执行,调用next函数,把执行权交给下一个中间件,最内层的中间件最后执行,执行结束后,执行权交回上一层中间件,最外层的中间件收回执行权后,执行next函数后面的代码。如果中间件内部没有调用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);