Promise は、延期された非同期の計算を簡素化します。Promise はまだ完了していない操作を表します。
デベロッパーのみなさん、ウェブ開発の歴史における重要な瞬間に備えてください。
[ドラムロールの開始]
JavaScript に Promise がやってきた
[花火が上がり、キラキラした紙吹雪が降り注ぎ、人々が熱狂する]
この時点で、あなたの反応は次のいずれかでしょう。
- 周囲の人は喜んでいるが、あなたは何をそんなに騒ぐことがあるのかよくわかりません。おそらくあなたは、「Promise」が何かもわかっていないでしょう。あなたは肩をすくめますが、紙吹雪の重みが肩にのしかかってきます。もしそうだとしても心配しないでください。私の場合も、なぜ Promise がそんなに重要なのか理解するのに長い時間がかかりました。最初から始めることをおすすめします。
- あなたはガッツポーズをします。この瞬間を待ちかねていましたか?あなたはこの Promise というものを以前から使用していましたが、実装ごとに API が若干異なることに煩わされていました。公式な JavaScript バージョンの API は何でしょうか。用語から始めましょう。
- あなたはすでにこのことを知っていて、飛び跳ねる人たちをあっという間にニュースのように嘲笑します。しばらく優越感に浸ったら、API リファレンスに直行しましょう。
ブラウザのサポートとポリフィル
完全な Promise を実装していないブラウザを仕様に準拠させる場合や、他のブラウザや Node.js に Promise を追加する場合は、polyfill(2k を gzip 圧縮)を確認してください。
何が問題なの?
JavaScript はシングル スレッドです。スクリプトの 2 つの部分を同時に実行できず、1 つずつ実行する必要があります。ブラウザでは、1 つのスレッドを JavaScript およびその他多数のもの(ブラウザによって異なります)と共有しています。ただし、一般に、JavaScript はペイント、スタイルの更新、ユーザー操作の処理(テキストのハイライト表示やフォーム コントロールの操作など)と同じキューに入っています。これらいずれかの処理のアクティビティが、他のアクティビティを遅延させます。
人間はマルチスレッドです。複数の指を使ってタイピングし、運転しながら会話することができます。私たちが対処する必要がある唯一のブロック機能は、くしゃみです。くしゃみの間、現在のすべてのアクティビティを一時停止する必要があります。これはかなり煩わしいものです。運転しながら会話しようとしているときにはなおさらです。くしゃみをするコードを書くのは望ましくありません。
これを回避するために、これまではおそらく、イベントとコールバックを使用していたことでしょう。イベントを次に示します。
var img1 = document.querySelector('.img-1');
img1.addEventListener('load', function() {
// woo yey image loaded
});
img1.addEventListener('error', function() {
// argh everything's broken
});
このイベントはまったくくしゃみをしません。イメージを取得し、いくつかのリスナを追加すると、JavaScript はいずれかのリスナーが呼び出されるまで実行を停止します。
残念なことに、上記の例では、イベントが発生した後でイベントをリッスンし始めた可能性があります。そこで、イメージの「complete」プロパティを使用して、これを回避する必要があります。
var img1 = document.querySelector('.img-1');
function loaded() {
// woo yey image loaded
}
if (img1.complete) {
loaded();
}
else {
img1.addEventListener('load', loaded);
}
img1.addEventListener('error', function() {
// argh everything's broken
});
こうすると、イベントをリッスンできるようになる前にエラーが発生したイメージは取得されません。残念ながら、DOM ではこの処理を行う方法は提供されません。また、1 つの画像が読み込まれます。複数のイメージが読み込まれた場合を考えると物事はより複雑になります。
イベントが常に最良の方法とは限らない
イベントは、keyup
、touchstart
など、同じオブジェクトに対して複数回発生する可能性のある処理に適しています。これらのイベントを使用すると、リスナーをアタッチする前に何が行われていても関係なくなります。ただし、非同期の成功と失敗に関しては、理想的には次のようなコードが必要です。
img1.callThisIfLoadedOrWhenLoaded(function() {
// loaded
}).orIfFailedCallThis(function() {
// failed
});
// and…
whenAllTheseHaveLoaded([img1, img2]).callThis(function() {
// all loaded
}).orIfSomeFailedCallThis(function() {
// one or more failed
});
これが Promise の機能ですが、名前が改善されています。HTML イメージ要素に Promise を返す「ready」メソッドがある場合は、次のようにすることができます。
img1.ready()
.then(function() {
// loaded
}, function() {
// failed
});
// and…
Promise.all([img1.ready(), img2.ready()])
.then(function() {
// all loaded
}, function() {
// one or more failed
});
最も基本的な部分では、Promise はイベントリスナに似ていますが、次の点が異なります。
- Promise は 1 回しか成功または失敗できません。2 回成功または失敗することはできず、成功から失敗(またはその逆)に変化することもできません。
- Promise が成功または失敗し、後から成功と失敗のコールバックを追加すると、それより前にイベントが実行されていても、正しいコールバックが呼び出されます。
これは、非同期の成功と失敗に非常に役立ちます。何かが使用可能になった正確な時点にそれほどとらわれなくなり、結果に対して応答することの方が重要になるためです。
Promise の用語
Domenic Denicola の校正がこの記事の最初の下書きを読んで、用語について「F」と評価されました。彼は私を拘留し、私に「States and Fates」を 100 回コピーするよう強要し、親に心配な手紙を書きました。それにもかかわらず、私はまだ多くの用語を混同して使用していますが、基本は以下のとおりです。
Promise の状態は次のいずれかです。
- fulfilled - Promise に関連する操作が成功した
- rejected - Promise に関連するアクションが失敗した
- 保留中 - まだ処理も不承認もされていません
- settled - 解決または棄却された
仕様では、then
メソッドを持っているという点で Promise に似ているオブジェクトを示すために、thenable という用語も使用されています。この用語はイングランド フットボールの元マネージャー、Terry Venables を思い出すので、できるだけ使用しません。
JavaScript に Promise がやってきた
Promise は以前から、次のようなライブラリの形で使用されていました。
これらと JavaScript の Promise は、Promises/A+ と呼ばれる共通の標準化された動作を共有しています。jQuery ユーザーであれば、jQuery には Deferreds と呼ばれる類似の動作があります。ただし、Deferred は Promise/A+ に準拠していないため、若干異なり、有用性が低く注意してください。jQuery にも Promise 型がありますが、これは Deferred のサブセットにすぎず、同じ問題があります。
Promise の実装は標準化された動作に従いますが、全体的な API は異なります。JavaScript の Promise は、API が RSVP.js に似ています。Promise の作成方法を次に示します。
var promise = new Promise(function(resolve, reject) {
// do a thing, possibly async, then…
if (/* everything turned out fine */) {
resolve("Stuff worked!");
}
else {
reject(Error("It broke"));
}
});
Promise コンストラクタはコールバックを 1 つの引数として取り、コールバックは resolve と reject を 2 つのパラメータとして取ります。非同期処理など、コールバック内でなんらかの操作を行い、すべてが成功すると呼び出しが解決されます。そうでない場合、呼び出しは棄却されます。
単純な古い JavaScript の throw
と同様に、Error オブジェクトで拒否することが慣例ですが、必須ではありません。Error オブジェクトの利点は、スタックトレースを取得し、デバッグツールをより便利にすることです。
この Promise の使用方法を次に示します。
promise.then(function(result) {
console.log(result); // "Stuff worked!"
}, function(err) {
console.log(err); // Error: "It broke"
});
then()
は 2 つの引数(成功した場合のコールバックと失敗した場合のコールバック)を取ります。両方とも省略可能なため、成功した場合か失敗した場合いずれかのコールバックのみを追加できます。
JavaScript の Promise は、最初に DOM で「Future」として導入され、その後「Promise」に名前が変更されて、最終的に JavaScript に移行されました。これを DOM ではなく JavaScript で使用すると、Node.js などのブラウザ以外の JS コンテキストで使用できるようになるため便利です(コア API で Promise を利用するかどうかは別の問題です)。
これらの機能は JavaScript の機能ですが、DOM では問題なく使用できます。実際、非同期の成功と失敗のメソッドを持つすべての新しい DOM API で Promise が使用されます。これは、割り当て管理、フォント読み込みイベント、ServiceWorker、Web MIDI、ストリームなどではすでに行われています。
他のライブラリとの互換性
JavaScript Promise API は、then()
メソッドを持つもの(または、Promise の用語では thenable
)をすべて Promise と同様に処理します。そのため、Q Promise を返すライブラリを使用している場合は問題ありません。新しい JavaScript の Promise で問題なく機能します。
ただし、前述したとおり、jQuery の Deferred はやや不親切です。幸運なことに、これらは標準の Promise にキャストできるので、できるだけ早く試してみる価値があります。
var jsPromise = Promise.resolve($.ajax('/whatever.json'))
この場合、jQuery の $.ajax
は Deferred を返します。then()
メソッドがあるため、Promise.resolve()
はこれを JavaScript の Promise に変換できます。ただし、Deferred は複数の引数をコールバックに渡す場合があります。次に例を示します。
var jqDeferred = $.ajax('/whatever.json');
jqDeferred.then(function(response, statusText, xhrObj) {
// ...
}, function(xhrObj, textStatus, err) {
// ...
})
JS Promise は、最初の次の行以外すべてを無視します。
jsPromise.then(function(response) {
// ...
}, function(xhrObj) {
// ...
})
幸いなことに、通常はこれが必要な行です。少なくとも、必要なものへのアクセスは得られます。また jQuery は、拒否されたものに Error オブジェクトを渡すという慣例に従わないことにも注意してください。
複雑な非同期コードが簡単に
では、実際にコーディングしてみましょう。次の処理が必要だとします。
- 読み込み中であることを示すスピナーを開始する
- 各章のタイトルと URL を示す記事の JSON を取得する
- ページにタイトルを追加する
- 各チャプターを取得する
- ページに記事を追加する
- スピナーを停止する
途中で何か問題が発生した場合でも、ユーザーに知らせます。スピナーもその時点で停止する必要があります。そうしないと、スピナーは回転を続け、ユーザーにめまいをおこさせたり、他の UI に影響したりします。
もちろん、記事を配信するのに JavaScript は使用しません。HTML として表示する方が速いです。しかし、このパターンは、複数のデータをフェッチし、すべて完了したら何かを行うという、API を扱う場合にはよく見られます。
はじめに、ネットワークからのデータの取得について説明します。
XMLHttpRequest の Promise 化
古い API は、後方互換性を維持したまま更新できれば、Promise を使用するように更新されます。XMLHttpRequest
は主要な候補ですが、とりあえず、GET リクエストを行うための単純な関数を記述してみましょう。
function get(url) {
// Return a new promise.
return new Promise(function(resolve, reject) {
// Do the usual XHR stuff
var req = new XMLHttpRequest();
req.open('GET', url);
req.onload = function() {
// This is called even on 404 etc
// so check the status
if (req.status == 200) {
// Resolve the promise with the response text
resolve(req.response);
}
else {
// Otherwise reject with the status text
// which will hopefully be a meaningful error
reject(Error(req.statusText));
}
};
// Handle network errors
req.onerror = function() {
reject(Error("Network Error"));
};
// Make the request
req.send();
});
}
これを使ってみましょう。
get('story.json').then(function(response) {
console.log("Success!", response);
}, function(error) {
console.error("Failed!", error);
})
これで、XMLHttpRequest
を手動で入力せずに HTTP リクエストを送信できるようになりました。XMLHttpRequest
の面白おかしいキャメルケースを見る必要がないほど、私の人生は幸せになります。
チェーン
then()
で終わりではありません。then
を連結して値を変換したり、追加の非同期アクションを順番に実行したりできます。
値の変換
単純に新しい値を返すことで、値を変換できます。
var promise = new Promise(function(resolve, reject) {
resolve(1);
});
promise.then(function(val) {
console.log(val); // 1
return val + 2;
}).then(function(val) {
console.log(val); // 3
})
実用的な例として、もう一度このコードを見てみましょう。
get('story.json').then(function(response) {
console.log("Success!", response);
})
レスポンスは JSON ですが、現在これを書式なしテキストとして受け取っています。JSON responseType
を使用するように get 関数を変更することもできますが、Promise を使用してこれを解決することもできます。
get('story.json').then(function(response) {
return JSON.parse(response);
}).then(function(response) {
console.log("Yey JSON!", response);
})
JSON.parse()
は単一の引数を取り、変換された値を返すため、次のようなショートカットを作成できます。
get('story.json').then(JSON.parse).then(function(response) {
console.log("Yey JSON!", response);
})
実際、getJSON()
関数はとても簡単に作成できます。
function getJSON(url) {
return get(url).then(JSON.parse);
}
getJSON()
も Promise を返します。これが URL を取得し、レスポンスを JSON として解析します。
非同期処理のキューへの格納
then
を連結して、非同期アクションを順番に実行することもできます。
then()
コールバックからなんらかの値が返されると、ちょっとした魔法がおきます。値が返されると、その値を指定して次の then()
が呼び出されます。ただし、Promise に似たものが返された場合は、次の then()
はその時点で待機し、その Promise が完了(成功または失敗)した場合にのみ呼び出されます。例:
getJSON('story.json').then(function(story) {
return getJSON(story.chapterUrls[0]);
}).then(function(chapter1) {
console.log("Got chapter 1!", chapter1);
})
ここでは、story.json
に対する非同期リクエストを行っています。これはリクエストに対する一連の URL を返します。続けて、それらのうち最初の URL をリクエストしています。シンプルなコールバック パターンよりも Promise が目立ち始めます。
チャプターを取得するショートカット メソッドを作成することもできます。
var storyPromise;
function getChapter(i) {
storyPromise = storyPromise || getJSON('story.json');
return storyPromise.then(function(story) {
return getJSON(story.chapterUrls[i]);
})
}
// and using it is simple:
getChapter(0).then(function(chapter) {
console.log(chapter);
return getChapter(1);
}).then(function(chapter) {
console.log(chapter);
})
getChapter
が呼び出されるまで story.json
はダウンロードされませんが、次に getChapter
が呼び出されるときには storyPromise を再利用するため、story.json
は 1 回しか取得されません。さあ、約束です!
エラー処理
前述のように、then()
は 2 つの引数を取ります。1 つは成功用、もう 1 つは失敗(Promise の用語では履行と拒否)です。
get('story.json').then(function(response) {
console.log("Success!", response);
}, function(error) {
console.log("Failed!", error);
})
catch()
を使用することもできます。
get('story.json').then(function(response) {
console.log("Success!", response);
}).catch(function(error) {
console.log("Failed!", error);
})
catch()
には特筆すべき点はなく、then(undefined, func)
のシンタックス シュガーにすぎませんが、より読みやすくなっています。上記の 2 つのコード例の動作は同じではなく、後者は以下と同等です。
get('story.json').then(function(response) {
console.log("Success!", response);
}).then(undefined, function(error) {
console.log("Failed!", error);
})
些細な違いですが、非常に重要です。処理は Promise で棄却されると、棄却のコールバックを持つ次の then()
(または、同等である catch()
)までスキップされます。then(func1, func2)
を使用すると、func1
または func2
が呼び出され、両方は呼び出されません。ただし、then(func1).catch(func2)
を使用すると、func1
が拒否された場合に両方が呼び出されます。これは、これらが連鎖している個別のステップであるためです。次のようにします。
asyncThing1().then(function() {
return asyncThing2();
}).then(function() {
return asyncThing3();
}).catch(function(err) {
return asyncRecovery1();
}).then(function() {
return asyncThing4();
}, function(err) {
return asyncRecovery2();
}).catch(function(err) {
console.log("Don't worry about it");
}).then(function() {
console.log("All done!");
})
上記のフローは、通常の JavaScript の try と catch に非常によく似ており、「try」内で発生したエラーは即座に catch()
ブロックに入ります。次に、上記のコードをフローチャートで示します(私はフローチャートが大好きだからです)。
履行される Promise の場合は青色の線を、拒否する Promise の場合は赤い線に従ってください。
JavaScript の例外と Promise
拒否は、Promise が明示的に拒否された場合にも、コンストラクタ コールバックでエラーがスローされた場合にも暗黙的に発生します。
var jsonPromise = new Promise(function(resolve, reject) {
// JSON.parse throws an error if you feed it some
// invalid JSON, so this implicitly rejects:
resolve(JSON.parse("This ain't JSON"));
});
jsonPromise.then(function(data) {
// This never happens:
console.log("It worked!", data);
}).catch(function(err) {
// Instead, this happens:
console.log("It failed!", err);
})
これは、Promise コンストラクタ コールバック内ですべての Promise 関連処理を行うと、エラーが自動的に取得され、棄却されるため、便利であることを意味します。
then()
コールバックでスローされるエラーについても、同じことが言えます。
get('/').then(JSON.parse).then(function() {
// This never happens, '/' is an HTML page, not JSON
// so JSON.parse throws
console.log("It worked!", data);
}).catch(function(err) {
// Instead, this happens:
console.log("It failed!", err);
})
エラー処理の実例
記事と章の例では、catch を使用してユーザーにエラーを表示できます。
getJSON('story.json').then(function(story) {
return getJSON(story.chapterUrls[0]);
}).then(function(chapter1) {
addHtmlToPage(chapter1.html);
}).catch(function() {
addTextToPage("Failed to show chapter");
}).then(function() {
document.querySelector('.spinner').style.display = 'none';
})
story.chapterUrls[0]
の取得に失敗した場合(http 500 またはユーザーがオフラインの場合など)、後続の成功コールバックはすべてスキップされます。これには、レスポンスを JSON として解析しようとする getJSON()
内のコールバックや、さらに chap1.html をページに追加するコールバックもスキップされます。代わりに、catch コールバックに進みます。その結果、前述のいずれかの操作が失敗すると、「Failed to show chapter」がページに追加されます。
JavaScript の try と catch と同様に、エラーが取得され、それ以降のコードが続行されるため、スピナーは常に非表示になります。これは、期待される動作です。上記のコードは、次の要素の非ブロック非同期バージョンになります。
try {
var story = getJSONSync('story.json');
var chapter1 = getJSONSync(story.chapterUrls[0]);
addHtmlToPage(chapter1.html);
}
catch (e) {
addTextToPage("Failed to show chapter");
}
document.querySelector('.spinner').style.display = 'none'
エラーから回復せず、ロギング目的のみに catch()
を使用することもできます。これを行うには、エラーを再スローするだけです。これは getJSON()
メソッドで実行できます。
function getJSON(url) {
return get(url).then(JSON.parse).catch(function(err) {
console.log("getJSON failed for", url, err);
throw err;
});
}
これで 1 つの章を取得できましたが、すべて取得する必要があります。実現しましょう。
並列処理とシーケンシング: 両方を活用する
非同期処理を理解するのは簡単ではありません。非同期処理を記述し始めるのに苦労しているのなら、同期されているかのようにコードを記述してみてください。次のような場合があります。
try {
var story = getJSONSync('story.json');
addHtmlToPage(story.heading);
story.chapterUrls.forEach(function(chapterUrl) {
var chapter = getJSONSync(chapterUrl);
addHtmlToPage(chapter.html);
});
addTextToPage("All done");
}
catch (err) {
addTextToPage("Argh, broken: " + err.message);
}
document.querySelector('.spinner').style.display = 'none'
これで問題は解決しました。ただし、これは同期処理なので、ダウンロード中はブラウザが停止します。これを非同期処理にするには、then()
を使用して、処理が 1 つずつ順に実行されるようにします。
getJSON('story.json').then(function(story) {
addHtmlToPage(story.heading);
// TODO: for each url in story.chapterUrls, fetch & display
}).then(function() {
// And we're all done!
addTextToPage("All done");
}).catch(function(err) {
// Catch any error that happened along the way
addTextToPage("Argh, broken: " + err.message);
}).then(function() {
// Always hide the spinner
document.querySelector('.spinner').style.display = 'none';
})
しかし、チャプター URL をループして順番に取得するにはどうすればよいでしょうか。機能しません。
story.chapterUrls.forEach(function(chapterUrl) {
// Fetch chapter
getJSON(chapterUrl).then(function(chapter) {
// and add it to the page
addHtmlToPage(chapter.html);
});
})
forEach
は非同期処理に対応していないため、章はダウンロードされた任意の順番で表示されます。これは『パルプ フィクション』の製作方法と基本的に同じです。これは『パルプ フィクション』ではないので、修正しましょう。
シーケンスを作成する
chapterUrls
配列を Promise のシーケンスに変換します。そのためには、then()
を使用します。
// Start off with a promise that always resolves
var sequence = Promise.resolve();
// Loop through our chapter urls
story.chapterUrls.forEach(function(chapterUrl) {
// Add these actions to the end of the sequence
sequence = sequence.then(function() {
return getJSON(chapterUrl);
}).then(function(chapter) {
addHtmlToPage(chapter.html);
});
})
Promise.resolve()
が登場するのはこれが初めてです。これは、渡された任意の値に解決される Promise を作成します。Promise
のインスタンスを渡すと、そのまま返されます(注: これは、一部の実装ではまだ準拠されていない仕様の変更です)。これに(then()
メソッドを持つ)Promise に似たオブジェクトを渡すと、同様に解決または棄却される本物の Promise
が作成されます。その他の値(たとえば、Promise.resolve('Hello')
の場合、その値を満たすプロミスが作成されます。上記のコードのように値を渡さずに呼び出した場合は、「undefined」で解決される Promise が作成されます。
渡された値(または undefined)で拒否される Promise を作成する Promise.reject(val)
もあります。
array.reduce
を使用して、上記のコードを整理できます。
// Loop through our chapter urls
story.chapterUrls.reduce(function(sequence, chapterUrl) {
// Add these actions to the end of the sequence
return sequence.then(function() {
return getJSON(chapterUrl);
}).then(function(chapter) {
addHtmlToPage(chapter.html);
});
}, Promise.resolve())
これは、上記の例と同じ処理を行いますが、個別の「sequence」変数は必要ありません。削減コールバックは、配列内の各アイテムに対して呼び出されます。「sequence」は最初の呼び出しでは Promise.resolve()
ですが、残りの呼び出しでは、前の呼び出しから返される任意の値になります。array.reduce
は、配列を単一の値(この場合は Promise)に集約する場合に非常に便利です。
すべてをまとめると、次のようになります。
getJSON('story.json').then(function(story) {
addHtmlToPage(story.heading);
return story.chapterUrls.reduce(function(sequence, chapterUrl) {
// Once the last chapter's promise is done…
return sequence.then(function() {
// …fetch the next chapter
return getJSON(chapterUrl);
}).then(function(chapter) {
// and add it to the page
addHtmlToPage(chapter.html);
});
}, Promise.resolve());
}).then(function() {
// And we're all done!
addTextToPage("All done");
}).catch(function(err) {
// Catch any error that happened along the way
addTextToPage("Argh, broken: " + err.message);
}).then(function() {
// Always hide the spinner
document.querySelector('.spinner').style.display = 'none';
})
これで、同期バージョンが完全に非同期になりました。ただし、まだ改善の余地があります。現時点で、ページは次のようにダウンロードされます。
ブラウザは複数のものを一度にダウンロードするのに適しているため、章を 1 つずつダウンロードすることでパフォーマンスが損なわれています。目標は、すべての章を同時にダウンロードして、ダウンロードが完了した時点で処理することです。幸いなことに、このための API があります。
Promise.all(arrayOfPromises).then(function(arrayOfResults) {
//...
})
Promise.all
は、Promise の配列を取得して、すべてが正常に完了したら解決される Promise を作成します。結果(Promise で解決された任意の値)の配列を、Promise を渡したのと同じ順序で取得します。
getJSON('story.json').then(function(story) {
addHtmlToPage(story.heading);
// Take an array of promises and wait on them all
return Promise.all(
// Map our array of chapter urls to
// an array of chapter json promises
story.chapterUrls.map(getJSON)
);
}).then(function(chapters) {
// Now we have the chapters jsons in order! Loop through…
chapters.forEach(function(chapter) {
// …and add to the page
addHtmlToPage(chapter.html);
});
addTextToPage("All done");
}).catch(function(err) {
// catch any error that happened so far
addTextToPage("Argh, broken: " + err.message);
}).then(function() {
document.querySelector('.spinner').style.display = 'none';
})
接続によっては、これは 1 つずつ読み込むよりも数秒速くなり、最初に試したものよりコードが少なくなります。章は任意の順序でダウンロードされますが、画面上には正しい順序で表示されます。
ただし、知覚されるパフォーマンスは改善できます。第 1 章がダウンロードされたら、これをページに追加します。こうすることで、ユーザーは残りの章がダウンロードされるより前に第 1 章を読み始めます。第 3 章がダウンロードされても、ユーザーは第 2 章がないことに気付いていない可能性があるため、ページには追加しません。第 2 章がダウンロードされたら、第 2 章と第 3 章を追加できます。これ以降の章についても同様です。
これを行うには、すべての章について同時に JSON を取得してから、それらの章をドキュメントに追加するシーケンスを作成します。
getJSON('story.json')
.then(function(story) {
addHtmlToPage(story.heading);
// Map our array of chapter urls to
// an array of chapter json promises.
// This makes sure they all download in parallel.
return story.chapterUrls.map(getJSON)
.reduce(function(sequence, chapterPromise) {
// Use reduce to chain the promises together,
// adding content to the page for each chapter
return sequence
.then(function() {
// Wait for everything in the sequence so far,
// then wait for this chapter to arrive.
return chapterPromise;
}).then(function(chapter) {
addHtmlToPage(chapter.html);
});
}, Promise.resolve());
}).then(function() {
addTextToPage("All done");
}).catch(function(err) {
// catch any error that happened along the way
addTextToPage("Argh, broken: " + err.message);
}).then(function() {
document.querySelector('.spinner').style.display = 'none';
})
これで、両方の長所を取り入れたコードが完成しました。これはすべてのコンテンツを配信するのと同じ時間がかかりますが、ユーザーはコンテンツの最初の部分をより早く読み始めることができます。
この簡単な例では、すべての章がほぼ同時にダウンロードされましたが、章の数やボリュームが増えれば、章を一度に 1 つずつ表示することの利点もより大きくなります。
Node.js スタイルのコールバックまたはイベントを使用して上記のコードと同じことを実現しようとすると、コードの量は約 2 倍になります。さらに重大なのは、コードを追うのが難しくなることです。ただし、Promise の話はこれで終わりではありません。他の ES6 機能と組み合わせると、さらに使いやすくなります。
ボーナス ラウンド: 拡張機能
この記事を最初に書いたときから、Promise の使用機能は大幅に拡大されています。Chrome 55 以降、非同期関数を使用すると、あたかも同期コードのように Promise ベースのコードを記述でき、しかもメインスレッドをブロックすることがありません。詳しくは、非同期関数に関する記事をご覧ください。主要なブラウザでは、Promise と非同期関数の両方が広くサポートされています。詳細については、MDN の Promise と 非同期関数のリファレンスをご覧ください。
この記事を校閲して修正し、助言をくれた Anne van Kesteren、Domenic Denicola、Tom Ashworth、Remy Sharp、Addy Osmani、Arthur Evans、Yutaka Hirano に感謝します。
また、Mathias Bynens にも、この記事のさまざまな部分を更新してくれたことのお礼を述べます。