由使用request-promise-native想到的异步处理方法
问题场景
因为js语言的特性,使用node开发程序的时候经常会遇到异步处理的问题。对于之前专长app开发的我来说,会纠结node中实现客户端api请求的“最佳实践”。下面以oauth2.0为场景,需要处理的流程:
- 获取access token
- 使用获取到的token,发起api请求
- 处理api数据
处理过程
一开始,我们使用了闭包嵌套闭包的方式实现,形如:
request(options, (res, error)=>{ //handle res and error request(options2, (res2, error2)=>{ //handle res2 and error2 }) })
我们可以允许函数的异步执行,但大多数人在思考问题的时候,尤其在解决如上的场景时,还是希望能采用线性地处理方式。于是,我们使用request-promise-native
,配合aync/await,类似:
1 (async ()=> { 2 let access = await requestpromise(authoptions).then((value)=>{ 3 return value; 4 }).catch((error)=>{ 5 return error; 6 }); 7 console.log('access', access); 8 })();
使用async/await的时候,需要知道:
- await不能单独使用,其所在的上下文之前必须有async
- await 作用的对象是promise对象
可以猜想 request-promise-native
必定是对request进行了promise化,从源代码中可以看到(虽然我没看懂,应该是使用了通用的方法来创建promise):
// exposing the promise capabilities var thenexposed = false; for ( var i = 0; i < options.expose.length; i+=1 ) { var method = options.expose[i]; plumbing[ method === 'promise' ? 'exposepromise' : 'exposepromisemethod' ]( options.request.request.prototype, null, '_rp_promise', method ); if (method === 'then') { thenexposed = true; } } if (!thenexposed) { throw new error('please expose "then"'); }
既然如此,我们可以构造promise,交给await。下面就把request
包裹成一个promise:
1 //token.js 2 module.exports.getaccesstoken = async (options) => { 3 return new promise(function (resolve, reject) { 4 request(options, function (error, res, body) { 5 if (!error && res.statuscode == 200) { 6 resolve(body); 7 } else { 8 if(error){ 9 reject(error); 10 }else{ 11 reject(body); 12 } 13 } 14 }); 15 }); 16 }; 17 //app.js 18 (async ()=> { 19 let access = await token.getaccesstoken(authoptions).then((value)=>{ 20 //handle value if requires 21 return value; 22 }).catch((error)=>{ 23 return error; 24 }); 25 console.log('access', access); 26 //use token to send the request 27 })();
api成功返回的结果我们往往需要按需处理,这一步放在then函数中进行。因为promise调用then仍然是promise,因此这里链式调用的then和catch。
进一步地,我们尝试使用内置模块 util
对函数进行promise化,形如:
//token.js const request = require('request'); const {promisify} = require('util'); const requestpromise = promisify(request); module.exports.getaccesstoken = async (options) => { return requestpromise(options); }; //app.js (async ()=> { let access = await token.getaccesstoken(authoptions).then((value)=>{ //handle value if requires return value; }).catch((error)=>{ return error; }); console.log('access', access); //use token to send the request })();
说了这么多,对我而言,目前最大的收获就是理解了如何使用promise/async/await,把异步函数顺序执行:把带有闭包的函数包裹进promise,然后使用async/await执行该promise。
好了,以上是我解决此类问题的思路。我相信必然还有其他优雅的解决方式,甚至是最佳实践。今天,借此机会,抛砖引玉,希望大家能够不吝赐教。
promise 内容复习
最后,容我温习一下promise相关的内容,有片面的地方请大家指正。
promise对象:
the promise object represents the eventual completion (or failure) of an asynchronous operation, and its resulting value.
promise有三种状态: 初始状态,执行成功,执行出错。 then()表示promise执行后的进一步处理,它可以带两个callback参数:第一个用于promise成功运行后执行,第二个表示promise运行失败后执行。catch()表示promise运行失败后所执行的工作。catch()可以理解为语法糖,当then()的第二个callback参数省略的时候,意味着需要调用catch(因为未处理的失败的promise在将来某个node版本会导致程序退出)。需要注意的是,then()/catch()方法也是返回promise,因此可以链式调用。