Node.js 中使用 async 函数的方法
借助于新版V8引擎,Node.js从7.6开始支持async函数特性。今年10月31日,Node.js8也开始成为新的长期支持版本,因此你完全可以放心大胆地在你的代码中使用async函数了。在这边文章里,我会简要地介绍一下什么是async函数,以及它会如何改变我们编写Node.js应用的方式。
1什么是async函数
利用async函数,你可以把基于Promise的异步代码写得就像同步代码一样。一旦你使用async关键字来定义了一个函数,那你就可以在这个函数内使用await关键字。当一个async函数被调用时,它会返回一个Promise。当这个async函数返回一个值时,那个Promise就会被实现;而如果函数中抛出一个错误,那么Promise就会被拒绝。
await关键字可以被用来等待一个Promise被解决并返回其实现的值。如果传给await的值不是一个Promise,那它会把这个值转化为一个已解决的Promise。
constrp=require('request-promise') asyncfunctionmain(){ constresult=awaitrp('https://google.com') consttwenty=await20 //睡个1秒钟 awaitnewPromise(resolve=>{ setTimeout(resolve,1000) }) returnresult } main() .then(console.log) .catch(console.error)
2向async函数迁移
如果你的Node.js应用已经在使用Promise,那你只需要把原先的链式调用改写为对你的这些Promise进行await。
如果你的应用还在使用回调函数,那你应该以渐进的方式转向使用async函数。你可以在开发一些新功能的时候使用这项新技术。当你必须调用一些旧有的代码时,你可以简单地把它们包裹成为Promise再用新的方式调用。
要做到这一点,你可以使用内建的util.promisify方法:
constutil=require('util') const{readFile}=require('fs') constreadFileAsync=util.promisify(readFile) asyncfunctionmain(){ constresult=awaitreadFileAsync('.gitignore') returnresult } main() .then(console.log) .catch(console.error)
3Async函数的最佳实践
3.1在express中使用async函数
express本来就支持Promise,所以在express中使用async函数是比较简单的:
constexpress=require('express') constapp=express() app.get('/',async(request,response)=>{ //在这里等待Promise //如果你只是在等待一个单独的Promise,你其实可以直接将将它作为返回值返回,不需要使用await去等待。 constresult=awaitgetContent() response.send(result) }) app.listen(process.env.PORT)
但正如KeithSmith所指出的,上面这个例子有一个严重的问题——如果Promise最终被拒绝,由于这里没有进行错误处理,那这个express路由处理器就会被挂起。
为了修正这个问题,你应该把你的异步处理器包裹在一个对错误进行处理的函数中:
constawaitHandlerFactory=(middleware)=>{ returnasync(req,res,next)=>{ try{ awaitmiddleware(req,res,next) }catch(err){ next(err) } } } //然后这样使用: app.get('/',awaitHandlerFactory(async(request,response)=>{ constresult=awaitgetContent() response.send(result) }))
3.2并行执行
比如说你正在编写这样一个程序,一个操作需要两个输入,其中一个来自于数据库,另一个则来自于一个外部服务:
asyncfunctionmain(){ constuser=awaitUsers.fetch(userId) constproduct=awaitProducts.fetch(productId) awaitmakePurchase(user,product) }
在这个例子中,会发生什么呢?
你的代码会首先去获取user,
然后获取product,
最后再进行支付。
如你所见,由于前两步之间并没有相互依赖关系,其实你完全可以将它们并行执行。这里,你应该使用Promise.all方法:
asyncfunctionmain(){ const[user,product]=awaitPromise.all([ Users.fetch(userId), Products.fetch(productId) ]) awaitmakePurchase(user,product) }
而有时候,你只需要其中最快被解决的Promise的返回值——这时,你可以使用Promise.race方法。
3.3错误处理
考虑下面这个例子:
asyncfunctionmain(){ awaitnewPromise((resolve,reject)=>{ reject(newError('error')) }) } main() .then(console.log)
当执行这段代码的时候,你会看到类似这样的信息:
(node:69738)UnhandledPromiseRejectionWarning:Unhandledpromiserejection(rejectionid:2):Error:error
(node:69738)[DEP0018]DeprecationWarning:Unhandledpromiserejectionsaredeprecated.Inthefuture,promiserejectionsthatarenothandledwillterminatetheNode.jsprocesswithanon-zeroexitcode.
在较新的Node.js版本中,如果Promise被拒绝且未得到处理,整个Node.js进程就会被中断。因此必要的时候你应该使用try-catch:
constutil=require('util') asyncfunctionmain(){ try{ awaitnewPromise((resolve,reject)=>{ reject(newError('