原文發(fā)布于作者掘金:寫代碼像蔡徐抻
點贊大歡迎Thanks?(?ω?)?
筆者剛接觸async/await
時,就被其暫停執(zhí)行的特性吸引了朦蕴,心想在沒有原生API支持的情況下蛤签,await居然能掛起當(dāng)前方法猬仁,實現(xiàn)暫停執(zhí)行事期,我感到十分好奇。好奇心驅(qū)使我一層一層剝開有關(guān)JS異步編程的一切蒿偎。閱讀完本文朽们,讀者應(yīng)該能夠了解:
-
Promise
的實現(xiàn)原理 -
async/await
的實現(xiàn)原理 -
Generator
的實現(xiàn)原理
Promise實現(xiàn)
在成文過程中,筆者查閱了很多講解Promise實現(xiàn)的文章酥郭,但感覺大多文章都很難稱得上條理清晰华坦,有的上來就放大段Promise規(guī)范翻譯,有的在Promise基礎(chǔ)使用上浪費篇幅不从,又或者把一個簡單的東西長篇大論惜姐,過度講解,我推薦頭鐵的同學(xué)直接拉到本章小結(jié)看最終實現(xiàn)椿息,結(jié)合著注釋直接啃代碼也能理解十之八九
回歸正題歹袁,文章開頭我們先點一下Promise為我們解決了什么問題:在傳統(tǒng)的異步編程中,如果異步之間存在依賴關(guān)系寝优,我們就需要通過層層嵌套回調(diào)來滿足這種依賴条舔,如果嵌套層數(shù)過多,可讀性和可維護性都變得很差乏矾,產(chǎn)生所謂“回調(diào)地獄”孟抗,而Promise將回調(diào)嵌套改為鏈式調(diào)用,增加可讀性和可維護性钻心。下面我們就來一步步實現(xiàn)一個Promise:
1. 觀察者模式
我們先來看一個最簡單的Promise使用:
const p1 = new Promise((resolve, reject) => {
setTimeout(() => {
resolve('result')
},
1000);
})
p1.then(res => console.log(res), err => console.log(err))
觀察這個例子凄硼,我們分析Promise的調(diào)用流程:
-
Promise
的構(gòu)造方法接收一個executor()
,在new Promise()
時就立刻執(zhí)行這個executor回調(diào) -
executor()
內(nèi)部的異步任務(wù)被放入宏/微任務(wù)隊列捷沸,等待執(zhí)行 -
then()
被執(zhí)行摊沉,收集成功/失敗回調(diào),放入成功/失敗隊列 -
executor()
的異步任務(wù)被執(zhí)行痒给,觸發(fā)resolve/reject
说墨,從成功/失敗隊列中取出回調(diào)依次執(zhí)行
其實熟悉設(shè)計模式的同學(xué)骏全,很容易就能意識到這是個觀察者模式,這種收集依賴 -> 觸發(fā)通知 -> 取出依賴執(zhí)行
的方式尼斧,被廣泛運用于觀察者模式的實現(xiàn)姜贡,在Promise里,執(zhí)行順序是then收集依賴 -> 異步觸發(fā)resolve -> resolve執(zhí)行依賴
棺棵。依此鲁豪,我們可以勾勒出Promise的大致形狀:
class MyPromise {
// 構(gòu)造方法接收一個回調(diào)
constructor(executor) {
this._resolveQueue = [] // then收集的執(zhí)行成功的回調(diào)隊列
this._rejectQueue = [] // then收集的執(zhí)行失敗的回調(diào)隊列
// 由于resolve/reject是在executor內(nèi)部被調(diào)用, 因此需要使用箭頭函數(shù)固定this指向, 否則找不到this._resolveQueue
let _resolve = (val) => {
// 從成功隊列里取出回調(diào)依次執(zhí)行
while(this._resolveQueue.length) {
const callback = this._resolveQueue.shift()
callback(val)
}
}
// 實現(xiàn)同resolve
let _reject = (val) => {
while(this._rejectQueue.length) {
const callback = this._rejectQueue.shift()
callback(val)
}
}
// new Promise()時立即執(zhí)行executor,并傳入resolve和reject
executor(_resolve, _reject)
}
// then方法,接收一個成功的回調(diào)和一個失敗的回調(diào),并push進對應(yīng)隊列
then(resolveFn, rejectFn) {
this._resolveQueue.push(resolveFn)
this._rejectQueue.push(rejectFn)
}
}
寫完代碼我們可以測試一下:
const p1 = new MyPromise((resolve, reject) => {
setTimeout(() => {
resolve('result')
}, 1000);
})
p1.then(res => console.log(res))
//一秒后輸出result
我們運用觀察者模式簡單的實現(xiàn)了一下then
和resolve
律秃,使我們能夠在then方法的回調(diào)里取得異步操作的返回值,但我們這個Promise離最終實現(xiàn)還有很長的距離治唤,下面我們來一步步補充這個Promise:
2. Promise A+規(guī)范
上面我們已經(jīng)簡單地實現(xiàn)了一個超低配版Promise棒动,但我們會看到很多文章和我們寫的不一樣,他們的Promise實現(xiàn)中還引入了各種狀態(tài)控制宾添,這是由于ES6的Promise實現(xiàn)需要遵循Promise/A+規(guī)范船惨,是規(guī)范對Promise的狀態(tài)控制做了要求。Promise/A+的規(guī)范比較長缕陕,這里只總結(jié)兩條核心規(guī)則:
- Promise本質(zhì)是一個狀態(tài)機粱锐,且狀態(tài)只能為以下三種:
Pending(等待態(tài))
、Fulfilled(執(zhí)行態(tài))
扛邑、Rejected(拒絕態(tài))
怜浅,狀態(tài)的變更是單向的,只能從Pending -> Fulfilled 或 Pending -> Rejected蔬崩,狀態(tài)變更不可逆then方法
接收兩個可選參數(shù)恶座,分別對應(yīng)狀態(tài)改變時觸發(fā)的回調(diào)。then方法返回一個promise沥阳。then 方法可以被同一個 promise 調(diào)用多次跨琳。
[圖片上傳失敗...(image-ce57ce-1585289891794)]
根據(jù)規(guī)范,我們補充一下Promise的代碼:
//Promise/A+規(guī)范的三種狀態(tài)
const PENDING = 'pending'
const FULFILLED = 'fulfilled'
const REJECTED = 'rejected'
class MyPromise {
// 構(gòu)造方法接收一個回調(diào)
constructor(executor) {
this._status = PENDING // Promise狀態(tài)
this._resolveQueue = [] // 成功隊列, resolve時觸發(fā)
this._rejectQueue = [] // 失敗隊列, reject時觸發(fā)
// 由于resolve/reject是在executor內(nèi)部被調(diào)用, 因此需要使用箭頭函數(shù)固定this指向, 否則找不到this._resolveQueue
let _resolve = (val) => {
if(this._status !== PENDING) return // 對應(yīng)規(guī)范中的"狀態(tài)只能由pending到fulfilled或rejected"
this._status = FULFILLED // 變更狀態(tài)
// 這里之所以使用一個隊列來儲存回調(diào),是為了實現(xiàn)規(guī)范要求的 "then 方法可以被同一個 promise 調(diào)用多次"
// 如果使用一個變量而非隊列來儲存回調(diào),那么即使多次p1.then()也只會執(zhí)行一次回調(diào)
while(this._resolveQueue.length) {
const callback = this._resolveQueue.shift()
callback(val)
}
}
// 實現(xiàn)同resolve
let _reject = (val) => {
if(this._status !== PENDING) return // 對應(yīng)規(guī)范中的"狀態(tài)只能由pending到fulfilled或rejected"
this._status = REJECTED // 變更狀態(tài)
while(this._rejectQueue.length) {
const callback = this._rejectQueue.shift()
callback(val)
}
}
// new Promise()時立即執(zhí)行executor,并傳入resolve和reject
executor(_resolve, _reject)
}
// then方法,接收一個成功的回調(diào)和一個失敗的回調(diào)
then(resolveFn, rejectFn) {
this._resolveQueue.push(resolveFn)
this._rejectQueue.push(rejectFn)
}
}
3. then的鏈式調(diào)用
補充完規(guī)范桐罕,我們接著來實現(xiàn)鏈式調(diào)用脉让,這是Promise實現(xiàn)的重點和難點,我們先來看一下then是如何鏈式調(diào)用的:
const p1 = new Promise((resolve, reject) => {
resolve(1)
})
p1
.then(res => {
console.log(res)
//then回調(diào)中可以return一個Promise
return new Promise((resolve, reject) => {
setTimeout(() => {
resolve(2)
}, 1000);
})
})
.then(res => {
console.log(res)
//then回調(diào)中也可以return一個值
return 3
})
.then(res => {
console.log(res)
})
輸出
1
2
3
我們思考一下如何實現(xiàn)這種鏈式調(diào)用:
- 顯然
.then()
需要返回一個Promise功炮,這樣才能找到then方法溅潜,所以我們會把then方法的返回值包裝成Promise。 -
.then()
的回調(diào)需要順序執(zhí)行死宣,以上面這段代碼為例伟恶,雖然中間return了一個Promise,但執(zhí)行順序仍要保證是1->2->3毅该。我們要等待當(dāng)前Promise狀態(tài)變更后博秫,再執(zhí)行下一個then收集的回調(diào)潦牛,這就要求我們對then的返回值分類討論
// then方法
then(resolveFn, rejectFn) {
//return一個新的promise
return new Promise((resolve, reject) => {
//把resolveFn重新包裝一下,再push進resolve執(zhí)行隊列,這是為了能夠獲取回調(diào)的返回值進行分類討論
const fulfilledFn = value => {
try {
//執(zhí)行第一個(當(dāng)前的)Promise的成功回調(diào),并獲取返回值
let x = resolveFn(value)
//分類討論返回值,如果是Promise,那么等待Promise狀態(tài)變更,否則直接resolve
x instanceof Promise ? x.then(resolve, reject) : resolve(x)
} catch (error) {
reject(error)
}
}
//把后續(xù)then收集的依賴都push進當(dāng)前Promise的成功回調(diào)隊列中(_rejectQueue), 這是為了保證順序調(diào)用
this._resolveQueue.push(fulfilledFn)
//reject同理
const rejectedFn = error => {
try {
let x = rejectFn(error)
x instanceof Promise ? x.then(resolve, reject) : resolve(x)
} catch (error) {
reject(error)
}
}
this._rejectQueue.push(rejectedFn)
})
}
然后我們就能測試一下鏈式調(diào)用:
const p1 = new MyPromise((resolve, reject) => {
setTimeout(() => {
resolve(1)
}, 500);
})
p1
.then(res => {
console.log(res)
return 2
})
.then(res => {
console.log(res)
return 3
})
.then(res => {
console.log(res)
})
//輸出 1 2 3
4.值穿透 & 狀態(tài)已變更的情況
我們已經(jīng)初步完成了鏈式調(diào)用,但是對于 then() 方法挡育,我們還要兩個細節(jié)需要處理一下
- 值穿透:根據(jù)規(guī)范巴碗,如果 then() 接收的參數(shù)不是function,那么我們應(yīng)該忽略它即寒。如果沒有忽略橡淆,當(dāng)then()回調(diào)不為function時將會拋出異常,導(dǎo)致鏈式調(diào)用中斷
-
處理狀態(tài)為resolve/reject的情況:其實我們上邊 then() 的寫法是對應(yīng)狀態(tài)為
padding
的情況母赵,但是有些時候逸爵,resolve/reject 在 then() 之前就被執(zhí)行(比如Promise.resolve().then()
),如果這個時候還把then()回調(diào)push進resolve/reject的執(zhí)行隊列里凹嘲,那么回調(diào)將不會被執(zhí)行师倔,因此對于狀態(tài)已經(jīng)變?yōu)?code>fulfilled或rejected
的情況,我們直接執(zhí)行then回調(diào):
// then方法,接收一個成功的回調(diào)和一個失敗的回調(diào)
then(resolveFn, rejectFn) {
// 根據(jù)規(guī)范周蹭,如果then的參數(shù)不是function趋艘,則我們需要忽略它, 讓鏈式調(diào)用繼續(xù)往下執(zhí)行
typeof resolveFn !== 'function' ? resolveFn = value => value : null
typeof rejectFn !== 'function' ? rejectFn = error => error : null
// return一個新的promise
return new Promise((resolve, reject) => {
// 把resolveFn重新包裝一下,再push進resolve執(zhí)行隊列,這是為了能夠獲取回調(diào)的返回值進行分類討論
const fulfilledFn = value => {
try {
// 執(zhí)行第一個(當(dāng)前的)Promise的成功回調(diào),并獲取返回值
let x = resolveFn(value)
// 分類討論返回值,如果是Promise,那么等待Promise狀態(tài)變更,否則直接resolve
x instanceof Promise ? x.then(resolve, reject) : resolve(x)
} catch (error) {
reject(error)
}
}
// reject同理
const rejectedFn = error => {
try {
let x = rejectFn(error)
x instanceof Promise ? x.then(resolve, reject) : resolve(x)
} catch (error) {
reject(error)
}
}
switch (this._status) {
// 當(dāng)狀態(tài)為pending時,把then回調(diào)push進resolve/reject執(zhí)行隊列,等待執(zhí)行
case PENDING:
this._resolveQueue.push(fulfilledFn)
this._rejectQueue.push(rejectedFn)
break;
// 當(dāng)狀態(tài)已經(jīng)變?yōu)閞esolve/reject時,直接執(zhí)行then回調(diào)
case FULFILLED:
fulfilledFn(this._value) // this._value是上一個then回調(diào)return的值(見完整版代碼)
break;
case REJECTED:
rejectedFn(this._value)
break;
}
})
}
5.兼容同步任務(wù)
完成了then的鏈式調(diào)用以后,我們再處理一個前邊的細節(jié)凶朗,然后放出完整代碼瓷胧。上文我們說過,Promise的執(zhí)行順序是new Promise -> then()收集回調(diào) -> resolve/reject執(zhí)行回調(diào)
棚愤,這一順序是建立在executor是異步任務(wù)的前提上的搓萧,如果executor是一個同步任務(wù),那么順序就會變成new Promise -> resolve/reject執(zhí)行回調(diào) -> then()收集回調(diào)
遇八,resolve的執(zhí)行跑到then之前去了矛绘,為了兼容這種情況,我們給resolve/reject
執(zhí)行回調(diào)的操作包一個setTimeout刃永,讓它異步執(zhí)行货矮。
這里插一句,有關(guān)這個setTimeout斯够,其實還有一番學(xué)問囚玫。雖然規(guī)范沒有要求回調(diào)應(yīng)該被放進宏任務(wù)隊列還是微任務(wù)隊列,但其實Promise的默認實現(xiàn)是放進了微任務(wù)隊列读规,我們的實現(xiàn)(包括大多數(shù)Promise手動實現(xiàn)和polyfill的轉(zhuǎn)化)都是使用setTimeout放入了宏任務(wù)隊列(當(dāng)然我們也可以用MutationObserver模擬微任務(wù))
//Promise/A+規(guī)定的三種狀態(tài)
const PENDING = 'pending'
const FULFILLED = 'fulfilled'
const REJECTED = 'rejected'
class MyPromise {
// 構(gòu)造方法接收一個回調(diào)
constructor(executor) {
this._status = PENDING // Promise狀態(tài)
this._value = undefined // 儲存then回調(diào)return的值
this._resolveQueue = [] // 成功隊列, resolve時觸發(fā)
this._rejectQueue = [] // 失敗隊列, reject時觸發(fā)
// 由于resolve/reject是在executor內(nèi)部被調(diào)用, 因此需要使用箭頭函數(shù)固定this指向, 否則找不到this._resolveQueue
let _resolve = (val) => {
//把resolve執(zhí)行回調(diào)的操作封裝成一個函數(shù),放進setTimeout里,以兼容executor是同步代碼的情況
const run = () => {
if(this._status !== PENDING) return // 對應(yīng)規(guī)范中的"狀態(tài)只能由pending到fulfilled或rejected"
this._status = FULFILLED // 變更狀態(tài)
this._value = val // 儲存當(dāng)前value
// 這里之所以使用一個隊列來儲存回調(diào),是為了實現(xiàn)規(guī)范要求的 "then 方法可以被同一個 promise 調(diào)用多次"
// 如果使用一個變量而非隊列來儲存回調(diào),那么即使多次p1.then()也只會執(zhí)行一次回調(diào)
while(this._resolveQueue.length) {
const callback = this._resolveQueue.shift()
callback(val)
}
}
setTimeout(run)
}
// 實現(xiàn)同resolve
let _reject = (val) => {
const run = () => {
if(this._status !== PENDING) return // 對應(yīng)規(guī)范中的"狀態(tài)只能由pending到fulfilled或rejected"
this._status = REJECTED // 變更狀態(tài)
this._value = val // 儲存當(dāng)前value
while(this._rejectQueue.length) {
const callback = this._rejectQueue.shift()
callback(val)
}
}
setTimeout(run)
}
// new Promise()時立即執(zhí)行executor,并傳入resolve和reject
executor(_resolve, _reject)
}
// then方法,接收一個成功的回調(diào)和一個失敗的回調(diào)
then(resolveFn, rejectFn) {
// 根據(jù)規(guī)范抓督,如果then的參數(shù)不是function,則我們需要忽略它, 讓鏈式調(diào)用繼續(xù)往下執(zhí)行
typeof resolveFn !== 'function' ? resolveFn = value => value : null
typeof rejectFn !== 'function' ? rejectFn = error => error : null
// return一個新的promise
return new Promise((resolve, reject) => {
// 把resolveFn重新包裝一下,再push進resolve執(zhí)行隊列,這是為了能夠獲取回調(diào)的返回值進行分類討論
const fulfilledFn = value => {
try {
// 執(zhí)行第一個(當(dāng)前的)Promise的成功回調(diào),并獲取返回值
let x = resolveFn(value)
// 分類討論返回值,如果是Promise,那么等待Promise狀態(tài)變更,否則直接resolve
x instanceof Promise ? x.then(resolve, reject) : resolve(x)
} catch (error) {
reject(error)
}
}
// reject同理
const rejectedFn = error => {
try {
let x = rejectFn(error)
x instanceof Promise ? x.then(resolve, reject) : resolve(x)
} catch (error) {
reject(error)
}
}
switch (this._status) {
// 當(dāng)狀態(tài)為pending時,把then回調(diào)push進resolve/reject執(zhí)行隊列,等待執(zhí)行
case PENDING:
this._resolveQueue.push(fulfilledFn)
this._rejectQueue.push(rejectedFn)
break;
// 當(dāng)狀態(tài)已經(jīng)變?yōu)閞esolve/reject時,直接執(zhí)行then回調(diào)
case FULFILLED:
fulfilledFn(this._value) // this._value是上一個then回調(diào)return的值(見完整版代碼)
break;
case REJECTED:
rejectedFn(this._value)
break;
}
})
}
}
然后我們可以測試一下這個Promise:
const p1 = new MyPromise((resolve, reject) => {
resolve(1) //同步executor測試
})
p1
.then(res => {
console.log(res)
return 2 //鏈式調(diào)用測試
})
.then() //值穿透測試
.then(res => {
console.log(res)
return new MyPromise((resolve, reject) => {
resolve(3) //返回Promise測試
})
})
.then(res => {
console.log(res)
throw new Error('reject測試') //reject測試
})
.then(() => {}, err => {
console.log(err)
})
// 輸出
// 1
// 2
// 3
// Error: reject測試
到這里束亏,我們已經(jīng)實現(xiàn)了Promise的主要功能(`?′)Ψ
剩下的幾個方法都非常簡單铃在,我們順手收拾掉:
Promise.prototype.catch()
catch()方法
返回一個Promise,并且處理拒絕的情況。它的行為與調(diào)用Promise.prototype.then(undefined, onRejected) 相同定铜。
//catch方法其實就是執(zhí)行一下then的第二個回調(diào)
catch(rejectFn) {
return this.then(undefined, rejectFn)
}
Promise.prototype.finally()
finally()方法
返回一個Promise阳液。在promise結(jié)束時,無論結(jié)果是fulfilled或者是rejected揣炕,都會執(zhí)行指定的回調(diào)函數(shù)帘皿。在finally之后,還可以繼續(xù)then畸陡。并且會將值原封不動的傳遞給后面的then
//finally方法
finally(callback) {
return this.then(
value => MyPromise.resolve(callback()).then(() => value), // MyPromise.resolve執(zhí)行回調(diào),并在then中return結(jié)果傳遞給后面的Promise
reason => MyPromise.resolve(callback()).then(() => { throw reason }) // reject同理
)
}
Promise.resolve()
Promise.resolve(value)
方法返回一個以給定值解析后的Promise 對象鹰溜。如果該值為promise,返回這個promise丁恭;如果這個值是thenable(即帶有"then" 方法))曹动,返回的promise會“跟隨”這個thenable的對象,采用它的最終狀態(tài)牲览;否則返回的promise將以此值完成仁期。此函數(shù)將類promise對象的多層嵌套展平。
//靜態(tài)的resolve方法
static resolve(value) {
if(value instanceof MyPromise) return value // 根據(jù)規(guī)范, 如果參數(shù)是Promise實例, 直接return這個實例
return new MyPromise(resolve => resolve(value))
}
Promise.reject()
Promise.reject()
方法返回一個帶有拒絕原因的Promise對象竭恬。
//靜態(tài)的reject方法
static reject(reason) {
return new MyPromise((resolve, reject) => reject(reason))
}
Promise.all()
Promise.all(iterable)
方法返回一個 Promise 實例,此實例在 iterable 參數(shù)內(nèi)所有的 promise 都“完成(resolved)”或參數(shù)中不包含 promise 時回調(diào)完成(resolve)熬的;如果參數(shù)中 promise 有一個失斎丁(rejected),此實例回調(diào)失斞嚎颉(reject)岔绸,失敗原因的是第一個失敗 promise 的結(jié)果。
//靜態(tài)的all方法
static all(promiseArr) {
let index = 0
let result = []
return new MyPromise((resolve, reject) => {
promiseArr.forEach((p, i) => {
//Promise.resolve(p)用于處理傳入值不為Promise的情況
MyPromise.resolve(p).then(
val => {
index++
result[i] = val
//所有then執(zhí)行后, resolve結(jié)果
if(index === promiseArr.length) {
resolve(result)
}
},
err => {
//有一個Promise被reject時橡伞,MyPromise的狀態(tài)變?yōu)閞eject
reject(err)
}
)
})
})
}
Promise.race()
Promise.race(iterable)
方法返回一個 promise盒揉,一旦迭代器中的某個promise解決或拒絕,返回的 promise就會解決或拒絕兑徘。
static race(promiseArr) {
return new MyPromise((resolve, reject) => {
//同時執(zhí)行Promise,如果有一個Promise的狀態(tài)發(fā)生改變,就變更新MyPromise的狀態(tài)
for (let p of promiseArr) {
Promise.resolve(p).then( //Promise.resolve(p)用于處理傳入值不為Promise的情況
value => {
resolve(value) //注意這個resolve是上邊new MyPromise的
},
err => {
reject(err)
}
)
}
})
}
完整代碼
//Promise/A+規(guī)定的三種狀態(tài)
const PENDING = 'pending'
const FULFILLED = 'fulfilled'
const REJECTED = 'rejected'
class MyPromise {
// 構(gòu)造方法接收一個回調(diào)
constructor(executor) {
this._status = PENDING // Promise狀態(tài)
this._value = undefined // 儲存then回調(diào)return的值
this._resolveQueue = [] // 成功隊列, resolve時觸發(fā)
this._rejectQueue = [] // 失敗隊列, reject時觸發(fā)
// 由于resolve/reject是在executor內(nèi)部被調(diào)用, 因此需要使用箭頭函數(shù)固定this指向, 否則找不到this._resolveQueue
let _resolve = (val) => {
//把resolve執(zhí)行回調(diào)的操作封裝成一個函數(shù),放進setTimeout里,以兼容executor是同步代碼的情況
const run = () => {
if(this._status !== PENDING) return // 對應(yīng)規(guī)范中的"狀態(tài)只能由pending到fulfilled或rejected"
this._status = FULFILLED // 變更狀態(tài)
this._value = val // 儲存當(dāng)前value
// 這里之所以使用一個隊列來儲存回調(diào),是為了實現(xiàn)規(guī)范要求的 "then 方法可以被同一個 promise 調(diào)用多次"
// 如果使用一個變量而非隊列來儲存回調(diào),那么即使多次p1.then()也只會執(zhí)行一次回調(diào)
while(this._resolveQueue.length) {
const callback = this._resolveQueue.shift()
callback(val)
}
}
setTimeout(run)
}
// 實現(xiàn)同resolve
let _reject = (val) => {
const run = () => {
if(this._status !== PENDING) return // 對應(yīng)規(guī)范中的"狀態(tài)只能由pending到fulfilled或rejected"
this._status = REJECTED // 變更狀態(tài)
this._value = val // 儲存當(dāng)前value
while(this._rejectQueue.length) {
const callback = this._rejectQueue.shift()
callback(val)
}
}
setTimeout(run)
}
// new Promise()時立即執(zhí)行executor,并傳入resolve和reject
executor(_resolve, _reject)
}
// then方法,接收一個成功的回調(diào)和一個失敗的回調(diào)
then(resolveFn, rejectFn) {
// 根據(jù)規(guī)范刚盈,如果then的參數(shù)不是function,則我們需要忽略它, 讓鏈式調(diào)用繼續(xù)往下執(zhí)行
typeof resolveFn !== 'function' ? resolveFn = value => value : null
typeof rejectFn !== 'function' ? rejectFn = error => error : null
// return一個新的promise
return new Promise((resolve, reject) => {
// 把resolveFn重新包裝一下,再push進resolve執(zhí)行隊列,這是為了能夠獲取回調(diào)的返回值進行分類討論
const fulfilledFn = value => {
try {
// 執(zhí)行第一個(當(dāng)前的)Promise的成功回調(diào),并獲取返回值
let x = resolveFn(value)
// 分類討論返回值,如果是Promise,那么等待Promise狀態(tài)變更,否則直接resolve
x instanceof Promise ? x.then(resolve, reject) : resolve(x)
} catch (error) {
reject(error)
}
}
// reject同理
const rejectedFn = error => {
try {
let x = rejectFn(error)
x instanceof Promise ? x.then(resolve, reject) : resolve(x)
} catch (error) {
reject(error)
}
}
switch (this._status) {
// 當(dāng)狀態(tài)為pending時,把then回調(diào)push進resolve/reject執(zhí)行隊列,等待執(zhí)行
case PENDING:
this._resolveQueue.push(fulfilledFn)
this._rejectQueue.push(rejectedFn)
break;
// 當(dāng)狀態(tài)已經(jīng)變?yōu)閞esolve/reject時,直接執(zhí)行then回調(diào)
case FULFILLED:
fulfilledFn(this._value) // this._value是上一個then回調(diào)return的值(見完整版代碼)
break;
case REJECTED:
rejectedFn(this._value)
break;
}
})
}
//catch方法其實就是執(zhí)行一下then的第二個回調(diào)
catch(rejectFn) {
return this.then(undefined, rejectFn)
}
//finally方法
finally(callback) {
return this.then(
value => MyPromise.resolve(callback()).then(() => value), //執(zhí)行回調(diào),并returnvalue傳遞給后面的then
reason => MyPromise.resolve(callback()).then(() => { throw reason }) //reject同理
)
}
//靜態(tài)的resolve方法
static resolve(value) {
if(value instanceof MyPromise) return value //根據(jù)規(guī)范, 如果參數(shù)是Promise實例, 直接return這個實例
return new MyPromise(resolve => resolve(value))
}
//靜態(tài)的reject方法
static reject(reason) {
return new MyPromise((resolve, reject) => reject(reason))
}
//靜態(tài)的all方法
static all(promiseArr) {
let index = 0
let result = []
return new MyPromise((resolve, reject) => {
promiseArr.forEach((p, i) => {
//Promise.resolve(p)用于處理傳入值不為Promise的情況
MyPromise.resolve(p).then(
val => {
index++
result[i] = val
if(index === promiseArr.length) {
resolve(result)
}
},
err => {
reject(err)
}
)
})
})
}
//靜態(tài)的race方法
static race(promiseArr) {
return new MyPromise((resolve, reject) => {
//同時執(zhí)行Promise,如果有一個Promise的狀態(tài)發(fā)生改變,就變更新MyPromise的狀態(tài)
for (let p of promiseArr) {
Promise.resolve(p).then( //Promise.resolve(p)用于處理傳入值不為Promise的情況
value => {
resolve(value) //注意這個resolve是上邊new MyPromise的
},
err => {
reject(err)
}
)
}
})
}
}
洋洋灑灑150多行的代碼挂脑,到這里藕漱,我們終于可以給Promise的實現(xiàn)做一個結(jié)尾了。我們從一個最簡單的Promise使用實例開始崭闲,通過對調(diào)用流程的分析肋联,根據(jù)觀察者模式實現(xiàn)了Promise的大致骨架,然后依據(jù)Promise/A+規(guī)范填充代碼刁俭,重點實現(xiàn)了then 的鏈式調(diào)用橄仍,最后完成了Promise的靜態(tài)/實例方法。其實Promise實現(xiàn)在整體上并沒有太復(fù)雜的思想,但我們?nèi)粘J褂玫臅r候往往忽略了很多Promise細節(jié)侮繁,因而很難寫出一個符合規(guī)范的Promise實現(xiàn)虑粥,源碼的實現(xiàn)過程,其實也是對Promise使用細節(jié)重新學(xué)習(xí)的過程鼎天。
async/await實現(xiàn)
雖然前邊花了這么多篇幅講Promise的實現(xiàn)舀奶,不過探索async/await
暫停執(zhí)行的機制才是我們的初衷,下面我們就來進入這一塊的內(nèi)容斋射。同樣地育勺,開頭我們點一下async/await的使用意義。
在多個回調(diào)依賴的場景中罗岖,盡管Promise通過鏈式調(diào)用取代了回調(diào)嵌套涧至,但過多的鏈式調(diào)用可讀性仍然不佳,流程控制也不方便桑包,ES7 提出的async 函數(shù)南蓬,終于讓 JS 對于異步操作有了終極解決方案,簡潔優(yōu)美地解決了以上兩個問題哑了。
設(shè)想一個這樣的場景赘方,異步任務(wù)a->b->c之間存在依賴關(guān)系,如果我們通過then鏈式調(diào)用來處理這些關(guān)系弱左,可讀性并不是很好窄陡,如果我們想控制其中某個過程,比如在某些條件下拆火,b不往下執(zhí)行到c跳夭,那么也不是很方便控制
Promise.resolve(a)
.then(b => {
// do something
})
.then(c => {
// do something
})
但是如果通過async/await來實現(xiàn)這個場景,可讀性和流程控制都會方便不少们镜。
async () => {
const a = await Promise.resolve(a);
const b = await Promise.resolve(b);
const c = await Promise.resolve(c);
}
那么我們要如何實現(xiàn)一個async/await呢币叹,首先我們要知道,async/await實際上是對Generator(生成器)的封裝模狭,是一個語法糖颈抚。由于Generator出現(xiàn)不久就被async/await取代了,很多同學(xué)對Generator比較陌生嚼鹉,因此我們先來看看Generator的用法:
ES6 新引入了 Generator 函數(shù)邪意,可以通過 yield 關(guān)鍵字,把函數(shù)的執(zhí)行流掛起反砌,通過next()方法可以切換到下一個狀態(tài)雾鬼,為改變執(zhí)行流程提供了可能,從而為異步編程提供解決方案宴树。
function* myGenerator() {
yield '1'
yield '2'
return '3'
}
const gen = myGenerator(); // 獲取迭代器
gen.next() //{value: "1", done: false}
gen.next() //{value: "2", done: false}
gen.next() //{value: "3", done: true}
也可以通過給next()
傳參, 讓yield具有返回值
function* myGenerator() {
console.log(yield '1') //test1
console.log(yield '2') //test2
console.log(yield '3') //test3
}
// 獲取迭代器
const gen = myGenerator();
gen.next()
gen.next('test1')
gen.next('test2')
gen.next('test3')
我們看到Generator的用法策菜,應(yīng)該?會感到很熟悉,*/yield
和async/await
看起來其實已經(jīng)很相似了,它們都提供了暫停執(zhí)行的功能又憨,但二者又有三點不同:
-
async/await
自帶執(zhí)行器翠霍,不需要手動調(diào)用next()就能自動執(zhí)行下一步 -
async
函數(shù)返回值是Promise對象,而Generator返回的是生成器對象 -
await
能夠返回Promise的resolve/reject的值
我們對async/await的實現(xiàn)蠢莺,其實也就是對應(yīng)以上三點封裝Generator
1.自動執(zhí)行
我們先來看一下寒匙,對于這樣一個Generator,手動執(zhí)行是怎樣一個流程
function* myGenerator() {
yield Promise.resolve(1);
yield Promise.resolve(2);
yield Promise.resolve(3);
}
const gen = myGenerator()
gen.next().value.then(val => {
console.log(val)
gen.next().value.then(val => {
console.log(val)
gen.next().value.then(val => {
console.log(val)
})
})
})
//輸出1 2 3
我們也可以通過給gen.next()
傳值的方式躏将,讓yield能返回resolve的值
function* myGenerator() {
console.log(yield Promise.resolve(1)) //1
console.log(yield Promise.resolve(2)) //2
console.log(yield Promise.resolve(3)) //3
}
const gen = myGenerator()
gen.next().value.then(val => {
// console.log(val)
gen.next(val).value.then(val => {
// console.log(val)
gen.next(val).value.then(val => {
// console.log(val)
gen.next(val)
})
})
})
顯然锄弱,手動執(zhí)行的寫法看起來既笨拙又丑陋,我們希望生成器函數(shù)能自動往下執(zhí)行祸憋,且yield能返回resolve的值会宪,基于這兩個需求,我們進行一個基本的封裝蚯窥,這里async/await
是關(guān)鍵字掸鹅,不能重寫,我們用函數(shù)來模擬:
function run(gen) {
var g = gen() //由于每次gen()獲取到的都是最新的迭代器,因此獲取迭代器操作要放在step()之前,否則會進入死循環(huán)
function step(val) { //封裝一個方法, 遞歸執(zhí)行next()
var res = g.next(val) //獲取迭代器對象拦赠,并返回resolve的值
if(res.done) return res.value //遞歸終止條件
res.value.then(val => { //Promise的then方法是實現(xiàn)自動迭代的前提
step(val) //等待Promise完成就自動執(zhí)行下一個next巍沙,并傳入resolve的值
})
}
step() //第一次執(zhí)行
}
對于我們之前的例子,我們就能這樣執(zhí)行:
function* myGenerator() {
console.log(yield Promise.resolve(1)) //1
console.log(yield Promise.resolve(2)) //2
console.log(yield Promise.resolve(3)) //3
}
run(myGenerator)
這樣我們就初步實現(xiàn)了一個async/await
上邊的代碼只有五六行荷鼠,但并不是一下就能看明白的赎瞎,我們之前用了四個例子來做鋪墊,也是為了讓讀者更好地理解這段代碼颊咬。 簡單的說,我們封裝了一個run方法牡辽,run方法里我們把執(zhí)行下一步的操作封裝成step()喳篇,每次Promise.then()的時候都去執(zhí)行step(),實現(xiàn)自動迭代的效果态辛。在迭代的過程中麸澜,我們還把resolve的值傳入gen.next()
,使得yield得以返回Promise的resolve的值
這里插一句奏黑,是不是只有
.then方法
這樣的形式才能完成我們自動執(zhí)行的功能呢炊邦?答案是否定的,yield后邊除了接Promise熟史,還可以接thunk函數(shù)
馁害,thunk函數(shù)不是一個新東西,所謂thunk函數(shù)蹂匹,就是單參的只接受回調(diào)的函數(shù)碘菜,詳細介紹可以看阮一峰Thunk 函數(shù)的含義和用法,無論是Promise還是thunk函數(shù),其核心都是通過傳入回調(diào)的方式來實現(xiàn)Generator的自動執(zhí)行忍啸。thunk函數(shù)只作為一個拓展知識仰坦,理解有困難的同學(xué)也可以跳過這里,并不影響后續(xù)理解计雌。
2.返回Promise & 異常處理
雖然我們實現(xiàn)了Generator的自動執(zhí)行以及讓yield返回resolve的值悄晃,但上邊的代碼還存在著幾點問題:
-
需要兼容基本類型:這段代碼能自動執(zhí)行的前提是
yield
后面跟Promise,為了兼容后面跟著基本類型值的情況凿滤,我們需要把yield跟的內(nèi)容(gen().next.value
)都用Promise.resolve()
轉(zhuǎn)化一遍 -
缺少錯誤處理:上邊代碼里的Promise如果執(zhí)行失敗妈橄,就會導(dǎo)致后續(xù)執(zhí)行直接中斷,我們需要通過調(diào)用
Generator.prototype.throw()
鸭巴,把錯誤拋出來眷细,才能被外層的try-catch捕獲到 -
返回值是Promise:
async/await
的返回值是一個Promise,我們這里也需要保持一致鹃祖,給返回值包一個Promise
我們改造一下run方法:
function run(gen) {
//把返回值包裝成promise
return new Promise((resolve, reject) => {
var g = gen()
function step(val) {
//錯誤處理
try {
var res = g.next(val)
} catch(err) {
return reject(err);
}
if(res.done) {
return resolve(res.value);
}
//res.value包裝為promise溪椎,以兼容yield后面跟基本類型的情況
Promise.resolve(res.value).then(
val => {
step(val);
},
err => {
//拋出錯誤
g.throw(err)
});
}
step();
});
}
然后我們可以測試一下:
function* myGenerator() {
try {
console.log(yield Promise.resolve(1))
console.log(yield 2) //2
console.log(yield Promise.reject('error'))
} catch (error) {
console.log(error)
}
}
const result = run(myGenerator) //result是一個Promise
//輸出 1 2 error
到這里,一個async/await
的實現(xiàn)基本完成了恬口。最后我們可以看一下babel對async/await的轉(zhuǎn)換結(jié)果校读,其實整體的思路是一樣的,但是寫法稍有不同:
//相當(dāng)于我們的run()
function _asyncToGenerator(fn) {
return function() {
var self = this
var args = arguments
return new Promise(function(resolve, reject) {
var gen = fn.apply(self, args);
//相當(dāng)于我們的step()
function _next(value) {
asyncGeneratorStep(gen, resolve, reject, _next, _throw, 'next', value);
}
//處理異常
function _throw(err) {
asyncGeneratorStep(gen, resolve, reject, _next, _throw, 'throw', err);
}
_next(undefined);
});
};
}
function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
try {
var info = gen[key](arg);
var value = info.value;
} catch (error) {
reject(error);
return;
}
if (info.done) {
resolve(value);
} else {
Promise.resolve(value).then(_next, _throw);
}
}
使用方式:
const foo = _asyncToGenerator(function* () {
try {
console.log(yield Promise.resolve(1)) //1
console.log(yield 2) //2
return '3'
} catch (error) {
console.log(error)
}
})
foo().then(res => {
console.log(res) //3
})
有關(guān)async/await
的實現(xiàn)祖能,到這里告一段落歉秫。但是直到結(jié)尾,我們也不知道await到底是如何暫停執(zhí)行的养铸,有關(guān)await暫停執(zhí)行的秘密雁芙,我們還要到Generator的實現(xiàn)中去尋找答案
Generator實現(xiàn)
我們從一個簡單的例子開始,一步步探究Generator的實現(xiàn)原理:
function* foo() {
yield 'result1'
yield 'result2'
yield 'result3'
}
const gen = foo()
console.log(gen.next().value)
console.log(gen.next().value)
console.log(gen.next().value)
我們可以在babel官網(wǎng)上在線轉(zhuǎn)化這段代碼钞螟,看看ES5環(huán)境下是如何實現(xiàn)Generator的:
"use strict";
var _marked =
/*#__PURE__*/
regeneratorRuntime.mark(foo);
function foo() {
return regeneratorRuntime.wrap(function foo$(_context) {
while (1) {
switch (_context.prev = _context.next) {
case 0:
_context.next = 2;
return 'result1';
case 2:
_context.next = 4;
return 'result2';
case 4:
_context.next = 6;
return 'result3';
case 6:
case "end":
return _context.stop();
}
}
}, _marked);
}
var gen = foo();
console.log(gen.next().value);
console.log(gen.next().value);
console.log(gen.next().value);
代碼咋一看不長兔甘,但如果仔細觀察會發(fā)現(xiàn)有兩個不認識的東西 —— regeneratorRuntime.mark
和regeneratorRuntime.wrap
,這兩者其實是 regenerator-runtime 模塊里的兩個方法鳞滨,regenerator-runtime 模塊來自facebook的 regenerator 模塊洞焙,完整代碼在runtime.js,這個runtime有700多行...-_-||拯啦,因此我們不能全講澡匪,不太重要的部分我們就簡單地過一下,重點講解暫停執(zhí)行相關(guān)部分代碼
個人覺得啃源碼的效果不是很好褒链,建議讀者拉到末尾先看結(jié)論和簡略版實現(xiàn)唁情,源碼作為一個補充理解
regeneratorRuntime.mark()
regeneratorRuntime.mark(foo)
這個方法在第一行被調(diào)用,我們先看一下runtime里mark()方法的定義
//runtime.js里的定義稍有不同甫匹,多了一些判斷荠瘪,以下是編譯后的代碼
runtime.mark = function(genFun) {
genFun.__proto__ = GeneratorFunctionPrototype;
genFun.prototype = Object.create(Gp);
return genFun;
};
這里邊GeneratorFunctionPrototype
和Gp
我們都不認識夯巷,他們被定義在runtime里,不過沒關(guān)系哀墓,我們只要知道mark()方法
為生成器函數(shù)(foo)綁定了一系列原型就可以了趁餐,這里就簡單地過了
regeneratorRuntime.wrap()
從上面babel轉(zhuǎn)化的代碼我們能看到,執(zhí)行foo()
篮绰,其實就是執(zhí)行wrap()
后雷,那么這個方法起到什么作用呢,他想包裝一個什么東西呢吠各,我們先來看看wrap方法的定義:
//runtime.js里的定義稍有不同臀突,多了一些判斷,以下是編譯后的代碼
function wrap(innerFn, outerFn, self) {
var generator = Object.create(outerFn.prototype);
var context = new Context([]);
generator._invoke = makeInvokeMethod(innerFn, self, context);
return generator;
}
wrap方法先是創(chuàng)建了一個generator贾漏,并繼承outerFn.prototype
候学;然后new了一個context對象
;makeInvokeMethod方法
接收innerFn(對應(yīng)foo$)
纵散、context
和this
梳码,并把返回值掛到generator._invoke
上;最后return了generator伍掀。其實wrap()相當(dāng)于是給generator增加了一個_invoke方法
這段代碼肯定讓人產(chǎn)生很多疑問掰茶,outerFn.prototype是什么,Context又是什么蜜笤,makeInvokeMethod又做了哪些操作濒蒋。下面我們就來一一解答:
outerFn.prototype
其實就是genFun.prototype
,
這個我們結(jié)合一下上面的代碼就能知道
context
可以直接理解為這樣一個全局對象把兔,用于儲存各種狀態(tài)和上下文:
var ContinueSentinel = {};
var context = {
done: false,
method: "next",
next: 0,
prev: 0,
abrupt: function(type, arg) {
var record = {};
record.type = type;
record.arg = arg;
return this.complete(record);
},
complete: function(record, afterLoc) {
if (record.type === "return") {
this.rval = this.arg = record.arg;
this.method = "return";
this.next = "end";
}
return ContinueSentinel;
},
stop: function() {
this.done = true;
return this.rval;
}
};
makeInvokeMethod
的定義如下沪伙,它return了一個invoke方法
,invoke用于判斷當(dāng)前狀態(tài)和執(zhí)行下一步县好,其實就是我們調(diào)用的next()
//以下是編譯后的代碼
function makeInvokeMethod(innerFn, context) {
// 將狀態(tài)置為start
var state = "start";
return function invoke(method, arg) {
// 已完成
if (state === "completed") {
return { value: undefined, done: true };
}
context.method = method;
context.arg = arg;
// 執(zhí)行中
while (true) {
state = "executing";
var record = {
type: "normal",
arg: innerFn.call(self, context) // 執(zhí)行下一步,并獲取狀態(tài)(其實就是switch里邊return的值)
};
if (record.type === "normal") {
// 判斷是否已經(jīng)執(zhí)行完成
state = context.done ? "completed" : "yield";
// ContinueSentinel其實是一個空對象,record.arg === {}則跳過return進入下一個循環(huán)
// 什么時候record.arg會為空對象呢, 答案是沒有后續(xù)yield語句或已經(jīng)return的時候,也就是switch返回了空值的情況(跟著上面的switch走一下就知道了)
if (record.arg === ContinueSentinel) {
continue;
}
// next()的返回值
return {
value: record.arg,
done: context.done
};
}
}
};
}
為什么
generator._invoke
實際上就是gen.next
呢围橡,因為在runtime對于next()的定義中,next()其實就return了_invoke方法
// Helper for defining the .next, .throw, and .return methods of the
// Iterator interface in terms of a single ._invoke method.
function defineIteratorMethods(prototype) {
["next", "throw", "return"].forEach(function(method) {
prototype[method] = function(arg) {
return this._invoke(method, arg);
};
});
}
defineIteratorMethods(Gp);
低配實現(xiàn) & 調(diào)用流程分析
這么一遍源碼下來聘惦,估計很多讀者還是懵逼的,畢竟源碼中糾集了很多概念和封裝儒恋,一時半會不好完全理解善绎,讓我們跳出源碼,實現(xiàn)一個簡單的Generator诫尽,然后再回過頭看源碼禀酱,會得到更清晰的認識
// 生成器函數(shù)根據(jù)yield語句將代碼分割為switch-case塊,后續(xù)通過切換_context.prev和_context.next來分別執(zhí)行各個case
function gen$(_context) {
while (1) {
switch (_context.prev = _context.next) {
case 0:
_context.next = 2;
return 'result1';
case 2:
_context.next = 4;
return 'result2';
case 4:
_context.next = 6;
return 'result3';
case 6:
case "end":
return _context.stop();
}
}
}
// 低配版context
var context = {
next:0,
prev: 0,
done: false,
stop: function stop () {
this.done = true
}
}
// 低配版invoke
let gen = function() {
return {
next: function() {
value = context.done ? undefined: gen$(context)
done = context.done
return {
value,
done
}
}
}
}
// 測試使用
var g = gen()
g.next() // {value: "result1", done: false}
g.next() // {value: "result2", done: false}
g.next() // {value: "result3", done: false}
g.next() // {value: undefined, done: true}
這段代碼并不難理解牧嫉,我們分析一下調(diào)用流程:
- 我們定義的
function*
生成器函數(shù)被轉(zhuǎn)化為以上代碼 - 轉(zhuǎn)化后的代碼分為三大塊:
-
gen$(_context)
由yield分割生成器函數(shù)代碼而來 -
context對象
用于儲存函數(shù)執(zhí)行上下文 -
invoke()方法
定義next()剂跟,用于執(zhí)行g(shù)en$(_context)來跳到下一步
-
- 當(dāng)我們調(diào)用
g.next()
减途,就相當(dāng)于調(diào)用invoke()方法
,執(zhí)行gen$(_context)
曹洽,進入switch語句鳍置,switch根據(jù)context的標識,執(zhí)行對應(yīng)的case塊送淆,return對應(yīng)結(jié)果 - 當(dāng)生成器函數(shù)運行到末尾(沒有下一個yield或已經(jīng)return)税产,switch匹配不到對應(yīng)代碼塊,就會return空值偷崩,這時
g.next()
返回{value: undefined, done: true}
從中我們可以看出辟拷,Generator實現(xiàn)的核心在于上下文的保存
,函數(shù)并沒有真的被掛起阐斜,每一次yield衫冻,其實都執(zhí)行了一遍傳入的生成器函數(shù),只是在這個過程中間用了一個context對象儲存上下文谒出,使得每次執(zhí)行生成器函數(shù)的時候隅俘,都可以從上一個執(zhí)行結(jié)果開始執(zhí)行,看起來就像函數(shù)被掛起了一樣
總結(jié) & 致謝
有關(guān)Promise到推、async/await考赛、Generator的原理就實現(xiàn)到這里了,感謝大家能夠跟我一起走完全程莉测,不知不覺颜骤,我們花了近9千字來講述有關(guān)異步編程的故事,異步編程的世界環(huán)環(huán)相扣捣卤,一開始忍抽,筆者只是出于對await掛起機制的好奇,后來董朝,從一個 "await是如何實現(xiàn)暫停執(zhí)行" 的小問題鸠项,引出了對異步編程的一系列思考和實現(xiàn)原理。三者的實現(xiàn)子姜,其實也是前端異步編程一步步演化推進的過程祟绊。
成文過程中得到很多大佬的幫助,這四篇參考文章都是我閱讀了很多相關(guān)文章后精選的四篇哥捕,建議大家結(jié)合閱讀牧抽,大佬們寫的比我好很多,另外感謝冴羽大佬在Generator機制上給予的解惑~
前端技匠:各種源碼實現(xiàn)遥赚,你想要的這里都有
神三元:我如何實現(xiàn)Promise
winty:async/await 原理及執(zhí)行順序分析
冴羽:ES6 系列之 Babel 將 Generator 編譯成了什么樣子
最后卑微求個贊Thanks?(?ω?)?
往期文章