ES6之路第十二篇:Promise对象
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實例。
1 const promise = new Promise(function(resolve, reject) { 2 // ... some code 3 4 if (/* 異步操作成功 */){ 5 resolve(value); 6 } else { 7 reject(error); 8 } 9 });Promise構造函數接受一個函數作為參數,該函數的兩個參數分別是resolve和reject。它們是兩個函數,由 JavaScript 引擎提供,不用自己部署。
resolve函數的作用是,將Promise對象的狀態從“未完成”變為“成功”(即從 pending 變為 resolved),在異步操作成功時調用,并將異步操作的結果,作為參數傳遞出去;reject函數的作用是,將Promise對象的狀態從“未完成”變為“失敗”(即從 pending 變為 rejected),在異步操作失敗時調用,并將異步操作報出的錯誤,作為參數傳遞出去。
Promise實例生成以后,可以用then方法分別指定resolved狀態和rejected狀態的回調函數。
1 promise.then(function(value) { 2 // success 3 }, function(error) { 4 // failure 5 });then方法可以接受兩個回調函數作為參數。第一個回調函數是Promise對象的狀態變為resolved時調用,第二個回調函數是Promise對象的狀態變為rejected時調用。其中,第二個函數是可選的,不一定要提供。這兩個函數都接受Promise對象傳出的值作為參數。
下面是一個Promise對象的簡單例子。
1 function timeout(ms) { 2 return new Promise((resolve, reject) => { 3 setTimeout(resolve, ms, 'done'); 4 }); 5 } 6 7 timeout(100).then((value) => { 8 console.log(value); 9 });上面代碼中,timeout方法返回一個Promise實例,表示一段時間以后才會發生的結果。過了指定的時間(ms參數)以后,Promise實例的狀態變為resolved,就會觸發then方法綁定的回調函數。
Promise 新建后就會立即執行。
1 let promise = new Promise(function(resolve, reject) { 2 console.log('Promise'); 3 resolve(); 4 }); 5 6 promise.then(function() { 7 console.log('resolved.'); 8 }); 9 10 console.log('Hi!'); 11 12 // Promise 13 // Hi! 14 // resolved上面代碼中,Promise 新建后立即執行,所以首先輸出的是Promise。然后,then方法指定的回調函數,將在當前腳本所有同步任務執行完才會執行,所以resolved最后輸出。
下面是異步加載圖片的例子。
1 function loadImageAsync(url) { 2 return new Promise(function(resolve, reject) { 3 const image = new Image(); 4 5 image.onload = function() { 6 resolve(image); 7 }; 8 9 image.onerror = function() { 10 reject(new Error('Could not load image at ' + url)); 11 }; 12 13 image.src = url; 14 }); 15 }上面代碼中,使用Promise包裝了一個圖片加載的異步操作。如果加載成功,就調用resolve方法,否則就調用reject方法。
下面是一個用Promise對象實現的 Ajax 操作的例子。
1 const getJSON = function(url) { 2 const promise = new Promise(function(resolve, reject){ 3 const handler = function() { 4 if (this.readyState !== 4) { 5 return; 6 } 7 if (this.status === 200) { 8 resolve(this.response); 9 } else { 10 reject(new Error(this.statusText)); 11 } 12 }; 13 const client = new XMLHttpRequest(); 14 client.open("GET", url); 15 client.onreadystatechange = handler; 16 client.responseType = "json"; 17 client.setRequestHeader("Accept", "application/json"); 18 client.send(); 19 20 }); 21 22 return promise; 23 }; 24 25 getJSON("/posts.json").then(function(json) { 26 console.log('Contents: ' + json); 27 }, function(error) { 28 console.error('出錯了', error); 29 });上面代碼中,getJSON是對 XMLHttpRequest 對象的封裝,用于發出一個針對 JSON 數據的 HTTP 請求,并且返回一個Promise對象。需要注意的是,在getJSON內部,resolve函數和reject函數調用時,都帶有參數。
如果調用resolve函數和reject函數時帶有參數,那么它們的參數會被傳遞給回調函數。reject函數的參數通常是Error對象的實例,表示拋出的錯誤;resolve函數的參數除了正常的值以外,還可能是另一個 Promise 實例,比如像下面這樣。
1 const p1 = new Promise(function (resolve, reject) { 2 // ... 3 }); 4 5 const p2 = new Promise(function (resolve, reject) { 6 // ... 7 resolve(p1); 8 })上面代碼中,p1和p2都是 Promise 的實例,但是p2的resolve方法將p1作為參數,即一個異步操作的結果是返回另一個異步操作。
注意,這時p1的狀態就會傳遞給p2,也就是說,p1的狀態決定了p2的狀態。如果p1的狀態是pending,那么p2的回調函數就會等待p1的狀態改變;如果p1的狀態已經是resolved或者rejected,那么p2的回調函數將會立刻執行。
1 const p1 = new Promise(function (resolve, reject) { 2 setTimeout(() => reject(new Error('fail')), 3000) 3 }) 4 5 const p2 = new Promise(function (resolve, reject) { 6 setTimeout(() => resolve(p1), 1000) 7 }) 8 9 p2 10 .then(result => console.log(result)) 11 .catch(error => console.log(error)) 12 // Error: fail上面代碼中,p1是一個 Promise,3 秒之后變為rejected。p2的狀態在 1 秒之后改變,resolve方法返回的是p1。由于p2返回的是另一個 Promise,導致p2自己的狀態無效了,由p1的狀態決定p2的狀態。所以,后面的then語句都變成針對后者(p1)。又過了 2 秒,p1變為rejected,導致觸發catch方法指定的回調函數。
注意,調用resolve或reject并不會終結 Promise 的參數函數的執行。
1 new Promise((resolve, reject) => { 2 resolve(1); 3 console.log(2); 4 }).then(r => { 5 console.log(r); 6 }); 7 // 2 8 // 1上面代碼中,調用resolve(1)以后,后面的console.log(2)還是會執行,并且會首先打印出來。這是因為立即 resolved 的 Promise 是在本輪事件循環的末尾執行,總是晚于本輪循環的同步任務。
一般來說,調用resolve或reject以后,Promise 的使命就完成了,后繼操作應該放到then方法里面,而不應該直接寫在resolve或reject的后面。所以,最好在它們前面加上return語句,這樣就不會有意外。
1 new Promise((resolve, reject) => { 2 return resolve(1); 3 // 后面的語句不會執行 4 console.log(2); 5 })?Promise.prototype.then()
Promise 實例具有then方法,也就是說,then方法是定義在原型對象Promise.prototype上的。它的作用是為 Promise 實例添加狀態改變時的回調函數。前面說過,then方法的第一個參數是resolved狀態的回調函數,第二個參數(可選)是rejected狀態的回調函數。
then方法返回的是一個新的Promise實例(注意,不是原來那個Promise實例)。因此可以采用鏈式寫法,即then方法后面再調用另一個then方法。
1 getJSON("/posts.json").then(function(json) { 2 return json.post; 3 }).then(function(post) { 4 // ... 5 });上面的代碼使用then方法,依次指定了兩個回調函數。第一個回調函數完成以后,會將返回結果作為參數,傳入第二個回調函數。
采用鏈式的then,可以指定一組按照次序調用的回調函數。這時,前一個回調函數,有可能返回的還是一個Promise對象(即有異步操作),這時后一個回調函數,就會等待該Promise對象的狀態發生變化,才會被調用。
1 getJSON("/post/1.json").then(function(post) { 2 return getJSON(post.commentURL); 3 }).then(function funcA(comments) { 4 console.log("resolved: ", comments); 5 }, function funcB(err){ 6 console.log("rejected: ", err); 7 });上面代碼中,第一個then方法指定的回調函數,返回的是另一個Promise對象。這時,第二個then方法指定的回調函數,就會等待這個新的Promise對象狀態發生變化。如果變為resolved,就調用funcA,如果狀態變為rejected,就調用funcB。
如果采用箭頭函數,上面的代碼可以寫得更簡潔。
1 getJSON("/post/1.json").then( 2 post => getJSON(post.commentURL) 3 ).then( 4 comments => console.log("resolved: ", comments), 5 err => console.log("rejected: ", err) 6 );Promise.prototype.catch()
Promise.prototype.catch方法是.then(null, rejection)的別名,用于指定發生錯誤時的回調函數。
1 getJSON('/posts.json').then(function(posts) { 2 // ... 3 }).catch(function(error) { 4 // 處理 getJSON 和 前一個回調函數運行時發生的錯誤 5 console.log('發生錯誤!', error); 6 });上面代碼中,getJSON方法返回一個 Promise 對象,如果該對象狀態變為resolved,則會調用then方法指定的回調函數;如果異步操作拋出錯誤,狀態就會變為rejected,就會調用catch方法指定的回調函數,處理這個錯誤。另外,then方法指定的回調函數,如果運行中拋出錯誤,也會被catch方法捕獲。
1 p.then((val) => console.log('fulfilled:', val)) 2 .catch((err) => console.log('rejected', err)); 3 4 // 等同于 5 p.then((val) => console.log('fulfilled:', val)) 6 .then(null, (err) => console.log("rejected:", err));下面是一個例子。
1 const promise = new Promise(function(resolve, reject) { 2 throw new Error('test'); 3 }); 4 promise.catch(function(error) { 5 console.log(error); 6 }); 7 // Error: test上面代碼中,promise拋出一個錯誤,就被catch方法指定的回調函數捕獲。注意,上面的寫法與下面兩種寫法是等價的。
1 // 寫法一 2 const promise = new Promise(function(resolve, reject) { 3 try { 4 throw new Error('test'); 5 } catch(e) { 6 reject(e); 7 } 8 }); 9 promise.catch(function(error) { 10 console.log(error); 11 }); 12 13 // 寫法二 14 const promise = new Promise(function(resolve, reject) { 15 reject(new Error('test')); 16 }); 17 promise.catch(function(error) { 18 console.log(error); 19 });比較上面兩種寫法,可以發現reject方法的作用,等同于拋出錯誤。
如果 Promise 狀態已經變成resolved,再拋出錯誤是無效的。
1 const promise = new Promise(function(resolve, reject) { 2 resolve('ok'); 3 throw new Error('test'); 4 }); 5 promise 6 .then(function(value) { console.log(value) }) 7 .catch(function(error) { console.log(error) }); 8 // ok上面代碼中,Promise 在resolve語句后面,再拋出錯誤,不會被捕獲,等于沒有拋出。因為 Promise 的狀態一旦改變,就永久保持該狀態,不會再變了。
Promise 對象的錯誤具有“冒泡”性質,會一直向后傳遞,直到被捕獲為止。也就是說,錯誤總是會被下一個catch語句捕獲。
1 getJSON('/post/1.json').then(function(post) { 2 return getJSON(post.commentURL); 3 }).then(function(comments) { 4 // some code 5 }).catch(function(error) { 6 // 處理前面三個Promise產生的錯誤 7 });上面代碼中,一共有三個 Promise 對象:一個由getJSON產生,兩個由then產生。它們之中任何一個拋出的錯誤,都會被最后一個catch捕獲。
Promise.prototype.finally()
finally方法用于指定不管 Promise 對象最后狀態如何,都會執行的操作。該方法是 ES2018 引入標準的。
1 promise 2 .then(result => {···}) 3 .catch(error => {···}) 4 .finally(() => {···});上面代碼中,不管promise最后的狀態,在執行完then或catch指定的回調函數以后,都會執行finally方法指定的回調函數。
下面是一個例子,服務器使用 Promise 處理請求,然后使用finally方法關掉服務器。
1 server.listen(port) 2 .then(function () { 3 // ... 4 }) 5 .finally(server.stop);finally方法的回調函數不接受任何參數,這意味著沒有辦法知道,前面的 Promise 狀態到底是fulfilled還是rejected。這表明,finally方法里面的操作,應該是與狀態無關的,不依賴于 Promise 的執行結果。
Promise.all()
Promise.all方法用于將多個 Promise 實例,包裝成一個新的 Promise 實例。
1 const p = Promise.all([p1, p2, p3]);上面代碼中,Promise.all方法接受一個數組作為參數,p1、p2、p3都是 Promise 實例,如果不是,就會先調用下面講到的Promise.resolve方法,將參數轉為 Promise 實例,再進一步處理。(Promise.all方法的參數可以不是數組,但必須具有 Iterator 接口,且返回的每個成員都是 Promise 實例。)
p的狀態由p1、p2、p3決定,分成兩種情況。
(1)只有p1、p2、p3的狀態都變成fulfilled,p的狀態才會變成fulfilled,此時p1、p2、p3的返回值組成一個數組,傳遞給p的回調函數。
(2)只要p1、p2、p3之中有一個被rejected,p的狀態就變成rejected,此時第一個被reject的實例的返回值,會傳遞給p的回調函數。
下面是一個具體的例子。
1 // 生成一個Promise對象的數組 2 const promises = [2, 3, 5, 7, 11, 13].map(function (id) { 3 return getJSON('/post/' + id + ".json"); 4 }); 5 6 Promise.all(promises).then(function (posts) { 7 // ... 8 }).catch(function(reason){ 9 // ... 10 });上面代碼中,promises是包含 6 個 Promise 實例的數組,只有這 6 個實例的狀態都變成fulfilled,或者其中有一個變為rejected,才會調用Promise.all方法后面的回調函數。
下面是另一個例子。
1 const databasePromise = connectDatabase(); 2 3 const booksPromise = databasePromise 4 .then(findAllBooks); 5 6 const userPromise = databasePromise 7 .then(getCurrentUser); 8 9 Promise.all([ 10 booksPromise, 11 userPromise 12 ]) 13 .then(([books, user]) => pickTopRecommentations(books, user));上面代碼中,booksPromise和userPromise是兩個異步操作,只有等到它們的結果都返回了,才會觸發pickTopRecommentations這個回調函數。
Promise.race()
Promise.race方法同樣是將多個 Promise 實例,包裝成一個新的 Promise 實例。
1 const p = Promise.race([p1, p2, p3]);上面代碼中,只要p1、p2、p3之中有一個實例率先改變狀態,p的狀態就跟著改變。那個率先改變的 Promise 實例的返回值,就傳遞給p的回調函數。
Promise.race方法的參數與Promise.all方法一樣,如果不是 Promise 實例,就會先調用下面講到的Promise.resolve方法,將參數轉為 Promise 實例,再進一步處理。
下面是一個例子,如果指定時間內沒有獲得結果,就將 Promise 的狀態變為reject,否則變為resolve。
1 const p = Promise.race([ 2 fetch('/resource-that-may-take-a-while'), 3 new Promise(function (resolve, reject) { 4 setTimeout(() => reject(new Error('request timeout')), 5000) 5 }) 6 ]); 7 8 p 9 .then(console.log) 10 .catch(console.error);上面代碼中,如果 5 秒之內fetch方法無法返回結果,變量p的狀態就會變為rejected,從而觸發catch方法指定的回調函數。
Promise.resolve()
有時需要將現有對象轉為 Promise 對象,Promise.resolve方法就起到這個作用。
1 const jsPromise = Promise.resolve($.ajax('/whatever.json'));上面代碼將 jQuery 生成的deferred對象,轉為一個新的 Promise 對象。
Promise.resolve等價于下面的寫法。
1 Promise.resolve('foo') 2 // 等價于 3 new Promise(resolve => resolve('foo'))Promise.resolve方法的參數分成四種情況。
(1)參數是一個 Promise 實例
如果參數是 Promise 實例,那么Promise.resolve將不做任何修改、原封不動地返回這個實例。
(2)參數是一個thenable對象
thenable對象指的是具有then方法的對象,比如下面這個對象。
1 let thenable = { 2 then: function(resolve, reject) { 3 resolve(42); 4 } 5 };Promise.resolve方法會將這個對象轉為 Promise 對象,然后就立即執行thenable對象的then方法。
1 let thenable = { 2 then: function(resolve, reject) { 3 resolve(42); 4 } 5 }; 6 7 let p1 = Promise.resolve(thenable); 8 p1.then(function(value) { 9 console.log(value); // 42 10 });上面代碼中,thenable對象的then方法執行后,對象p1的狀態就變為resolved,從而立即執行最后那個then方法指定的回調函數,輸出 42。
(3)參數不是具有then方法的對象,或根本就不是對象
如果參數是一個原始值,或者是一個不具有then方法的對象,則Promise.resolve方法返回一個新的 Promise 對象,狀態為resolved。
1 const p = Promise.resolve('Hello'); 2 3 p.then(function (s){ 4 console.log(s) 5 }); 6 // Hello上面代碼生成一個新的 Promise 對象的實例p。由于字符串Hello不屬于異步操作(判斷方法是字符串對象不具有 then 方法),返回 Promise 實例的狀態從一生成就是resolved,所以回調函數會立即執行。Promise.resolve方法的參數,會同時傳給回調函數。
(4)不帶有任何參數
Promise.resolve方法允許調用時不帶參數,直接返回一個resolved狀態的 Promise 對象。
所以,如果希望得到一個 Promise 對象,比較方便的方法就是直接調用Promise.resolve方法。
1 const p = Promise.resolve(); 2 3 p.then(function () { 4 // ... 5 });上面代碼的變量p就是一個 Promise 對象。
需要注意的是,立即resolve的 Promise 對象,是在本輪“事件循環”(event loop)的結束時,而不是在下一輪“事件循環”的開始時。
1 setTimeout(function () { 2 console.log('three'); 3 }, 0); 4 5 Promise.resolve().then(function () { 6 console.log('two'); 7 }); 8 9 console.log('one'); 10 11 // one 12 // two 13 // three上面代碼中,setTimeout(fn, 0)在下一輪“事件循環”開始時執行,Promise.resolve()在本輪“事件循環”結束時執行,console.log('one')則是立即執行,因此最先輸出。
Promise.reject()
Promise.reject(reason)方法也會返回一個新的 Promise 實例,該實例的狀態為rejected。
1 const p = Promise.reject('出錯了'); 2 // 等同于 3 const p = new Promise((resolve, reject) => reject('出錯了')) 4 5 p.then(null, function (s) { 6 console.log(s) 7 }); 8 // 出錯了上面代碼生成一個 Promise 對象的實例p,狀態為rejected,回調函數會立即執行。
注意,Promise.reject()方法的參數,會原封不動地作為reject的理由,變成后續方法的參數。這一點與Promise.resolve方法不一致。
1 const thenable = { 2 then(resolve, reject) { 3 reject('出錯了'); 4 } 5 }; 6 7 Promise.reject(thenable) 8 .catch(e => { 9 console.log(e === thenable) 10 }) 11 // true上面代碼中,Promise.reject方法的參數是一個thenable對象,執行以后,后面catch方法的參數不是reject拋出的“出錯了”這個字符串,而是thenable對象。
應用
加載圖片
我們可以將圖片的加載寫成一個Promise,一旦加載完成,Promise的狀態就發生變化
1 const preloadImage = function (path) { 2 return new Promise(function (resolve, reject) { 3 const image = new Image(); 4 image.onload = resolve; 5 image.onerror = reject; 6 image.src = path; 7 }); 8 };Generatot函數與Promise的結合
使用 Generator 函數管理流程,遇到異步操作的時候,通常返回一個Promise對象。
1 function getFoo () { 2 return new Promise(function (resolve, reject){ 3 resolve('foo'); 4 }); 5 } 6 7 const g = function* () { 8 try { 9 const foo = yield getFoo(); 10 console.log(foo); 11 } catch (e) { 12 console.log(e); 13 } 14 }; 15 16 function run (generator) { 17 const it = generator(); 18 19 function go(result) { 20 if (result.done) return result.value; 21 22 return result.value.then(function (value) { 23 return go(it.next(value)); 24 }, function (error) { 25 return go(it.throw(error)); 26 }); 27 } 28 29 go(it.next()); 30 } 31 32 run(g);上面代碼的 Generator 函數g之中,有一個異步操作getFoo,它返回的就是一個Promise對象。函數run用來處理這個Promise對象,并調用下一個next方法。
Promise.try()
實際開發中,經常遇到一種情況:不知道或者不想區分,函數f是同步函數還是異步操作,但是想用 Promise 來處理它。因為這樣就可以不管f是否包含異步操作,都用then方法指定下一步流程,用catch方法處理f拋出的錯誤。一般就會采用下面的寫法。
1 Promise.resolve().then(f)上面的寫法有一個缺點,就是如果f是同步函數,那么它會在本輪事件循環的末尾執行。
1 const f = () => console.log('now'); 2 Promise.resolve().then(f); 3 console.log('next'); 4 // next 5 // now上面代碼中,函數f是同步的,但是用 Promise 包裝了以后,就變成異步執行了。
那么有沒有一種方法,讓同步函數同步執行,異步函數異步執行,并且讓它們具有統一的 API 呢?回答是可以的,并且還有兩種寫法。第一種寫法是用async函數來寫。
1 const f = () => console.log('now'); 2 (async () => f())(); 3 console.log('next'); 4 // now 5 // next上面代碼中,第二行是一個立即執行的匿名函數,會立即執行里面的async函數,因此如果f是同步的,就會得到同步的結果;如果f是異步的,就可以用then指定下一步,就像下面的寫法。
1 (async () => f())() 2 .then(...)需要注意的是,async () => f()會吃掉f()拋出的錯誤。所以,如果想捕獲錯誤,要使用promise.catch方法。
1 (async () => f())() 2 .then(...) 3 .catch(...)?
轉載于:https://www.cnblogs.com/wanghao123/p/9371472.html
總結
以上是生活随笔為你收集整理的ES6之路第十二篇:Promise对象的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 光大银行信用卡提现手续费是多少
- 下一篇: 骁龙888支持5G双卡双待吗 配备全球首