Koa是一款非常著名的Node服务端框架,有1.x版本和2.x版本。前者使用了generator来进行异步操作,后者则用了最新的async/await方案
一开始使用这种写法的时候,我遇到一个问题,代码如下:
const Koa = require('koa'); const app = new Koa(); const doSomething = time => { return new Promise(resolve => { setTimeout(() => { resolve('task done!') }, time) }) } // 用来打印请求信息 app.use((ctx, next) => { console.log(`${ctx.method}:::${ctx.url}`) next() }) app.use(async ctx => { const result = await doSomething(3000) console.log(result); ctx.body = result }) app.listen(3000);
让我们测试一下:curl :3000
期望结果:
(3秒后...)task done!
然而现实却是:
(立即)
Not Found
什么鬼?为什么没有按照预期执行?这就需要我们来理解下Koa中中间件是如何串联起来的了。翻一下源码,将middlewares串联起来的代码如下:
function compose (middleware) { return function (context, next) { // 这个index用来计数,防止next被多次调用 let index = -1 // 执行入口 return dispatch(0) function dispatch (i) { // 如果next被多次调用,报异常 if (i <= index) return Promise.reject(new Error('next() called multiple times')) index = i // 取出第一个middleware let fn = middleware[i] // 将最初传入的next作为最后一个函数执行 if (i === middleware.length) fn = next if (!fn) return Promise.resolve() try { /** 这里就是关键了,Promise.resolve是什么意思呢? Promise.resolve方法有下面三种形式: Promise.resolve(value); Promise.resolve(promise); Promise.resolve(theanable); 这三种形式都会产生一个新的Promise。其中: 第一种形式提供了自定义Promise的值的能力,它与Promise.reject(reason)对应。两者的不同,在于得到的Promise的状态不同。 第二种形式,提供了创建一个Promise的副本的能力。 第三种形式,是将一个类似Promise的对象转换成一个真正的Promise对象。它的一个重要作用是将一个其他实现的Promise对象封装成一个当前实现的Promise对象。例如你正在用bluebird,但是现在有一个Q的Promise,那么你可以通过此方法把Q的Promise变成一个bluebird的Promise。第二种形式可以归在第三种里面 **/ return Promise.resolve(fn(context, function next () { // 执行下一个middleware,返回结果也是一个Promise return dispatch(i + 1) })) } catch (err) { return Promise.reject(err) } } } }
有了以上基础,我们再来看一下之前的问题,为什么response没有等到第二个middleware执行完成就立即返回了呢?
因为第一个middleware并不是一个异步函数啊。
由于每次next方法的执行,实际上都是返回了一个Promise对象,所以如果我们在某个middleware中执行了异步操作,要想等待其完成,就要在执行这个middleware之前添加await
那我们来改写一下之前的代码
app.use(async (ctx, next) => { console.log(`${ctx.method}:::${ctx.url}`) await next() }) app.use(async ctx => { const result = await doSomething(3000) console.log(result); ctx.body = result })
好了,没有问题,一切如期望执行:clap:
错误处理
借助了Promise强大的功力,配合async/await语法,我们只需要把try/catch的操作写在最外层的middleware中,就可以捕获到之后所有中间件的异常!
app.use(async (ctx, next) => { try{ await next() }catch(err){ console.log(err) } }) app.use(async (ctx)=>{ throw new Error('something wrong!') ctx.body = 'Hello' })
基于中间件链的完全控制,并且基于 Promise 的事实使得一切都变得容易操作起来。不再是到处的 if (err) return next(err) 而只有 promise