promiseA+規範及實現
Promise表示一個非同步操作的最終結果。與Promise最主要的互動方法是通過將函式傳入它的then方法從而獲取得Promise最終的值或Promise最終被拒絕(reject)的原因。
1.術語
promise
是一個包含了相容promise規範then方法的物件或函式,
thenable
是一個包含了then方法的物件或函式。
value
是任何Javascript值。 (包括 undefined, thenable, promise等)。
exception
是由throw表示式丟擲來的值。
reason
是一個用於描述Promise被拒絕原因的值。
2.要求
2.1 Promise狀態
一個Promise必須處在其中之一的狀態:pending, fulfilled 或 rejected.
- 如果是pending狀態,則promise:
1.可以轉換到fulfilled或rejected狀態。 - 如果是fulfilled狀態,則promise:
- 不能轉換成任何其它狀態。
- 必須有一個值,且這個值不能被改變。
- 如果是rejected狀態,則promise可以:
- 不能轉換成任何其它狀態。
- 必須有一個原因,且這個值不能被改變。
2.2 then
方法
一個Promise必須提供一個then方法來獲取其值或原因。
Promise的then方法接受兩個引數:
promise.then(onFulfilled,onRejected)
onFulfilled
和onRejected
都是可選引數,如果onFulfilled
或者onRejected
不是一個函式,則忽略。- 如果
onFulfilled
是一個函式:1.它必須在promise
fulfilled後呼叫,且promise
的value為其第一個引數。2.它不能被多次呼叫 - 如果
onRejected
是一個函式:1.它必須在promise
rejected後呼叫, 且promise
的reason為其第一個引數。2.不能被多次呼叫。 - 都只允許在ececution context棧僅包含平臺程式碼時執行
- 都必須當做函式呼叫
- 對於一個
promise
,它的then方法可以呼叫多次。所有的onFulfilled
或者onRejected
都必須按照其註冊順序執行。 then
必須返回一個promise
1.什麼是Promise?
Promise是JS非同步程式設計中的重要概念,非同步抽象處理物件,是目前比較流行Javascript非同步程式設計解決方案之一
2.對於幾種常見非同步程式設計方案
- 回撥函式
- 事件監聽
- 釋出/訂閱
- Promise物件
這裡就拿回調函式說說
1.對於回撥函式 我們用Jquery的ajax獲取資料時 都是以回撥函式方式獲取的資料
$.get(url, (data) => {
console.log(data)
)
2.如果說 當我們需要傳送多個非同步請求 並且每個請求之間需要相互依賴 那這時 我們只能 以巢狀方式來解決 形成 "回撥地獄"
$.get(url, data1 => {
console.log(data1)
$.get(data1.url, data2 => {
console.log(data1)
})
})
這樣一來,在處理越多的非同步邏輯時,就需要越深的回撥巢狀,這種編碼模式的問題主要有以下幾個:
- 程式碼邏輯書寫順序與執行順序不一致,不利於閱讀與維護。
- 非同步操作的順序變更時,需要大規模的程式碼重構。
- 回撥函式基本都是匿名函式,bug 追蹤困難。
- 回撥函式是被第三方庫程式碼(如上例中的 ajax )而非自己的業務程式碼所呼叫的,造成了 IoC 控制反轉。
Promise 處理多個相互關聯的非同步請求
1.而我們Promise 可以更直觀的方式 來解決 "回撥地獄"
const request = url => {
return new Promise((resolve, reject) => {
$.get(url, data => {
resolve(data)
});
})
};
// 請求data1
request(url).then(data1 => {
return request(data1.url);
}).then(data2 => {
return request(data2.url);
}).then(data3 => {
console.log(data3);
}).catch(err => throw new Error(err));
2.相信大家在 vue/react 都是用axios fetch 請求資料 也都支援 Promise API
import axios from 'axios';
axios.get(url).then(data => {
console.log(data)
})
Axios 是一個基於 promise 的 HTTP 庫,可以用在瀏覽器和 node.js 中。
3.Promise使用
1.Promise 是一個建構函式, new Promise 返回一個 promise物件 接收一個excutor執行函式作為引數, excutor有兩個函式型別形參resolve reject
const promise = new Promise((resolve, reject) => {
// 非同步處理
// 處理結束後、呼叫resolve 或 reject
});
2.promise相當於一個狀態機
promise的三種狀態
- pending
- fulfilled
- rejected
1.promise 物件初始化狀態為 pending
2.當呼叫resolve(成功),會由pending => fulfilled
3.當呼叫reject(失敗),會由pending => rejected
注意promsie狀態 只能由 pending => fulfilled/rejected, 一旦修改就不能再變
3.promise物件方法
1.then方法註冊 當resolve(成功)/reject(失敗)的回撥函式
// onFulfilled 是用來接收promise成功的值
// onRejected 是用來接收promise失敗的原因
promise.then(onFulfilled, onRejected);
then方法是非同步執行的
2.resolve(成功) onFulfilled會被呼叫
const promise = new Promise((resolve, reject) => {
resolve('fulfilled'); // 狀態由 pending => fulfilled
});
promise.then(result => { // onFulfilled
console.log(result); // 'fulfilled'
}, reason => { // onRejected 不會被呼叫
})
3.reject(失敗) onRejected會被呼叫
const promise = new Promise((resolve, reject) => {
reject('rejected'); // 狀態由 pending => rejected
});
promise.then(result => { // onFulfilled 不會被呼叫
}, reason => { // onRejected
console.log(rejected); // ‘rejected’
})
4.promise.catch
在鏈式寫法中可以捕獲前面then中傳送的異常,
promise.catch(onRejected)
相當於
promise.then(null, onRrejected);
// 注意
// onRejected 不能捕獲當前onFulfilled中的異常
promise.then(onFulfilled, onRrejected);
// 可以寫成:
promise.then(onFulfilled)
.catch(onRrejected);
4.promise chain
promise.then方法每次呼叫 都返回一個新的promise物件 所以可以鏈式寫法
function taskA() {
console.log("Task A");
}
function taskB() {
console.log("Task B");
}
function onRejected(error) {
console.log("Catch Error: A or B", error);
}
var promise = Promise.resolve();
promise
.then(taskA)
.then(taskB)
.catch(onRejected) // 捕獲前面then方法中的異常
5.Promise的靜態方法
1.Promise.resolve 返回一個fulfilled狀態的promise物件
Promise.resolve('hello').then(function(value){
console.log(value);
});
Promise.resolve(‘hello’);
// 相當於
const promise = new Promise(resolve => {
resolve(‘hello’);
});
2.Promise.reject 返回一個rejected狀態的promise物件
Promise.reject(24);
new Promise((resolve, reject) => {
reject(24);
});
3.Promise.all 接收一個promise物件陣列為引數
只有全部為resolve才會呼叫 通常會用來處理 多個並行非同步操作
const p1 = new Promise((resolve, reject) => {
resolve(1);
});
const p2 = new Promise((resolve, reject) => {
resolve(2);
});
const p3 = new Promise((resolve, reject) => {
reject(3);
});
Promise.all([p1, p2, p3]).then(data => {
console.log(data); // [1, 2, 3] 結果順序和promise例項陣列順序是一致的
}, err => {
console.log(err);
});
4.Promise.race 接收一個promise物件陣列為引數
Promise.race 只要有一個promise物件進入 FulFilled 或者 Rejected 狀態的話,就會繼續進行後面的處理。
function timerPromisefy(delay) {
return new Promise(function (resolve, reject) {
setTimeout(function () {
resolve(delay);
}, delay);
});
}
var startDate = Date.now();
Promise.race([
timerPromisefy(10),
timerPromisefy(20),
timerPromisefy(30)
]).then(function (values) {
console.log(values); // 10
});
4. Promise 程式碼實現
/**
* Promise 實現 遵循promise/A+規範
* Promise/A+規範譯文:
* https://malcolmyu.github.io/2015/06/12/Promises-A-Plus/#note-4
*/
// promise 三個狀態
const PENDING = “pending”;
const FULFILLED = “fulfilled”;
const REJECTED = “rejected”;
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);
}
}
/**
- resolve中的值幾種情況:
- 1.普通值
- 2.promise物件
- 3.thenable物件/函式
*/
/**
-
對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 {
resolve(x);
}
}
/**
-
[註冊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);
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);
}
});
});
}
};
/**
- Promise.all Promise進行並行處理
- 引數: promise物件組成的陣列作為引數
- 返回值: 返回一個Promise例項
- 當這個數組裡的所有promise物件全部變為resolve狀態的時候,才會resolve。
*/
Promise.all = function(promises) {
return new Promise((resolve, reject) => {
let done = gen(promises.length, resolve);
promises.forEach((promise, index) => {
promise.then((value) => {
done(index, value)
}, reject)
})
})
}
function gen(length, resolve) {
let count = 0;
let values = [];
return function(i, value) {
values[i] = value;
if (++count === length) {
console.log(values);
resolve(values);
}
}
}
/**
- Promise.race
- 引數: 接收 promise物件組成的陣列作為引數
- 返回值: 返回一個Promise例項
- 只要有一個promise物件進入 FulFilled 或者 Rejected 狀態的話,就會繼續進行後面的處理(取決於哪一個更快)
*/
Promise.race = function(promises) {
return new Promise((resolve, reject) => {
promises.forEach((promise, index) => {
promise.then(resolve, reject);
});
});
}
// 用於promise方法鏈時 捕獲前面onFulfilled/onRejected丟擲的異常
Promise.prototype.catch = function(onRejected) {
return this.then(null, onRejected);
}
Promise.resolve = function (value) {
return new Promise(resolve => {
resolve(value);
});
}
Promise.reject = function (reason) {
return new Promise((resolve, reject) => {
reject(reason);
});
}
/**
- 基於Promise實現Deferred的
- Deferred和Promise的關係
-
- Deferred 擁有 Promise
-
- Deferred 具備對 Promise的狀態進行操作的特權方法(resolve reject)
*參考jQuery.Deferred
*url: http://api.jquery.com/category/deferred-object/
*/
Promise.deferred = function() { // 延遲物件
let defer = {};
defer.promise = new Promise((resolve, reject) => {
defer.resolve = resolve;
defer.reject = reject;
});
return defer;
}
/**
- Promise/A+規範測試
- npm i -g promises-aplus-tests
- promises-aplus-tests Promise.js
*/
try {
module.exports = Promise
} catch (e) {
}