Home > Article > Web Front-end > Koa2_html/css_WEB-ITnose
Koa 给自己的定位是 HTTP 中间件框架(middleware framework),专注于提供与创建 HTTP 服务器有关的通用方法和属性,本身不捆绑任何中间件,由开源社区根据实际需求开发具体的中间件。
Koa 使用 app.use()方法注册中间件,并按照注入顺序将其添加到 middleware 数组,这些中间件常用于对 HTTP 请求进行加工处理,比如生成缓存、指定代理以及重定向等。
const Koa = require('koa');const app = new Koa();// responseapp.use(ctx => { ctx.body = 'Hello Koa';});app.listen(3000)
Koa2 支持以下三种中间件函数:
// common function app.use((ctx, next) => { const start = new Date(); return next().then(() => { const ms = new Date() - start; console.log(`${ctx.method} ${ctx.url} - ${ms}ms`); });});// async functionapp.use(async (ctx, next) => { const start = new Date(); await next(); const ms = new Date() - start; console.log(`${ctx.method} ${ctx.url} - ${ms}ms`);});// generator function.use(co.wrap(function *(ctx, next) { const start = new Date(); yield next(); const ms = new Date() - start; console.log(`${ctx.method} ${ctx.url} - ${ms}ms`);}));
由于 Node.js 尚未支持 async 函数,所以需要使用 Babel 预编译 JS 文件,我的做法是安装依赖 babel-core babel-polyfill babel-preset-es2015 babel-preset-stage-0,然后在真实的入口文件(比如 index.js)前设置一个加载 Babel 的伪入口文件(比如 index.babel.js),将来 Node.js 支持 Async 后删除该文件即可:
require("babel-core/register")({ "presets": [ "es2015", "stage-0" ]});require("babel-polyfill");require('./index.js');
中间件固定接收 (ctx, next)两个参数,如果要传入其他参数,可以对中间件重新打包:
function logger(format) { format = format || ':method ":url"'; return async function (ctx, next) { const str = format .replace(':method', ctx.method) .replace(':url', ctx.url); console.log(str); await next(); };}app.use(logger());app.use(logger(':method :url'));
使用中间件 koa-compose可以合并多个中间件:
const compose = require('koa-compose');async function random(ctx, next) { // ...};async function backwards(ctx, next) { // ...};async function pi(ctx, next) { // ...};const all = compose([random, backwards, pi]);app.use(all);
Koa 提供了默认的错误处理机制,包括 try-catch和 Error 事件。自定义 try-catch捕获的推荐方式如下所示:
app.use(async (ctx, next) => { try { await next(); } catch (err) { err.status = err.statusCode || err.status || 500; throw err; }});
自定义监听 Error 事件:
app.on('error', (err, ctx) { // ...});
Koa 的实例 app包含以下属性:
app.context.db = db();
包含以下方法:
每一个请求都有一个 Context对象,该对象又包含 request和 response两个对象:
app.use(async (ctx, next) => { // Context ctx; // Request ctx.request; // Response ctx.response; });
Context 对象包含的属性:
Context 对象包含以下方法:
ctx.throw('name required', 400);// 等同于const err = new Error('name required');err.status = 400;throw err;
该对象是对 Node 原生 Request 对象的再封装,包含以下只读属性:
包含以下可读写属性:
包含以下方法:
// With Content-Type: text/html; charset=utf-8ctx.is('html'); // => 'html'ctx.is('text/html'); // => 'text/html'ctx.is('text/*', 'text/html'); // => 'text/html'// When Content-Type is application/jsonctx.is('json', 'urlencoded'); // => 'json'ctx.is('application/json'); // => 'application/json'ctx.is('html', 'application/*'); // => 'application/json'ctx.is('html'); // => false
该对象是对 Node 原生 Response 对象的再封装,包含以下只读属性
包含以下可读写属性:
tx.response.etag = crypto.createHash('md5').update(ctx.body).digest('hex');
包含以下方法: