koa入门

作者: 初漾流影 | 来源:发表于2018-09-11 23:55 被阅读16次

koa介绍

Koa是由Express背后的团队创建的新流行的Web应用框架。它旨在成为Express的现代和极简主义版本，它的一些流行特性是它支持和依赖新的JavaScript特性，如generators和async / await。Koa也没有附带任何中间件，尽管可以使用自定义和现有插件轻松扩展。

koa利用异步函数，抛弃回调并增加了错误处理。

Koa应用是一个包含中间件函数数组的对象，它们根据请求以类似堆栈的方式组合和执行。Koa类似于你遇到过的许多其他中间件系统，例如Ruby的Rack，Connect等等，但是，Koa的一个关键的设计决策是在其他低级中间件层提供高水平的“糖”。这提高了互操作性，健壮性，并使编写中间件更加愉快。

koa包含了常见任务的方法，如内容协商，缓存新鲜度，代理支持和重定向等。尽管提供了相当多的有用方法，Koa仍保持较小的占用空间，因为没有捆绑中间件。

Koa 2.x是async / await + promise。它的生成器支持仅用于有限的向后兼容性，并且在v3版本已弃用。

一、koa基本用法

架设HTTP服务

const Koa = require('koa');
const app = new Koa();
app.listen(3000);

只要三行代码，就可以用 Koa 架设一个 HTTP 服务。

2.Context 对象
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);
console.log('Running a koa server at localhost:3000')

main函数用来设置ctx.response.body。然后，使用app.use方法加载main函数。
其中，ctx.response代表 HTTP Response。同样地，ctx.request代表 HTTP Request。

3.HTTP Response 的类型
Koa 默认的返回类型是text/plain，如果想返回其他类型的内容，可以先用ctx.request.accepts判断一下，客户端希望接受什么数据（根据 HTTP Request 的Accept字段），然后使用ctx.response.type指定返回类型。

const main = ctx => {
    if (ctx.request.accepts('xml')) {
        ctx.response.type = 'xml';
        ctx.response.body = '<data>Hello World</data>';
    } else if (ctx.request.accepts('json')) {
        ctx.response.type = 'json';
        ctx.response.body = {data: 'Hello World'};
    } else if (ctx.request.accepts('html')) {
        ctx.response.type = 'html';
        ctx.response.body = '<p>Hello World</p>';
    } else {
        ctx.response.type = 'text';
        ctx.response.body = 'Hello World';
    }
};

二、路由

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

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

const route = require('koa-route');
const app = new Koa();
const main = ctx => {
    ctx.response.body = 'Hello World';
};
const about = ctx => {
    ctx.response.type = 'html';
    ctx.response.body = '<a href="/">Index Page</a>';
}
app.use(route.get('/',main));
app.use(route.get('/about',about));

上面代码中，根路径/的处理函数是main，/about路径的处理函数是about。

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

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

const redirect = ctx => {
  ctx.response.redirect('/');
  ctx.response.body = '<a href="/">Index Page</a>';
};
app.use(route.get('/redirect', redirect));

三、中间件

1.logger功能

Koa 的最大特色，也是最重要的一个设计，就是中间件（middleware）。为了理解中间件，我们先看一下 Logger （打印日志）功能的实现。
最简单的写法就是在main函数里面增加一行

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

2.中间件的概念
上一个例子里面的 Logger 功能，可以拆分成一个独立函数

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函数，就可以把执行权转交给下一个中间件。

3.中间件栈
多个中间件会形成一个栈结构（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);

4.异步中间件
迄今为止，所有例子的中间件都是同步的，不包含异步操作。如果有异步操作（比如读取数据库），中间件就必须写成 async 函数？？
5.中间件的合成
koa-compose块可以将多个中间件合成为一个。

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);
app.listen(3000);

四、错误处理

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

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

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

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

3.处理错误的中间件
为了方便处理错误，最好使用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);

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

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

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

5.释放 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事件，才能让监听函数监听到。

五、Web App 的功能

1.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';
}

2.表单
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());

打开另一个命令行窗口，运行下面的命令。

$ curl -X POST --data "name=Jack" 127.0.0.1:3000
{"name":"Jack"}

$ curl -X POST --data "name" 127.0.0.1:3000
name required

上面代码使用 POST 方法向服务器发送一个键值对，会被正确解析。如果发送的数据不正确，就会收到错误提示。
3.文件上传
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 }));

打开另一个命令行窗口，运行下面的命令，上传一个文件。

curl -F 'fileX=@/Users/yyhuang/Documents/code/koala/demos/hello.txt' http:127.0.0.1:3000

六、参考链接

koa框架教程

七、问题

Koa的中间件异步的原理
async和await的使用场景
ctx.app.emit('catch error', err, ctx); 不成功，error事件并没有触发
curl -F 'fileX=@/Users/yyhuang/Documents/code/koala/demos/hello.txt' http:127.0.0.1:3000 文件上传失败

koa入门

koa介绍

一、koa基本用法

二、路由

三、中间件

四、错误处理

五、Web App 的功能

六、参考链接

七、问题

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

思沃大讲堂2018