ECMAscript 6 はネイティブで Promise オブジェクトを提供しています。

Promise オブジェクトは将来発生するイベントを表し、非同期操作のメッセージを渡すために使われます。

Promise オブジェクトには次の2つの特徴があります:

1. オブジェクトの状態は外部の影響を受けません。Promise オブジェクトは非同期操作を表し、3つの状態があります:

  • pending: 初期状態であり、成功でも失敗でもない状態です。
  • fulfilled: 操作が正常に完了したことを意味します。
  • rejected: 操作が失敗したことを意味します。

非同期操作の結果だけが現在の状態を決定でき、他のどの操作もこの状態を変更できません。これが Promise という名前の由来でもあり、英語の意味は「約束」であり、他の手段では変更できないことを表しています。

2. 一度状態が変わると、再び変わることはなく、いつでもこの結果を得ることができます。Promise オブジェクトの状態変化は、Pending から Resolved へ、Pending から Rejected への2つの可能性しかありません。この2つのどちらかが発生すると、状態は固定され、再び変わることはなく、常にこの結果を保持します。たとえ変化がすでに発生していても、Promise オブジェクトにコールバック関数を追加すれば、すぐにこの結果を得られます。これはイベント(Event)とは完全に異なります。イベントの特徴は、聞き逃した場合、後からリスナーを追加しても結果を得られないことです。

Promise の長所と短所

Promise オブジェクトがあれば、非同期操作を同期操作のフローとして表現でき、何重にもネストしたコールバック関数を避けられます。さらに、Promise オブジェクトは統一されたインターフェースを提供するため、非同期操作の制御がより容易になります。

Promise にはいくつかの欠点もあります。まず、Promise をキャンセルできません。一度作成するとすぐに実行され、途中でキャンセルすることはできません。次に、コールバック関数を設定しない場合、Promise 内部でスローされたエラーは外部に反映されません。第三に、Pending 状態のときは、現在どの段階まで進んでいるか(始まったばかりなのか、もうすぐ完了するのか)を知ることができません。

Promise の作成

promise オブジェクトを作成するには、new を使って Promise のコンストラクターを呼び出してインスタンス化できます。

以下は promise を作成する手順です:

var promise = new Promise(function(resolve, reject) { //非同期処理 //処理が終了したら、resolve または reject を呼び出します });

Promise コンストラクターは1つの引数と、resolve(解決)と reject(拒否)の2つのパラメーターを持つコールバックを含みます。コールバック内で何らかの操作(例: 非同期)を実行し、すべてが正常なら resolve を呼び出し、そうでなければ reject を呼び出します。

例

var myFirstPromise = new Promise(function(resolve, reject){ //非同期コードの実行が成功したときにのみ resolve(...) を呼び出し、非同期コードが失敗したときは reject(...) を呼び出します。 //この例では、setTimeout(...) を使用して非同期コードをシミュレートしています。実際のコーディングでは、XHR リクエストや HTML5 のいくつかの API メソッドかもしれません。 setTimeout(function(){ resolve("成功!"); //コードは正常に実行されました! }, 250); }); myFirstPromise.then(function(successMessage){ //successMessage の値は、上記で resolve(...) メソッドを呼び出したときに渡した値です。 //successMessage パラメーターは必ずしも文字列型である必要はありません。ここでは単に例を示しているだけです。 document.write("Yay! " + successMessage); });

試してみる »

インスタンス化された promise オブジェクトに対しては、promise.then() メソッドを呼び出し、resolve と reject メソッドをコールバックとして渡すことができます。

promise.then() は promise の最も一般的なメソッドです。

promise.then(onFulfilled, onRejected)

promise はエラー処理を簡素化します。上記のコードは次のように書くこともできます:

promise.then(onFulfilled).catch(onRejected)

Promise Ajax

以下は Promise オブジェクトを使用して実装した Ajax 操作の例です。

例

function ajax(URL) { return new Promise(function (resolve, reject) { var req = new XMLHttpRequest(); req.open('GET', URL, true); req.onload = function () { if (req.status === 200) { resolve(req.responseText); } else { reject(new Error(req.statusText)); } }; req.onerror = function () { reject(new Error(req.statusText)); }; req.send(); }); } var URL = "/try/ajax/testpromise.php"; ajax(URL).then(function onFulfilled(value){ document.write('内容は:' + value); }).catch(function onRejected(error){ document.write('エラー:' + error); });

試してみる »

上記のコードでは、resolve メソッドと reject メソッドの呼び出し時に、どちらも引数が渡されています。これらの引数はコールバック関数に渡されます。reject メソッドの引数は通常 Error オブジェクトのインスタンスですが、resolve メソッドの引数は通常の値のほかに、別の Promise インスタンスの場合もあります。例えば次のようになります。

var p1 = new Promise(function(resolve, reject){ // ... some code }); var p2 = new Promise(function(resolve, reject){ // ... some code resolve(p1); })

上記のコードでは、p1 と p2 はどちらも Promise のインスタンスですが、p2 の resolve メソッドが p1 を引数として受け取ると、p1 の状態が p2 に渡されます。呼び出し時に p1 の状態が pending であれば、p2 のコールバック関数は p1 の状態が変わるのを待ちます。p1 の状態がすでに fulfilled または rejected であれば、p2 のコールバック関数はすぐに実行されます。


Promise.prototype.then メソッド:チェーン操作

Promise.prototype.then メソッドは新しい Promise オブジェクトを返すため、チェーン形式で記述できます。

getJSON("/posts.json").then(function(json) { return json.post; }).then(function(post) { // proceed });

上記のコードでは、then メソッドを使用して、2つのコールバック関数を順に指定しています。最初のコールバック関数が完了した後、その戻り値が引数として2番目のコールバック関数に渡されます。

前のコールバック関数が Promise オブジェクトを返す場合、後ろのコールバック関数はその Promise オブジェクトに実行結果が出るのを待ってから、さらに呼び出されます。

getJSON("/post/1.json").then(function(post) { return getJSON(post.commentURL); }).then(function(comments) { //comments を処理する });

この設計により、ネストされた非同期操作は簡単に書き換えることができ、コールバック関数の「横方向の展開」から「下方向の展開」へと変わります。


Promise.prototype.catch メソッド:エラーを捕捉

Promise.prototype.catch メソッドは Promise.prototype.then(null, rejection) のエイリアスであり、エラーが発生したときのコールバック関数を指定するために使われます。

getJSON("/posts.json").then(function(posts) { // some code }).catch(function(error) { //前のコールバック関数の実行中に発生したエラーを処理する console.log('エラーが発生しました!', error); });

Promise オブジェクトのエラーには「バブリング」の性質があり、捕捉されるまで後方へ渡り続けます。つまり、エラーは必ず次の catch 文によって捕捉されます。

getJSON("/post/1.json").then(function(post) { return getJSON(post.commentURL); }).then(function(comments) { // some code }).catch(function(error) { //前の2つのコールバック関数のエラーを処理する });

Promise.all メソッド、Promise.race メソッド

Promise.all メソッドは、複数の Promise インスタンスを1つの新しい Promise インスタンスにラップするために使われます。

var p = Promise.all([p1,p2,p3]);

上記のコードでは、Promise.all メソッドは配列を引数として受け取ります。p1、p2、p3 はすべて Promise オブジェクトのインスタンスです。(Promise.all メソッドの引数は必ずしも配列である必要はありませんが、iterator インターフェースを持ち、返される各メンバーが Promise インスタンスである必要があります。)

p の状態は p1、p2、p3 によって決まり、次の2つのケースに分けられます。

  • (1)p1、p2、p3 の状態がすべて fulfilled になった場合のみ、p の状態も fulfilled になります。このとき、p1、p2、p3 の戻り値が配列を構成し、p のコールバック関数に渡されます。
  • (2)p1、p2、p3 のうちの1つでも rejected になれば、p の状態は rejected になります。このとき、最初に reject されたインスタンスの戻り値が p のコールバック関数に渡されます。

以下は具体的な例です。

//Promise オブジェクトの配列を生成する var promises = [2, 3, 5, 7, 11, 13].map(function(id){ return getJSON("/post/" + id + ".json"); }); Promise.all(promises).then(function(posts) { // ... }).catch(function(reason){ // ... });

Promise.race メソッドも同様に、複数の Promise インスタンスを1つの新しい Promise インスタンスにラップします。

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

上記のコードでは、p1、p2、p3 のうちの1つのインスタンスが真っ先に状態を変えると、p の状態もそれに従って変わります。真っ先に状態を変えた Promise インスタンスの戻り値が、p の戻り値として渡されます。

Promise.all メソッドと Promise.race メソッドの引数が Promise インスタンスでない場合、まず後述の Promise.resolve メソッドを呼び出して引数を Promise インスタンスに変換してから、さらに処理を進めます。


Promise.resolve メソッド、Promise.reject メソッド

既存のオブジェクトを Promise オブジェクトに変換する必要がある場合があります。Promise.resolve メソッドはその役割を果たします。

var jsPromise = Promise.resolve($.ajax('/whatever.json'));

上記のコードでは、jQuery が生成した deferred オブジェクトを、新しい ES6 の Promise オブジェクトに変換しています。

Promise.resolveメソッドの引数が、thenメソッドを持つオブジェクト(別名thenableオブジェクト)ではない場合、新しいPromiseオブジェクトを返し、その状態はfulfilledとなる。

var p = Promise.resolve('Hello'); p.then(function (s){ console.log(s) }); // Hello

上記のコードは新しいPromiseオブジェクトのインスタンスpを生成する。その状態はfulfilledであるため、コールバック関数は即座に実行される。Promise.resolveメソッドの引数がコールバック関数の引数となる。

Promise.resolveメソッドの引数がPromiseオブジェクトのインスタンスである場合、そのまま変更されずに返される。

Promise.reject(reason)メソッドも新しいPromiseインスタンスを返す。このインスタンスの状態はrejectedとなる。Promise.rejectメソッドの引数reasonは、インスタンスのコールバック関数に渡される。

var p = Promise.reject('エラーが発生しました'); p.then(null, function (s){ console.log(s) }); //エラーが発生しました

上記のコードはPromiseオブジェクトのインスタンスを生成し、状態はrejectedとなる。コールバック関数は即座に実行される。

参考リンク:

  • https://wohugb.gitbooks.io/ecmascript-6/content/docs/promise.html
  • https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Promise
  • http://qingtong234.github.io/2016/01/14/javascript%E4%B8%AD%E7%9A%84promise%E5%BC%82%E6%AD%A5%E7%BC%96%E7%A8%8B-1/