在微信小程序中使用 async/await

微信小程序中有大量接口是异步调用,比如 wx.login() 、 wx.request() 、 wx.getUserInfo() 等,都是使用一个对象作为参数,并定义了 success() 、 fail() 和 complete() 作为异步调用不同情况下的回调 。
但是,以回调的方式来写程序,真的很伤,如果有一个过程需要依次干这些事情:
wx.getStorage()wx.getSetting()wx.login()wx.getUserInfo()wx.request()那么,代码大概会长这样
wx.getStorage({fail: () => {wx.getSetting({success: settings => {wx.login({success: ({ code }) => {wx.getUesrInfo({code,success: (userInfo) => {wx.request({success: () => {// do something}});}});}});}});}});显然,async/await 可以同样逻辑的代码看起来舒服得多 。不过默认情况下,“微信开发者工具”并不支持 async/await 。如何启用?
1. 用上 async/await如果有心,在微信小程序官方文档中搜索 async 可以找到“ 工具⇒开发辅助⇒代码编译 ”页面中提到了对 async/await 的支持情况,是在“增加编译”小节的一个表格中,摘录一段:
在 1.02.1904282 以及之后版本的开发工具中,增加了增强编译的选项来增强 ES6 转 ES5 的能力,启用后会使用新的编译逻辑以及提供额外的选项供开发者使用 。
特性原有逻辑增强编译Async/Await不支持支持

  • 支持 async/await 语法,按需注入 regeneratorRuntime ,目录位置与辅助函数一致
总之呢,就是,只要把“ 微信开发者工具 ”更新到 v1.02.1904282 以上,就不需要干 npm install regenerator 这之类的事情,只需要修改一个配置项就能使用 async/await 特性了 。这个配置就在“工具栏⇒详情⇒本地设置”页面中 。
在微信小程序中使用 async/await

文章插图
 
为了快速验证 async/await 可用,在 App.js 的 onLaunch() 事件函数中加一段代码:
(async () => {const p = await new Promise(resolve => {setTimeout(() => resolve("hello async/await"), 1000);});console.log(p);})();在短暂的自动编译运行之后,在调试器界面的 Console 页签中可以看到输出:
hello async/await如果不行,请先检查“微信开发者工具”的版本——至少,去下载一个最新版本总不会有问题的 。
2. 改造 wx.abcd 异步方法虽然 async/await 得到了支持,但是还得把 wx.abcd() 封装成 Promise 风格才行 。
Node.js 在 util 模块中提供了 promisify 来把 Node.js 风格的回调转换成 Promise 风格,但显然它不适用于 wx 风格 。还是自己动手吧,也不用考虑太多,比如 wx 风格的异步调用在形式上都是一致的,它们的特征如下 :
success: (res) => anyfail: (err) => anycomplete: () => any所以,如果 wx.abcd() 改成了 Promise 风格,通过 async/await 来编写,大概应该是这个样子
try {const res = wx.abcd();// do anything in success callback} catch (err) {// do anything in fail callback} finally {// do anything in complete callback}当然,catch 和 finally 这两个部分并不是必须,也就是说,不一定非得用 try 语句块 。但是,如果不用 catch ,会有一个神坑存在,这个问题后面再说 。现在首先要做的是 改造  。
2.1. 定义 promisify()promisify() 就是一个封装函数,传入原来的 wx.abcd 作为参加,返回一个 Promise 风格的新函数 。代码和解释如下:
function promisify(fn) {// promisify() 返回的是一个函数,// 这个函数跟传入的 fn(即 wx.abcd) 签名相同(或兼容)return async function(args) {//^^^^ 接受一个单一参数对象return new Promise((resolve, reject) => {//^^^^^^^^^^^ 返回一个 Promise 对象fn({//^^ ^ 调用原函数并使用改造过的新的参数对象...(args || {}),//^^^^^^^^这个新参数对象得有原本传入的参数,//^^当然得兼容没有传入参数的情况success: res => resolve(res),//^^^^^^^^^^^^^^^^^^^^^^^^^^^^注入 success 回调,resovle 它fail: err => reject(err)//^^^^^^^^^^^^^^^^^^^^^^^^ 注入 fail 回调,reject 它});});};}举例使用它:
const asyncLogin = promisify(wx.login);// 注意别写成 wx.login(),为什么,我不说try {const res = asyncLogin();const code = res.code;// do something with code} catch (err) {// login error} finally {// promisify 里没有专门注入 complete 回调,// 因为 complete 的内容可以写在这里}2.2. 定义 wx.async()不过老实说,把要用的异步方法通过 promisify 一个个处理,写起来还是挺烦的,不如写个工具函数把要用的方法一次性转换出来 。不过一查,wx 下定义了不知道多少异步方法,还是退而求其次,用到啥转啥,不过可以批量转,转出来的结果还是封装在一个对象中 。整个过程就是迭代处理,最后把每个处理结果聚焦在一起:


推荐阅读