對Promise原始碼的理解

阿新 • • 發佈：2019-02-20

前言

Promise作為一種非同步處理的解決方案，以同步的寫作方式來處理非同步程式碼。本文只涉及Promise函式和then方法，對其他方法(如catch,finally,race等)暫不研究。首先，看下Promise的使用場景。

使用場景

例1 普通使用

new Promise((resolve, reject) => {
    console.log(1);
    resolve(2);
    console.log(3);
    }).then(result => {
         console.log(result);
    }).then(data => {
         console.log(data);
    });

// =>  1
// =>  3
// =>  2
// =>  undefined

建構函式Promise接受一個函式引數exactor，這個函式裡有兩個函式引數(resolve和reject)，在例項化之後,立即執行這個exactor，需要注意的是,exactor裡面除了resolve和reject函式都是非同步執行的,其他都是同步執行。

通過它的then方法【註冊】promise非同步操作成功時執行的回撥，意思就是resolve傳入的資料會傳遞給then中回撥函式中的引數。可以理解為，先把then中回撥函式註冊到某個數組裡，等執resolve時候，再執行這個陣列中的回撥函式。如果then中的回撥函式沒有返回值，那麼下個then中回撥函式的引數為undefined。 then方法註冊回撥函式，也可以理解為【釋出訂閱模式】。

例2 Promise與原生ajax結合使用

function getUrl(url) {
    return new Promise((resolve, reject) => {
        let xhr = new XMLHttpRequest()
        xhr.open('GET', url, true);
        xhr.onload = function () {
          if (/^2\d{2}$/.test(this.status) || this.status === 304 ) {
               resolve(this.responseText, this)
          } else {
               let reason = {
                    code: this.status,
                    response: this.response
               };
               reject(reason, this);
          }
        };
        xhr.send(null);
    });
}

getUrl('./a.text')
.then(data => {console.log(data)});

例3 Promise與$.ajax()結合使用

var getData=function(url) {
    return new Promise((resolve, reject) => {
      $.ajax({ 
          type:'get', 
          url:url, 
          success:function(data){ 
              resolve(data);
          }, 
          error:function(err){ 
              reject(err);
          } 
        });
    });
}
getData('./a.txt')
.then(data => {
    console.log(data);
});

Promise原始碼分析

首先看一下Promise函式的原始碼

function Promise(excutor) {
    let that = this; // 快取當前promise例項物件
    that.status = PENDING; // 初始狀態
    that.value = undefined; // fulfilled狀態時 返回的資訊
    that.reason = undefined; // rejected狀態時 拒絕的原因
    that.onFulfilledCallbacks = []; // 儲存fulfilled狀態對應的onFulfilled函式
    that.onRejectedCallbacks = []; // 儲存rejected狀態對應的onRejected函式

    function resolve(value) { // value成功態時接收的終值
        if(value instanceof Promise) {
            return value.then(resolve, reject);
        }

        // 為什麼resolve 加setTimeout?
        // 2.2.4規範 onFulfilled 和 onRejected 只允許在 execution context 棧僅包含平臺程式碼時執行.
        // 注1 這裡的平臺程式碼指的是引擎、環境以及 promise 的實施程式碼。實踐中要確保 onFulfilled 和 onRejected 方法非同步執行，且應該在 then 方法被呼叫的那一輪事件迴圈之後的新執行棧中執行。

        setTimeout(() => {
            // 呼叫resolve 回撥對應onFulfilled函式
            if (that.status === PENDING) {
                // 只能由pedning狀態 => fulfilled狀態 (避免呼叫多次resolve reject)
                that.status = FULFILLED;
                that.value = value;
                that.onFulfilledCallbacks.forEach(cb => cb(that.value));
            }
        });
    }

    function reject(reason) { // reason失敗態時接收的拒因
        setTimeout(() => {
            // 呼叫reject 回撥對應onRejected函式
            if (that.status === PENDING) {
                // 只能由pedning狀態 => rejected狀態 (避免呼叫多次resolve reject)
                that.status = REJECTED;
                that.reason = reason;
                that.onRejectedCallbacks.forEach(cb => cb(that.reason));
            }
        });
    }

    // 捕獲在excutor執行器中丟擲的異常
    // new Promise((resolve, reject) => {
    //     throw new Error('error in excutor')
    // })
    try {
        excutor(resolve, reject);
    } catch (e) {
        reject(e);
    }
}

根據上面程式碼，Promise相當於一個狀態機，一共有三種狀態，分別是 pending(等待),fulfilled(成功)，rejected(失敗)。

that.onFulfilledCallbacks這個陣列就是儲存then方法中的回撥函式。執行reject函式為什麼是非同步的，就是因為裡面有setTimeout這個函式。當reject執行的時候，裡面的 pending狀態->fulfilled狀態，改變之後無法再次改變狀態了。

然後執行onFulfilledCallbacks裡面通過then註冊的回撥函式。因為resolve執行的時候是非同步的，所以還沒執行resolve裡面具體的程式碼時候，已經通過then方法，把then中回撥函式給註冊到了
onFulfilledCallbacks中，所以才能夠執行onFulfilledCallbacks裡面的回撥函式。

我們看下then又是如何註冊回撥函式的

/**
 * [註冊fulfilled狀態/rejected狀態對應的回撥函式]
 * @param  {function} onFulfilled fulfilled狀態時 執行的函式
 * @param  {function} onRejected  rejected狀態時 執行的函式
 * @return {function} newPromsie  返回一個新的promise物件
 */
Promise.prototype.then = function(onFulfilled, onRejected) {
    const that = this;
    let newPromise;
    // 處理引數預設值 保證引數後續能夠繼續執行
    onFulfilled =
        typeof onFulfilled === "function" ? onFulfilled : value => value;
    onRejected =
        typeof onRejected === "function" ? onRejected : reason => {
            throw reason;
        };

    // then裡面的FULFILLED/REJECTED狀態時 為什麼要加setTimeout ?
    // 原因:
    // 其一 2.2.4規範 要確保 onFulfilled 和 onRejected 方法非同步執行(且應該在 then 方法被呼叫的那一輪事件迴圈之後的新執行棧中執行) 所以要在resolve里加上setTimeout
    // 其二 2.2.6規範 對於一個promise，它的then方法可以呼叫多次.（當在其他程式中多次呼叫同一個promise的then時 由於之前狀態已經為FULFILLED/REJECTED狀態，則會走的下面邏輯),所以要確保為FULFILLED/REJECTED狀態後 也要非同步執行onFulfilled/onRejected

    // 其二 2.2.6規範 也是resolve函式里加setTimeout的原因
    // 總之都是 讓then方法非同步執行 也就是確保onFulfilled/onRejected非同步執行

    // 如下面這種情景 多次呼叫p1.then
    // p1.then((value) => { // 此時p1.status 由pedding狀態 => fulfilled狀態
    //     console.log(value); // resolve
    //     // console.log(p1.status); // fulfilled
    //     p1.then(value => { // 再次p1.then 這時已經為fulfilled狀態 走的是fulfilled狀態判斷裡的邏輯 所以我們也要確保判斷裡面onFuilled非同步執行
    //         console.log(value); // 'resolve'
    //     });
    //     console.log('當前執行棧中同步程式碼');
    // })
    // console.log('全域性執行棧中同步程式碼');
    //

    if (that.status === FULFILLED) { // 成功態
        return newPromise = new Promise((resolve, reject) => {
            setTimeout(() => {
                try{
                    let x = onFulfilled(that.value);
                    resolvePromise(newPromise, x, resolve, reject); // 新的promise resolve 上一個onFulfilled的返回值
                } catch(e) {
                    reject(e); // 捕獲前面onFulfilled中丟擲的異常 then(onFulfilled, onRejected);
                }
            });
        })
    }

    if (that.status === REJECTED) { // 失敗態
        return newPromise = new Promise((resolve, reject) => {
            setTimeout(() => {
                try {
                    let x = onRejected(that.reason);
                    resolvePromise(newPromise, x, resolve, reject);
                } catch(e) {
                    reject(e);
                }
            });
        });
    }

    if (that.status === PENDING) { // 等待態
        // 當非同步呼叫resolve/rejected時 將onFulfilled/onRejected收集暫存到集合中
        return newPromise = new Promise((resolve, reject) => {
            that.onFulfilledCallbacks.push((value) => {
                try {
                    //  回撥函式
                    let x = onFulfilled(value);
                    // resolve,reject都是newPromise物件下的方法
                    // x為返回值
                    resolvePromise(newPromise, x, resolve, reject);
                } catch(e) {
                    reject(e);
                }
            });
            that.onRejectedCallbacks.push((reason) => {
                try {
                    let x = onRejected(reason);
                    resolvePromise(newPromise, x, resolve, reject);
                } catch(e) {
                    reject(e);
                }
            });
        });
    }
};

正如之前所說的，先執行then方法註冊回撥函式，然後執行resolve裡面程式碼(pending->fulfilled)，此時執行then時候that.status為pending。

在分析that.status之前，先看下判斷onFulfilled的作用

onFulfilled =typeof onFulfilled === "function" ? onFulfilled : value => value;

如果then中並沒有回撥函式的話，自定義個返回引數的函式。相當於下面這種

new Promise((resolve, reject) => {
    resolve('haha');
})
.then()
.then(data => console.log(data)) // haha

即使第一個then沒有回撥函式，但是通過自定義的回撥函式，依然把最開始的資料傳遞到了最後。

回過頭我們看下then中that.pending 判斷語句，發現真的通過onRejectedCallbacks 陣列註冊了回撥函式。

總結下then的特點：

當status為pending時候，把then中回撥函式註冊到前一個Promise物件中的onFulfilledCallbacks
返回一個新的Promise例項物件

整個resolve過程如下所示：

在上圖第5步時候，then中的回撥函式就可以使用resolve中傳入的資料了。那麼又把回撥函式的
返回值放到resolvePromise裡面幹嘛，這是為了鏈式呼叫。
我們看下resolvePromise函式

/**
 * 對resolve 進行改造增強 針對resolve中不同值情況 進行處理
 * @param  {promise} promise2 promise1.then方法返回的新的promise物件
 * @param  {[type]} x         promise1中onFulfilled的返回值
 * @param  {[type]} resolve   promise2的resolve方法
 * @param  {[type]} reject    promise2的reject方法
 */
function resolvePromise(promise2, x, resolve, reject) {
    if (promise2 === x) {  // 如果從onFulfilled中返回的x 就是promise2 就會導致迴圈引用報錯
        return reject(new TypeError('迴圈引用'));
    }

    let called = false; // 避免多次呼叫
    // 如果x是一個promise物件 （該判斷和下面 判斷是不是thenable物件重複 所以可有可無）
    if (x instanceof Promise) { // 獲得它的終值 繼續resolve
        if (x.status === PENDING) { // 如果為等待態需等待直至 x 被執行或拒絕 並解析y值
            x.then(y => {
                resolvePromise(promise2, y, resolve, reject);
            }, reason => {
                reject(reason);
            });
        } else { // 如果 x 已經處於執行態/拒絕態(值已經被解析為普通值)，用相同的值執行傳遞下去 promise
            x.then(resolve, reject);
        }
        // 如果 x 為物件或者函式
    } else if (x != null && ((typeof x === 'object') || (typeof x === 'function'))) {
        try { // 是否是thenable物件（具有then方法的物件/函式）
            let then = x.then;
            if (typeof then === 'function') {
                then.call(x, y => {
                    if(called) return;
                    called = true;
                    resolvePromise(promise2, y, resolve, reject);
                }, reason => {
                    if(called) return;
                    called = true;
                    reject(reason);
                })
            } else { // 說明是一個普通物件/函式
                resolve(x);
            }
        } catch(e) {
            if(called) return;
            called = true;
            reject(e);
        }
    } else {
        // 基本型別的值(string,number等)
        resolve(x);
    }
}

總結下要處理的返回值的型別：

1. Promise2本身 (暫時沒想通)
2. Promise物件例項
3. 含有then方法的函式或者物件
4. 普通值(string,number等)

自己觀察上面的程式碼，我們發現不管返回值是 Promise例項，還是基本型別的值，最終都要用Promise2的resolve(返回值)來處理，然後把Promise2的resolve(返回值)中的返回值傳遞給Promise2的then中的回撥函式，這樣下去就實現了鏈式操作。

如果還不懂看下面的程式碼：


var obj=new Promise((resolve, reject) => {
    resolve({name:'李四'});
});
obj.then(data=>{
    data.sex='男';
    return new Promise((resolve, reject) => {
                resolve(data);
            });
}).then(data => {
   console.log(data); // {name: "李四", sex: "男"}
});

總之，呼叫Promise2中的resolve方法，就會把資料傳遞給Promise2中的then中回撥函式。

resolve中的值幾種情況：

1.普通值
2.promise物件
3.thenable物件/函式

如果resolve(promise物件)，如何處理？

if(value instanceof Promise) {
     return value.then(resolve, reject);
}

跟我們剛才處理的返回值是Promise例項物件一樣，最終要把resolve裡面資料轉為物件或者函式或者基本型別的值

注意：then中回撥函式必須要有返回值

var obj=new Promise((resolve, reject) => {
    resolve({name:'張三'});
});
obj.then(data=>{
   console.log(data) // {name:'李四'}
   // 必須要有返回值
}).then(data => {
    console.log(data); // undefined
});

如果then中回撥函式沒有返回值，那麼下一個then中回撥函式的值不存在。

總結一下：

then方法把then中回撥函式註冊給上一個Promise物件中的onFulfilledCallbacks陣列中，並交由上一個Promise物件處理。
then方法返回一個新的Promise例項物件
resolve(data)或者resolvePromise(promise2, data, resolve, reject) 中的data值
最終為基本型別或者函式或者物件中的某一種

對Promise原始碼的理解

前言

使用場景

Promise原始碼分析

對Promise原始碼的理解

對promise的理解

「每日一題」面試官問你對Promise的理解？可能是需要你能手動實現各個特性

對Promise的一些理解

muduo原始碼分析--我對muduo的理解

這一次，徹底理解Promise原始碼思想

對yield 的理解

每天一個JS 小demo之韓雪冬輪播圖。主要知識點：html，css布局，對於數組和對象的理解和運用

談談你對Hibernate的理解

對ES6的理解

java序列化對象簡單理解

java中面向對象的理解

python 淺析對return的理解

對UWP的理解

面試:談談你對jQuery的理解

通過C語言HelloWord程序對計算系統理解

對面向對象的理解(新手而已參考之用)

Spring對IOC的理解

C#面向對象簡單理解

面向對象的理解

對Promise原始碼的理解

前言

使用場景

Promise原始碼分析

相關推薦