Promise

含義

Promise 是異步編程的一種解決方案，比傳統的解決方案——回調函數和事件——更合理和更強大。

所謂Promise，簡單說就是一個容器，里面保存著某個未來才會結束的事件（通常是一個異步操作）的結果。從語法上說，Promise 是一個對象，從它可以獲取異步操作的消息。Promise 提供統一的 API，各種異步操作都可以用同樣的方法進行處理。

Promise對象有以下兩個特點。

• 對象的狀態不受外界影響。

有三種狀態：pending（進行中）、fulfilled（已成功）和rejected（已失敗），從pending變為fulfilled和從pengding變為rejected。

• 一旦狀態改變，就不會再變，任何時候都可以得到這個結果。

如果改變已經發生了，你再對Promise對象添加回調函數，也會立即得到這個結果。這與事件（Event）完全不同，事件的特點是，如果你錯過了它，再去監聽，是得不到結果的。

Promise也有一些缺點。首先，無法取消Promise，一旦新建它就會立即執行，無法中途取消。其次，如果不設置回調函數，Promise內部拋出的錯誤，不會反應到外部。第三，當處于pending狀態時，無法得知目前進展到哪一個階段（剛剛開始還是即將完成）。

基本用法

Promise構造函數接受一個函數作為參數，該函數的兩個參數分別是resolve和reject。它們是兩個函數，由 JavaScript 引擎提供，不用自己部署。

resolve將狀態變為已成功，在異步操作成功時調用，并將異步操作的結果作為參數傳遞出去。
reject將狀態變為已失敗，在異步操作失敗時調用，并將異步操作報錯的錯誤作為參數傳遞出去。

Promise實例生成以后，可以用then方法分別指定resolved狀態和rejected狀態的回調函數。

Promise 新建后就會立即執行。

let promise = new Promise(function(resolve, reject) {
  console.log('Promise');
  resolve();
});

promise.then(function() {
  console.log('resolved.');
});

console.log('Hi!');

// Promise
// Hi!
// resolved

resolve函數的參數除了正常的值以外，還可能是另一個 Promise 實例，比如像下面這樣。

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和p2都是 Promise 的實例，但是p2的resolve方法將p1作為參數，即一個異步操作的結果是返回另一個異步操作。

注意，這時p1的狀態就會傳遞給p2，也就是說，p1的狀態決定了p2的狀態。如果p1的狀態是pending，那么p2的回調函數就會等待p1的狀態改變；如果p1的狀態已經是resolved或者rejected，那么p2的回調函數將會立刻執行。由p1的狀態決定p2的狀態。所以，后面的then語句都變成針對后者（p1）。又過了 2 秒，p1變為rejected，導致觸發catch方法指定的回調函數。

注意，調用resolve或reject并不會終結 Promise 的參數函數的執行。

一般來說，調用resolve或reject以后，Promise 的使命就完成了，后繼操作應該放到then方法里面，而不應該直接寫在resolve或reject的后面。所以，最好在它們前面加上return語句，這樣就不會有意外。

new Promise((resolve, reject) => {
  resolve(1);
  console.log(2);
}).then(r => {
  console.log(r);
});
// 2
// 1

new Promise((resolve, reject) => {
  return resolve(1);
  // 后面的語句不會執行
  console.log(2);
})

Promise.prototype.then()

then方法的第一個參數是resolved狀態的回調函數，第二個參數（可選）是rejected狀態的回調函數。

then方法返回的是一個新的Promise實例（注意，不是原來那個Promise實例）。因此可以采用鏈式寫法，即then方法后面再調用另一個then方法。

getJSON("/posts.json").then(function(json) {
  return json.post;
}).then(function(post) {
  // ... 此時的post 就是 json.post
},function(err){

});

采用鏈式的then，可以指定一組按照次序調用的回調函數。這時，前一個回調函數，有可能返回的還是一個Promise對象（即有異步操作），這時后一個回調函數，就會等待該Promise對象的狀態發生變化，才會被調用。

Promise.prototype.catch()

Promise.prototype.catch方法是.then(null, rejection)或.then(undefined, rejection)的別名，用于指定發生錯誤時的回調函數。

同時then方法指定的回調函數，如果運行中拋出錯誤，也會被catch方法捕獲。

p.then((val) => console.log('fulfilled:', val))
  .catch((err) => console.log('rejected', err));

// 等同于
p.then((val) => console.log('fulfilled:', val))
  .then(null, (err) => console.log("rejected:", err));

// 并不等同于
p.then((val) => console.log('fulfilled:', val), err => console.log("rejected:", err))

Promise 對象的錯誤具有“冒泡”性質，會一直向后傳遞，直到被捕獲為止。也就是說，錯誤總是會被下一個catch語句捕獲。

getJSON('/post/1.json').then(function(post) {
  return getJSON(post.commentURL);
}).then(function(comments) {
  // some code
}).catch(function(error) {
  // 一個由getJSON產生，兩個由then產生。
  // 處理前面三個Promise產生的錯誤
});

一般來說，不要在then方法里面定義 Reject 狀態的回調函數（即then的第二個參數），總是使用catch方法。理由可以捕獲前面then方法執行中的錯誤，也更接近同步的寫法（try/catch）

跟傳統的try/catch代碼塊不同的是，如果沒有使用catch方法指定錯誤處理的回調函數，Promise 對象拋出的錯誤不會傳遞到外層代碼，即不會有任何反應。

const someAsyncThing = function() {
  return new Promise(function(resolve, reject) {
    // 下面一行會報錯，因為x沒有聲明
    resolve(x + 2);
  });
};

someAsyncThing().then(function() {
  console.log('everything is great');
  // 不會執行，因為要執行也執行catch 而catch沒有定義。
});

setTimeout(() => { console.log(123) }, 2000);
// Uncaught (in promise) ReferenceError: x is not defined
// 123

會打印出錯誤提示ReferenceError: x is not defined，但是不會退出進程、終止腳本執行，2 秒之后還是會輸出123。這就是說，Promise 內部的錯誤不會影響到 Promise 外部的代碼，通俗的說法就是“Promise 會吃掉錯誤”。

這個腳本放在服務器執行，退出碼就是0（即表示執行成功）。不過，Node 有一個unhandledRejection事件，專門監聽未捕獲的reject錯誤，上面的腳本會觸發這個事件的監聽函數，可以在監聽函數里面拋出錯誤。

process.on('unhandledRejection', function (err, p) {
  // 第一個是錯誤對象
  // 第二個是報錯的 Promise 實例，它可以用來了解發生錯誤的環境信息。
  throw err;
});

注意，Node 有計劃在未來廢除unhandledRejection事件。如果 Promise 內部有未捕獲的錯誤，會直接終止進程，并且進程的退出碼不為 0。

const promise = new Promise(function (resolve, reject) {
  resolve('ok');
  setTimeout(function () { throw new Error('test') }, 0)
});
promise.then(function (value) { console.log(value) })
.catch(err => {
  console.log('err', err);
  // 不會執行
});
// ok
// Uncaught Error: test

上面代碼中，Promise 指定在下一輪“事件循環”再拋出錯誤。到了那個時候，Promise 的運行已經結束了，所以這個錯誤是在 Promise 函數體外拋出的，會冒泡到最外層，成了未捕獲的錯誤。

一般總是建議，Promise 對象后面要跟catch方法，這樣可以處理 Promise 內部發生的錯誤。catch方法返回的還是一個 Promise 對象，因此后面還可以接著調用then方法。即使catch沒有被執行，這個后面接著catch后面又接著調用的then方法還是會執行，此時如果這個then方法報錯了，就與前面的catch無關了。

catch方法之中，還能再拋出錯誤。如果之后沒有別的catch方法，就會導致這個錯誤不會被捕捉。

Promise.prototype.finally()

finally方法用于指定不管 Promise 對象最后狀態如何，都會執行的操作。該方法是 ES2018 引入標準的。

finally方法的回調函數不接受任何參數，這意味著沒有辦法知道，前面的 Promise 狀態到底是fulfilled還是rejected。這表明，finally方法里面的操作，應該是與狀態無關的，不依賴于 Promise 的執行結果。即無論Promise是執行then操作還是執行catch操作都需要執行的代碼，可以放在finally方法中。常用場景：發起請求時，激活loading，而無論你請求成功與否都需要關閉loading。

promise
.then(result => {···})
.catch(error => {···})
.finally(() => {···});

它的實現也很簡單。

Promise.prototype.finally = function (callback) {
  let P = this.constructor;
  return this.then(
    value  => P.resolve(callback()).then(() => value), 
    // 這個then的參數其實就是callback的返回值，但是這里沒有使用這個參數，而是返回了上一個Promise的值
    reason => P.resolve(callback()).then(() => { throw reason })
  );
};

new Promise(function(resolve){
  resolve();
})
.then(result => {})
.catch(error => {})
.finally(() => {console.log('finally')}) // finally
.then(val => {
  console.log(val); // undefined
});

上面代碼中，不管前面的 Promise 是fulfilled還是rejected，都會執行回調函數callback。

Promise.all()

Promise.all方法用于將多個 Promise 實例，包裝成一個新的 Promise 實例。

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的回調函數。

// 生成一個Promise對象的數組
const promises = [2, 3, 5, 7, 11, 13].map(function (id) {
  return getJSON('/post/' + id + ".json");
});

Promise.all(promises).then(function (posts) {
  // 如果promises數組所有的getJSON異步操作都成功
  // 則posts是一個數組，里面包含6個異步操作成功的結果。
}).catch(function(reason){
  // 如果promises數組只要有一個getJSON異步操作都失敗
  // 就會將錯誤返回給catch
});

注意，如果作為參數的 Promise 實例，自己定義了catch方法，那么它一旦被rejected，并不會觸發Promise.all()的catch方法。

const p1 = new Promise((resolve, reject) => {
  resolve('hello');
})
.then(result => result)
.catch(e => e);

const p2 = new Promise((resolve, reject) => {
  throw new Error('報錯了');
})
.then(result => result)
.catch(e => e);

// p2定義的Promise會執行reject，然后觸發catch方法，
// catch方法返回一個新的Promise實例給了p2變量，該實例即此時的p2的狀態也會變成resolved 

Promise.all([p1, p2]) 
.then(result => console.log(result)) // ["hello", Error: 報錯了]
.catch(e => console.log(e)); // 只有p2沒有catch方法，才會觸發Promise.all的catch

上面代碼中，p1會resolved，p2首先會rejected，但是p2有自己的catch方法，該方法返回的是一個新的 Promise 實例，p2指向的實際上是這個實例。該實例執行完catch方法后，也會變成resolved，導致Promise.all()方法參數里面的兩個實例都會resolved，因此會調用then方法指定的回調函數，而不會調用catch方法指定的回調函數。

Promise.race()

Promise.race方法同樣是將多個 Promise 實例，包裝成一個新的 Promise 實例。

const p = Promise.race([p1, p2, p3]);

上面代碼中，只要p1、p2、p3之中有一個實例率先改變狀態，p的狀態就跟著改變。那個率先改變的 Promise 實例的返回值，就傳遞給p的回調函數。

Promise.race方法的參數如果不是 Promise 實例，就會先調用Promise.resolve方法，將參數轉為 Promise 實例，再進一步處理。

下面是一個例子，如果指定時間內沒有獲得結果，就將 Promise 的狀態變為reject，否則變為resolve。

const p = Promise.race([
  fetch('/resource-that-may-take-a-while'),
  new Promise(function (resolve, reject) {
    setTimeout(() => reject(new Error('request timeout')), 5000)
  })
]);

p
.then(console.log)
.catch(console.error);
// 如果 5 秒之內fetch方法無法返回結果，則setTimeout就會執行并拋出錯誤，率先改變狀態
// 變量p的狀態就會變為rejected，從而觸發catch方法指定的回調函數。

Promise.resolve()

有時需要將現有對象轉為 Promise 對象，Promise.resolve方法就起到這個作用。

// 將 jQuery 生成的deferred對象，轉為一個新的 Promise 對象。
const jsPromise = Promise.resolve($.ajax('/whatever.json'));

Promise.resolve('foo')
// 等價于
new Promise(resolve => resolve('foo'))

Promise.resolve方法的參數分成四種情況。

• 參數是一個 Promise 實例，那么Promise.resolve將不做任何修改、原封不動地返回這個實例。

• 參數是一個thenable對象，thenable對象指的是具有then方法的對象，比如下面這個對象。Promise.resolve方法會將這個對象轉為 Promise 對象，然后就立即執行thenable對象的then方法。

let thenable = {
  then: function(resolve, reject) {
    resolve(42);
  }
};

let p1 = Promise.resolve(thenable);
p1.then(function(value) {
  console.log(value);  // 42
});

• 參數不是具有then方法的對象，或根本就不是對象，則Promise.resolve方法返回一個新的 Promise 對象，狀態為resolved。Promise.resolve方法的參數，會同時傳給回調函數。

const p = Promise.resolve('Hello');

p.then(function (s){
  console.log(s)
});
// Hello

• 不帶有任何參數

Promise.resolve()方法允許調用時不帶參數，直接返回一個resolved狀態的 Promise 對象。

所以，如果希望得到一個 Promise 對象，比較方便的方法就是直接調用Promise.resolve()方法。

const p = Promise.resolve();

p.then(function () {
  // ...即then回調中也接受不到參數
});

Promise.reject()

Promise.reject(reason)方法也會返回一個新的 Promise 實例，該實例的狀態為rejected。

const p = Promise.reject('出錯了');

// 等同于

const p = new Promise((resolve, reject) => reject('出錯了'))
p.then(null, function (s) {
  console.log(s) // 出錯了
});

注意，Promise.reject()方法的參數，會原封不動地作為reject的理由，變成后續方法的參數。這一點與Promise.resolve方法不一致。

const thenable = {
  then(resolve, reject) {
    reject('出錯了');
  }
};

Promise.reject(thenable)
.catch(e => {
  console.log(e === thenable)
})
// true
// Promise.reject方法的參數是一個thenable對象，執行以后
// 后面catch方法的參數不是reject拋出的“出錯了”這個字符串，而是thenable對象。

Promise.try()

實際開發中，經常遇到一種情況：不知道或者不想區分，函數f是同步函數還是異步操作，但是想用 Promise 來處理它。因為這樣就可以不管f是否包含異步操作，都用then方法指定下一步流程，用catch方法處理f拋出的錯誤。

但是有一個缺點，就是如果f是同步函數，那么它會在本輪事件循環的末尾執行。

const f = () => console.log('now');
Promise.resolve().then(f);
console.log('next');
// next
// now

那么有沒有一種方法，讓同步函數同步執行，異步函數異步執行，并且讓它們具有統一的 API 呢？回答是可以的，并且還有兩種寫法。

第一種寫法是用async函數來寫。

const f = () => console.log('now');
(async () => f())()
.then(...)
.catch(...);
console.log('next');
// now
// next
// 因為async函數總是返回一個Promise
// 如果async函數的執行有返回值，那么這個返回這就會被傳遞到then方法的參數中

// 同時如果f是同步函數，那么就會async 函數中同步執行
// 如若是異步，那么在then方法中的代碼也能正確處理這種情況

第二種寫法是使用new Promise()。

const f = () => console.log('now');
(
  () => new Promise(
    resolve => resolve(f()) 
    // Promise 新建后的參數（傳入的函數）就會立即執行，是同步隊列， resolve(f())就會被立即執行
    // 如果是異步，就會將f()函數調用之后的返回值傳遞給then函數正確處理
  )
)();
console.log('next');
// now
// next

鑒于這是一個很常見的需求，所以現在有一個提案，提供Promise.try方法替代上面的寫法。

const f = () => console.log('now');
Promise.try(f);
console.log('next');
// now
// next

下面代碼中，database.users.get()返回一個 Promise 對象，如果拋出異步錯誤，可以用catch方法捕獲，就像下面這樣寫

function getUsername(userId) {
  return database.users.get({id: userId})
  .then(function(user) {
    return user.name;
  });
}

database.users.get({id: userId})
.then(...)
.catch(...)

但是database.users.get()可能還會拋出同步錯誤（比如數據庫連接錯誤，具體要看實現方法），這時你就不得不用try...catch去捕獲。

try {
  database.users.get({id: userId})
  .then(...)
  .catch(...)
} catch (e) {
  // ...
}

使用這樣的寫法就很笨拙了，這時就可以統一用promise.catch()捕獲所有同步和異步的錯誤。

Promise.try(() => database.users.get({id: userId}))
  .then(...)
  .catch(...)

事實上，Promise.try就是模擬try代碼塊，就像promise.catch模擬的是catch代碼塊。