js Promise與async函式
Promise 物件
- Promise 的含義
- 基本用法
- Promise.prototype.then()
- Promise.prototype.catch()
- Promise.prototype.finally()
- Promise.all()
- Promise.race()
- Promise.resolve()
- Promise.reject()
- 應用
- Promise.try()
Promise 的含義
Promise 是非同步程式設計的一種解決方案,比傳統的解決方案——回撥函式和事件——更合理和更強大。它由社群最早提出和實現,ES6 將其寫進了語言標準,統一了用法,原生提供了Promise
所謂Promise
,簡單說就是一個容器,裡面儲存著某個未來才會結束的事件(通常是一個非同步操作)的結果。從語法上說,Promise 是一個物件,從它可以獲取非同步操作的訊息。Promise 提供統一的 API,各種非同步操作都可以用同樣的方法進行處理。
Promise
物件有以下兩個特點。
(1)物件的狀態不受外界影響。Promise
物件代表一個非同步操作,有三種狀態:pending
(進行中)、fulfilled
(已成功)和rejected
(已失敗)。只有非同步操作的結果,可以決定當前是哪一種狀態,任何其他操作都無法改變這個狀態。這也是Promise
這個名字的由來,它的英語意思就是“承諾”,表示其他手段無法改變。
(2)一旦狀態改變,就不會再變,任何時候都可以得到這個結果。Promise
物件的狀態改變,只有兩種可能:從pending
變為fulfilled
和從pending
變為rejected
。只要這兩種情況發生,狀態就凝固了,不會再變了,會一直保持這個結果,這時就稱為 resolved(已定型)。如果改變已經發生了,你再對Promise
物件添加回調函式,也會立即得到這個結果。這與事件(Event)完全不同,事件的特點是,如果你錯過了它,再去監聽,是得不到結果的。
注意,為了行文方便,本章後面的resolved
統一隻指fulfilled
狀態,不包含rejected
狀態。
有了Promise
物件,就可以將非同步操作以同步操作的流程表達出來,避免了層層巢狀的回撥函式。此外,Promise
Promise
也有一些缺點。首先,無法取消Promise
,一旦新建它就會立即執行,無法中途取消。其次,如果不設定回撥函式,Promise
內部丟擲的錯誤,不會反應到外部。第三,當處於pending
狀態時,無法得知目前進展到哪一個階段(剛剛開始還是即將完成)。
如果某些事件不斷地反覆發生,一般來說,使用 Stream 模式是比部署Promise
更好的選擇。
基本用法
ES6 規定,Promise
物件是一個建構函式,用來生成Promise
例項。
下面程式碼創造了一個Promise
例項。
const promise = new Promise(function(resolve, reject) {
// ... some code
if (/* 非同步操作成功 */){
resolve(value);
} else {
reject(error);
}
});
Promise
建構函式接受一個函式作為引數,該函式的兩個引數分別是resolve
和reject
。它們是兩個函式,由 JavaScript 引擎提供,不用自己部署。
resolve
函式的作用是,將Promise
物件的狀態從“未完成”變為“成功”(即從 pending 變為 resolved),在非同步操作成功時呼叫,並將非同步操作的結果,作為引數傳遞出去;reject
函式的作用是,將Promise
物件的狀態從“未完成”變為“失敗”(即從 pending 變為 rejected),在非同步操作失敗時呼叫,並將非同步操作報出的錯誤,作為引數傳遞出去。
Promise
例項生成以後,可以用then
方法分別指定resolved
狀態和rejected
狀態的回撥函式。
promise.then(function(value) {
// success
}, function(error) {
// failure
});
then
方法可以接受兩個回撥函式作為引數。第一個回撥函式是Promise
物件的狀態變為resolved
時呼叫,第二個回撥函式是Promise
物件的狀態變為rejected
時呼叫。其中,第二個函式是可選的,不一定要提供。這兩個函式都接受Promise
物件傳出的值作為引數。
下面是一個Promise
物件的簡單例子。
function timeout(ms) {
return new Promise((resolve, reject) => {
setTimeout(resolve, ms, 'done');
});
}
timeout(100).then((value) => {
console.log(value);
});
上面程式碼中,timeout
方法返回一個Promise
例項,表示一段時間以後才會發生的結果。過了指定的時間(ms
引數)以後,Promise
例項的狀態變為resolved
,就會觸發then
方法繫結的回撥函式。
Promise 新建後就會立即執行。
let promise = new Promise(function(resolve, reject) {
console.log('Promise');
resolve();
});
promise.then(function() {
console.log('resolved.');
});
console.log('Hi!');
// Promise
// Hi!
// resolved
上面程式碼中,Promise 新建後立即執行,所以首先輸出的是Promise
。然後,then
方法指定的回撥函式,將在當前指令碼所有同步任務執行完才會執行,所以resolved
最後輸出。
下面是非同步載入圖片的例子。
function loadImageAsync(url) {
return new Promise(function(resolve, reject) {
const image = new Image();
image.onload = function() {
resolve(image);
};
image.onerror = function() {
reject(new Error('Could not load image at ' + url));
};
image.src = url;
});
}
上面程式碼中,使用Promise
包裝了一個圖片載入的非同步操作。如果載入成功,就呼叫resolve
方法,否則就呼叫reject
方法。
下面是一個用Promise
物件實現的 Ajax 操作的例子。
const getJSON = function(url) {
const promise = new Promise(function(resolve, reject){
const handler = function() {
if (this.readyState !== 4) {
return;
}
if (this.status === 200) {
resolve(this.response);
} else {
reject(new Error(this.statusText));
}
};
const client = new XMLHttpRequest();
client.open("GET", url);
client.onreadystatechange = handler;
client.responseType = "json";
client.setRequestHeader("Accept", "application/json");
client.send();
});
return promise;
};
getJSON("/posts.json").then(function(json) {
console.log('Contents: ' + json);
}, function(error) {
console.error('出錯了', error);
});
上面程式碼中,getJSON
是對 XMLHttpRequest 物件的封裝,用於發出一個針對 JSON 資料的 HTTP 請求,並且返回一個Promise
物件。需要注意的是,在getJSON
內部,resolve
函式和reject
函式呼叫時,都帶有引數。
如果呼叫resolve
函式和reject
函式時帶有引數,那麼它們的引數會被傳遞給回撥函式。reject
函式的引數通常是Error
物件的例項,表示丟擲的錯誤;resolve
函式的引數除了正常的值以外,還可能是另一個 Promise 例項,比如像下面這樣。
const p1 = new Promise(function (resolve, reject) {
// ...
});
const p2 = new Promise(function (resolve, reject) {
// ...
resolve(p1);
})
上面程式碼中,p1
和p2
都是 Promise 的例項,但是p2
的resolve
方法將p1
作為引數,即一個非同步操作的結果是返回另一個非同步操作。
注意,這時p1
的狀態就會傳遞給p2
,也就是說,p1
的狀態決定了p2
的狀態。如果p1
的狀態是pending
,那麼p2
的回撥函式就會等待p1
的狀態改變;如果p1
的狀態已經是resolved
或者rejected
,那麼p2
的回撥函式將會立刻執行。
const p1 = new Promise(function (resolve, reject) {
setTimeout(() => reject(new Error('fail')), 3000)
})
const p2 = new Promise(function (resolve, reject) {
setTimeout(() => resolve(p1), 1000)
})
p2
.then(result => console.log(result))
.catch(error => console.log(error))
// Error: fail
上面程式碼中,p1
是一個 Promise,3 秒之後變為rejected
。p2
的狀態在 1 秒之後改變,resolve
方法返回的是p1
。由於p2
返回的是另一個 Promise,導致p2
自己的狀態無效了,由p1
的狀態決定p2
的狀態。所以,後面的then
語句都變成針對後者(p1
)。又過了 2 秒,p1
變為rejected
,導致觸發catch
方法指定的回撥函式。
注意,呼叫resolve
或reject
並不會終結 Promise 的引數函式的執行。
new Promise((resolve, reject) => {
resolve(1);
console.log(2);
}).then(r => {
console.log(r);
});
// 2
// 1
上面程式碼中,呼叫resolve(1)
以後,後面的console.log(2)
還是會執行,並且會首先打印出來。這是因為立即 resolved 的 Promise 是在本輪事件迴圈的末尾執行,總是晚於本輪迴圈的同步任務。
一般來說,呼叫resolve
或reject
以後,Promise 的使命就完成了,後繼操作應該放到then
方法裡面,而不應該直接寫在resolve
或reject
的後面。所以,最好在它們前面加上return
語句,這樣就不會有意外。
new Promise((resolve, reject) => {
return resolve(1);
// 後面的語句不會執行
console.log(2);
})
Promise.prototype.then()
Promise 例項具有then
方法,也就是說,then
方法是定義在原型物件Promise.prototype
上的。它的作用是為 Promise 例項新增狀態改變時的回撥函式。前面說過,then
方法的第一個引數是resolved
狀態的回撥函式,第二個引數(可選)是rejected
狀態的回撥函式。
then
方法返回的是一個新的Promise
例項(注意,不是原來那個Promise
例項)。因此可以採用鏈式寫法,即then
方法後面再呼叫另一個then
方法。