在⼩程序中使⽤asyncawait
⼩程序中有⼤量接⼝是异步调⽤,⽐如 wx.login()、wx.request()、wx.getUserInfo() 等,都是使⽤⼀个对象作为参数,并定义
了 success()、fail() 和 complete() 作为异步调⽤不同情况下的回调。
但是,以回调的⽅式来写程序,真的很伤,如果有⼀个过程需要依次⼲这些事情:
await和async使用方法wx.login() 使⽤配置信息进⾏登录
……
那么,代码⼤概会长这样
fail: () => {
success: settings => {
wx.login({
success: ({ code }) => {
code,
success: (userInfo) => {
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 可⽤,在 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) => any 在异步⽅法成功时回调
fail: (err) => any 在异步⽅法失败时回调
complete: () => 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 = de;
// do something with code
} catch (err) {
// login error
} finally {
// promisify ⾥没有专门注⼊ complete 回调,
// 因为 complete 的内容可以写在这⾥
}
2.2. 定义 wx.async()
不过⽼实说,把要⽤的异步⽅法通过 promisify ⼀个个处理,写起来还是挺烦的,不如写个⼯具函数把要⽤的⽅法⼀次性转换出来。不过⼀查,wx 下定义了不知道多少异步⽅法,还是退⽽求其次,⽤到啥转啥,不过可以批量转,转出来的结果还是封装在⼀个对象中。整个过程就是迭代处理,最后把每个处理结果聚焦在⼀起:
function toAsync(names) { // 这⾥ names 期望是⼀个数组
return (names || [])
.map(name => (
{
name,
member: wx[name]
}
))
.filter(t => ber === "function")
.reduce((r, t) => {
r[t.name] = promisify(wx[t.name]);
return r;
}, {});
}
这个 toAsync 的⽤法⼤致是这样的
const awx = toAsync(["login", "request"]);
await awx.login();
quest({...});
有些⼈可能更习惯单个参数传⼊的⽅式,像这样
const awx = toAsync("login", "request");
那么在 toAsync 的定义中,参数改为 ...names 就好,即
function toAsync(...names) { ... }
还没完,因为我不想在每⼀个 JS ⽂件中去 import { toAsync } from ...。所以把它在 Launch()中把它注⼊到 wx 对象中去,就像这样
App({
onLaunch: function() {
// ...
wx.async = toAsync;
// ...
}
});
3. await 带来的神坑
⼯具准备好了,代码也⼤⼑阔斧地进⾏了改造,看起来舒服多了,⼀运⾏却报错!为什么???
先来看⼀段原来的代码,是这样的
key: "blabla",
success: res => {
/
/ do with res
}
});
改造之后是这样
const res = Storage({ key: "blabla" }); // <== runtime error
// do with res
为什么原来没有错,现在却报错?
因为原来没有定义 fail 回调,所以错误被忽略了。但是 promisify() 把 fail 回调封装成了 reject(),所以 Storage() 返回的 Promise 对象上,需要通过 catch() 来处理。我们没有直接使⽤ Promise 对象,⽽是⽤的 await 语法,所以 reject() 会以抛出异常的形式体现出来。
⽤⼈话说,代码得这样改:
try {
const res = Storage({ key: "blabla" }); // <== runtime error
// do with res
} catch (err) {
// 我知道有错,就是当它不存在!
}
伤⼼了不是?如果没有伤⼼,你想想,每⼀个调⽤都要⽤ try ... catch ... 代码块,还能不伤⼼吗?
3.1. 忽略不需要处理的错误
处理错误真的是个好习惯,但真的不是所有错误情况都需要处理。其实要忽略错误也很简单,直接在每个 Promise 形式的异步调后⾯加句话就⾏,⽐如
const res = await awx
.getStorage({ key: "blabla" })
.catch(() => {});
// ^^^^^^^^^^^^^^^^ 捕捉错误,但什么也不⼲
稍微解释⼀下,在这⾥ Storage() 返回⼀个 Promise 对象,对该对象调⽤ .catch() 会封装 reject 的情况,同时它会返回⼀个新的 Promise 对象,这个对象才是 await 等待的 Promise。
不过感觉 .catch(() => {}) 写起来怪怪的,那就封装成⼀个⽅法吧,这得改 Promise 类的原形
Promise.prototype.ignoreError = function() {
return this.catch(() => { });
};
这段代码放在定义 toAsync() 之前就好。
⽤起来也像那么回事
const res = await awx
.getStorage({ key: "blabla" })
.ignoreError();
对于单个 await 异步调⽤,如果不想写 try ... catch ... 块,还可以⾃⼰定义⼀个 ifError(fn) 来处理错误的情况。但是如果需要批量处理错误,还是 try ... catch ... ⽤起顺⼿:
4. 回到开始
try {
const storeValue = Storage({});
const settings = Setting();
const { code } = await awx.login();
const userInfo = UserInfo({ code });
} catch (err) {
// 处理错误吧
}
看,不需要对每个异步调⽤定义 fail 回调,⼀个 try ... catch ... 处理所有可能产⽣的错误,这可不也是 async/await 的优势
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论