微信小程序中有大量接口是異步調(diào)用，比如 wx.login() 、 wx.request() 、 wx.getUserInfo() 等，都是使用一個(gè)對(duì)象作為參數(shù)，并定義了 success() 、 fail() 和 complete() 作為異步調(diào)用不同情況下的回調(diào)。
但是，以回調(diào)的方式來寫程序，真的很傷，如果有一個(gè)過程需要依次干這些事情：
wx.getStorage()
wx.getSetting()
wx.login()
wx.getUserInfo()
wx.request()
那么，代碼大概會(huì)長這樣
wx.getStorage({
fail: () => {
wx.getSetting({
success: settings => {
wx.login({
success: ({ code }) => {
wx.getUesrInfo({
code,
success: (userInfo) => {
wx.request({
success: () => {
// do something
}
});
}
});
}
});
}
});
}
});
顯然，async/await 可以同樣邏輯的代碼看起來舒服得多。不過默認(rèn)情況下，“微信開發(fā)者工具”并不支持 async/await。如何啟用？
1. 用上 async/await
如果有心，在微信小程序官方文檔中搜索 async 可以找到“ 工具⇒開發(fā)輔助⇒代碼編譯 ”頁面中提到了對(duì) async/await 的支持情況，是在“增加編譯”小節(jié)的一個(gè)表格中，摘錄一段：
在 1.02.1904282 以及之后版本的開發(fā)工具中，增加了增強(qiáng)編譯的選項(xiàng)來增強(qiáng) ES6 轉(zhuǎn) ES5 的能力，啟用后會(huì)使用新的編譯邏輯以及提供額外的選項(xiàng)供開發(fā)者使用。
特性原有邏輯增強(qiáng)編譯Async/Await不支持支持
- 支持 async/await 語法，按需注入 regeneratorRuntime ，目錄位置與輔助函數(shù)一致
總之呢，就是，只要把“ 微信開發(fā)者工具 ”更新到 v1.02.1904282 以上，就不需要干 npm install regenerator 這之類的事情，只需要修改一個(gè)配置項(xiàng)就能使用 async/await 特性了。這個(gè)配置就在“工具欄⇒詳情⇒本地設(shè)置”頁面中。
為了快速驗(yàn)證 async/await 可用，在 App.js 的 onLaunch() 事件函數(shù)中加一段代碼：
(async () => {
const p = await new Promise(resolve => {
setTimeout(() => resolve("hello async/await"), 1000);
});
console.log(p);
})();
在短暫的自動(dòng)編譯運(yùn)行之后，在調(diào)試器界面的 Console 頁簽中可以看到輸出：
hello async/await
如果不行，請(qǐng)先檢查“微信開發(fā)者工具”的版本——至少，去下載一個(gè)最新版本總不會(huì)有問題的。
2. 改造 wx.abcd 異步方法
雖然 async/await 得到了支持，但是還得把 wx.abcd() 封裝成 Promise 風(fēng)格才行。
Node.js 在 util 模塊中提供了 promisify 來把 Node.js 風(fēng)格的回調(diào)轉(zhuǎn)換成 Promise 風(fēng)格，但顯然它不適用于 wx 風(fēng)格。還是自己動(dòng)手吧，也不用考慮太多，比如 wx 風(fēng)格的異步調(diào)用在形式上都是一致的，它們的特征如下 ：
success: (res) => any
fail: (err) => any
complete: () => any
所以，如果 wx.abcd() 改成了 Promise 風(fēng)格，通過 async/await 來編寫，大概應(yīng)該是這個(gè)樣子
try {
const res = wx.abcd();
// do anything in success callback
} catch (err) {
// do anything in fail callback
} finally {
// do anything in complete callback
}
當(dāng)然， catch 和 finally 這兩個(gè)部分并不是必須，也就是說，不一定非得用 try 語句塊。但是，如果不用 catch ，會(huì)有一個(gè)神坑存在，這個(gè)問題后面再說。現(xiàn)在首先要做的是 改造 。
2.1. 定義 promisify()
promisify() 就是一個(gè)封裝函數(shù)，傳入原來的 wx.abcd 作為參加，返回一個(gè) Promise 風(fēng)格的新函數(shù)。代碼和解釋如下：
function promisify(fn) {
// promisify() 返回的是一個(gè)函數(shù)，
// 這個(gè)函數(shù)跟傳入的 fn（即 wx.abcd） 簽名相同（或兼容）
return async function(args) {
// ^^^^ 接受一個(gè)單一參數(shù)對(duì)象
return new Promise((resolve, reject) => {
// ^^^^^^^^^^^ 返回一個(gè) Promise 對(duì)象
fn({
// ^^ ^ 調(diào)用原函數(shù)并使用改造過的新的參數(shù)對(duì)象
...(args || {}),
// ^^^^^^^^ 這個(gè)新參數(shù)對(duì)象得有原本傳入的參數(shù)，
// ^^ 當(dāng)然得兼容沒有傳入?yún)?shù)的情況
success: res => resolve(res),
// ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 注入 success 回調(diào)，resovle 它
fail: err => reject(err)
// ^^^^^^^^^^^^^^^^^^^^^^^^ 注入 fail 回調(diào)，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 回調(diào)，
// 因?yàn)?complete 的內(nèi)容可以寫在這里
}
2.2. 定義 wx.async()
不過老實(shí)說，把要用的異步方法通過 promisify 一個(gè)個(gè)處理，寫起來還是挺煩的，不如寫個(gè)工具函數(shù)把要用的方法一次性轉(zhuǎn)換出來。不過一查， wx 下定義了不知道多少異步方法，還是退而求其次，用到啥轉(zhuǎn)啥，不過可以批量轉(zhuǎn)，轉(zhuǎn)出來的結(jié)果還是封裝在一個(gè)對(duì)象中。整個(gè)過程就是迭代處理，最后把每個(gè)處理結(jié)果聚焦在一起：
function toAsync(names) { // 這里 names 期望是一個(gè)數(shù)組
return (names || [])
.map(name => (
{
name,
member: wx[name]
}
))
.filter(t => typeof t.member === "function")
.reduce((r, t) => {
r[t.name] = promisify(wx[t.name]);
return r;
}, {});
}
這個(gè) toAsync 的用法大致是這樣的
const awx = toAsync(["login", "request"]);
await awx.login();
await awx.request({...});
有些人可能更習(xí)慣單個(gè)參數(shù)傳入的方式，像這樣
const awx = toAsync("login", "request");
那么在 toAsync 的定義中，參數(shù)改為 ...names 就好，即
function toAsync(...names) { ... }
還沒完，因?yàn)槲也幌朐诿恳粋€(gè) JS 文件中去 import { toAsync } from ... 。所以把它在 App.onLaunch() 中把它注入到 wx 對(duì)象中去，就像這樣
App({
onLaunch: function() {
// ...
wx.async = toAsync;
// ...
}
});
3. await 帶來的神坑
工具準(zhǔn)備好了，代碼也大刀闊斧地進(jìn)行了改造，看起來舒服多了，一運(yùn)行卻報(bào)錯(cuò)！為什么？？？
先來看一段原來的代碼，是這樣的
wx.getStorage({
key: "blabla",
success: res => {
// do with res
}
});
改造之后是這樣
const res = await awx.getStorage({ key: "blabla" }); // <== runtime error
// do with res
awx.getStorage 拋了個(gè)異常，原因是叫 "blabal" 的這個(gè)數(shù)據(jù)不存在。
為什么原來沒有錯(cuò)，現(xiàn)在卻報(bào)錯(cuò)？
因?yàn)樵瓉頉]有定義 fail 回調(diào)，所以錯(cuò)誤被忽略了。但是 promisify() 把 fail 回調(diào)封裝成了 reject() ，所以 awx.getStorage() 返回的 Promise 對(duì)象上，需要通過 catch() 來處理。我們沒有直接使用 Promise 對(duì)象，而是用的 await 語法，所以 reject() 會(huì)以拋出異常的形式體現(xiàn)出來。
用人話說，代碼得這樣改：
try {
const res = await awx.getStorage({ key: "blabla" }); // <== runtime error
// do with res
} catch (err) {
// 我知道有錯(cuò)，就是當(dāng)它不存在！
}
傷心了不是？如果沒有傷心，你想想，每一個(gè)調(diào)用都要用 try ... catch ... 代碼塊，還能不傷心嗎？
3.1. 忽略不需要處理的錯(cuò)誤
處理錯(cuò)誤真的是個(gè)好習(xí)慣，但真的不是所有錯(cuò)誤情況都需要處理。其實(shí)要忽略錯(cuò)誤也很簡單，直接在每個(gè) Promise 形式的異步調(diào)后面加句話就行，比如
const res = await awx
.getStorage({ key: "blabla" })
.catch(() => {});
// ^^^^^^^^^^^^^^^^ 捕捉錯(cuò)誤，但什么也不干
稍微解釋一下，在這里 awx.getStorage() 返回一個(gè) Promise 對(duì)象，對(duì)該對(duì)象調(diào)用 .catch() 會(huì)封裝 reject 的情況，同時(shí)它會(huì)返回一個(gè)新的 Promise 對(duì)象，這個(gè)對(duì)象才是 await 等待的 Promise。
不過感覺 .catch(() => {}) 寫起來怪怪的，那就封裝成一個(gè)方法吧，這得改 Promise 類的原形
Promise.prototype.ignoreError = function() {
return this.catch(() => { });
};
這段代碼放在定義 toAsync() 之前就好。
用起來也像那么回事
const res = await awx
.getStorage({ key: "blabla" })
.ignoreError();
對(duì)于單個(gè) await 異步調(diào)用，如果不想寫 try ... catch ... 塊，還可以自己定義一個(gè) ifError(fn) 來處理錯(cuò)誤的情況。但是如果需要批量處理錯(cuò)誤，還是 try ... catch ... 用起順手：
4. 回到開始
try {
const storeValue = await awx.getStorage({});
const settings = await awx.getSetting();
const { code } = await awx.login();
const userInfo = await awx.getUserInfo({ code });
} catch (err) {
// 處理錯(cuò)誤吧
}
看，不需要對(duì)每個(gè)異步調(diào)用定義 fail 回調(diào)，一個(gè) try ... catch ... 處理所有可能產(chǎn)生的錯(cuò)誤，這可不也是 async/await 的優(yōu)勢！
