Day 7:JavaScriptの非同期処理
Webページやアプリでは、サーバーからデータを取得したり、ファイルを読み込んだりする処理があります。こうした処理には時間がかかることがあるため、終わるまでプログラム全体を止めずに進める仕組みが必要です。それが非同期処理です。
この日は、同期処理との違い、Promise、asyncとawait、tryとcatchを学び、APIからデータを取得するプログラムを作ります。ここでいうAPIは、アプリ同士がデータをやり取りするための窓口です。
1. 同期処理とは
同期処理は、基本的に書かれた順番に処理を進めます。前の処理が終わってから、次の処理を実行します。
// 1つ目のメッセージを表示します
console.log("1. はじめます");
// 2つ目のメッセージを表示します
console.log("2. 処理中です");
// 3つ目のメッセージを表示します
console.log("3. 終わります");JavaScript実行すると、次の順番で表示されます。
1. はじめます
2. 処理中です
3. 終わります
計算など、すぐに終わる処理なら同期的に実行して問題ありません。しかし、ネットワーク通信のように終わるまで時間がかかる処理では、結果を待つ間、ほかの処理も進められるほうが便利です。
2. 非同期処理とは
非同期処理は、時間のかかる処理の完了を待つ間に、ほかの処理も進められるようにする仕組みです。API通信、タイマー、ファイル読み込みなどで使われます。
たとえば、サーバーにデータを取りに行く場合、通信には時間がかかります。非同期処理を使うと、通信が完了するまで画面やプログラム全体を止めず、完了後に結果を扱えます。
// 1つ目のメッセージを表示します
console.log("1. はじめます");
// 1秒後に実行する処理を予約します
setTimeout(() => {
// タイマーの完了後に表示します
console.log("3. 1秒後の処理が終わりました");
}, 1000);
// タイマーの完了を待たずに表示されます
console.log("2. 待っている間に進む処理です");JavaScript表示順は、コードの上から順とは異なります。
1. はじめます
2. 待っている間に進む処理です
3. 1秒後の処理が終わりました
setTimeout()は、指定した時間の後に処理を実行するよう予約します。タイマーを待っている間も、その次のコードを実行できることが分かります。
3. Promiseとは
非同期処理の結果を受け取る仕組みのひとつがPromiseです。Promiseは、まだ結果が決まっていない処理を表すオブジェクトです。
Promiseには、主に次の状態があります。
- pending:処理中で、結果がまだ決まっていません。
- fulfilled:処理が成功し、結果が得られました。
- rejected:処理が失敗しました。
たとえば、API通信を始めた直後はpending、通信に成功すればfulfilled、ネットワーク障害などで失敗すればrejectedになります。
4. Promiseを.then()で扱う
Promiseの成功後に実行する処理は、.then()で書けます。失敗した場合の処理には.catch()を使います。
// 1秒後に"完了"を返すPromiseを作ります
const task = new Promise((resolve) => {
// 1秒後に成功した結果を返します
setTimeout(() => {
resolve("完了しました");
}, 1000);
});
// Promiseが成功したときに実行する処理を登録します
task.then((result) => {
// resolveから返された値を表示します
console.log(result);
});JavaScriptresolve()は成功した結果を返し、reject()は失敗した結果を返すために使います。自分でPromiseを作る方法はありますが、まずはfetch()などが返すPromiseを利用することが多いと覚えておきましょう。
5. asyncとawait
asyncとawaitを使うと、Promiseを扱う処理を、順番に進むコードのような形で書けます。
- `async`は、関数を非同期関数として定義します。
- `await`は、Promiseの結果が確定するまで、その関数内の次の処理を待ちます。
// asyncを付けて非同期関数を定義します
async function getMessage() {
// Promiseの結果が得られるまで待ちます
const message = await Promise.resolve("こんにちは");
// 受け取った結果を表示します
console.log(message);
}
// 非同期関数を呼び出します
getMessage();JavaScriptawaitは基本的にasync関数の中で使います。awaitを使った行の結果が確定してから、同じ関数内の次の行へ進みます。
async関数は、必ずPromiseを返します。関数内で普通の値をreturnした場合も、その値を包んだPromiseが返されます。
// async関数はPromiseを返します
async function getNumber() {
// 返した数値はPromiseの結果になります
return 42;
}
// Promiseが成功した後に結果を受け取ります
getNumber().then((number) => {
// 返された数値を表示します
console.log(number); // 42
});JavaScript6. APIからデータを取得する
ブラウザーや対応するNode.js環境では、fetch()を使ってAPIにリクエストを送れます。以下では、練習用の公開APIから記事データを1件取得します。
ファイルをday7.jsとして保存し、Node.jsで実行する場合は、ターミナルで次のコマンドを使います。
# day7.jsをNode.jsで実行します
node day7.js
次のコードでは、APIへリクエストを送り、返ってきたデータをJSONとして読み込みます。
// APIから記事を1件取得する非同期関数です
async function getPost() {
// APIにリクエストを送り、応答を待ちます
const response = await fetch(
"https://jsonplaceholder.typicode.com/posts/1"
);
// 応答の本文をJSONとして読み取ります
const post = await response.json();
// 取得した記事のタイトルを表示します
console.log(post.title);
}
// 非同期関数を呼び出します
getPost();JavaScriptfetch()はPromiseを返すので、await fetch(...)で応答を待てます。response.json()も、応答本文を読み取ってJSONデータに変換する非同期処理なので、こちらにもawaitが必要です。
APIから返るデータは、たとえば次のようなオブジェクトです。
// APIから返るデータの一例です
const post = {
userId: 1,
id: 1,
title: "記事のタイトル",
body: "記事本文のサンプルです。",
};JavaScript7. tryとcatchでエラーを扱う
通信ができない、サーバーに接続できない、JSONの読み込みに失敗するなど、非同期処理が失敗することがあります。そのようなエラーを扱うには、tryとcatchを使います。
// APIから記事を取得する非同期関数です
async function getPost() {
try {
// APIにリクエストを送り、応答を待ちます
const response = await fetch(
"https://jsonplaceholder.typicode.com/posts/1"
);
// 応答本文をJSONとして読み取ります
const post = await response.json();
// 記事タイトルを表示します
console.log(post.title);
} catch (error) {
// try内で発生したエラーを受け取り、メッセージを表示します
console.error("データの取得に失敗しました", error);
}
}
// 非同期関数を呼び出します
getPost();JavaScripttryの中に、失敗する可能性がある処理を書きます。エラーが起きるとcatchに処理が移るので、プログラムが突然止まるのを防ぎ、利用者向けのメッセージや再試行の案内を出せます。
fetch()ではHTTPエラーを確認する
重要な注意点があります。fetch()は、通信自体ができた場合、HTTPステータスが404や500でもPromiseが成功したものとして応答を返します。そのため、tryとcatchだけでは、サーバーのエラーを検知できない場合があります。
response.okを確認し、応答が成功範囲でなければ自分でエラーを発生させます。
// APIから記事を取得し、HTTPエラーも確認する関数です
async function getPost() {
try {
// APIにリクエストを送り、応答を待ちます
const response = await fetch(
"https://jsonplaceholder.typicode.com/posts/1"
);
// HTTPステータスが成功範囲でなければエラーにします
if (!response.ok) {
throw new Error(`HTTPエラー: ${response.status}`);
}
// 応答本文をJSONとして読み取ります
const post = await response.json();
// 記事の情報を表示します
console.log(`タイトル:${post.title}`);
console.log(`本文:${post.body}`);
} catch (error) {
// 通信やHTTPエラーなどを受け取ります
console.error("記事を取得できませんでした", error);
}
}
// 関数を呼び出します
getPost();JavaScriptthrow new Error(...)は、エラーを発生させる書き方です。ここでは、response.okがfalseのときにエラーを発生させ、catchで処理しています。
8. 実践課題:APIから記事一覧を取得する
次は、複数の記事を取得して、タイトルを一覧表示します。map()で表示用の文字列を作ることで、Day 4・Day 5の学習内容も復習できます。
// APIから記事一覧を取得する非同期関数です
async function getPosts() {
try {
// 記事一覧のAPIにリクエストを送ります
const response = await fetch(
"https://jsonplaceholder.typicode.com/posts"
);
// HTTPエラーがあれば処理を中断してcatchに進みます
if (!response.ok) {
throw new Error(`HTTPエラー: ${response.status}`);
}
// 応答本文をJSONとして読み込みます
const posts = await response.json();
// 各記事をタイトル付きの表示文字列に変換します
const postTitles = posts.map((post) => {
// 記事IDとタイトルを返します
return `${post.id}: ${post.title}`;
});
// 取得した記事一覧を表示します
postTitles.forEach((title) => {
// タイトルを1件ずつ表示します
console.log(title);
});
} catch (error) {
// エラーの内容をターミナルに表示します
console.error("記事一覧を取得できませんでした", error);
}
}
// 記事一覧の取得を開始します
getPosts();JavaScriptAPIから返るデータは、通信先が決めた形式に従います。想定と異なるデータが返る可能性もあるため、実際のアプリでは、データの形式が正しいかどうかを確認してから画面に表示することも重要です。
9. 読み込み中・成功・失敗を考える
APIを使う画面では、データがすぐ届くとは限りません。画面を作るときは、少なくとも次の状態を考えると使いやすくなります。
- 読み込み中:リクエスト中で、まだ結果が届いていません。
- 成功:データを受け取り、表示できます。
- 失敗:通信やサーバーの問題でデータを取得できませんでした。
ターミナルで動かす学習コードでは、console.log()やconsole.error()で確認できます。Reactでは、これらの状態をuseStateなどで管理し、「読み込み中です」「データを表示する」「エラーが発生しました」と画面を切り替えます。
10. 非同期処理を順番に実行する場合と並行実行する場合
2つ目の処理が1つ目の結果を必要とするなら、awaitで順番に実行します。
// 1つ目の処理が終わってから、2つ目を始める例です
async function loadDataInOrder() {
// 先にユーザー情報を取得します
const user = await getUser();
// userのIDが必要なので、その後に記事を取得します
const posts = await getPostsByUserId(user.id);
// 取得したデータを使います
console.log(user, posts);
}JavaScript一方、互いに依存しない複数のAPIを取得する場合は、Promise.all()を使って並行して待つ方法があります。
// 独立した2つのデータを並行して取得する例です
async function loadIndependentData() {
try {
// 2つのAPIリクエストを並行して開始し、両方の完了を待ちます
const [usersResponse, postsResponse] = await Promise.all([
fetch("https://jsonplaceholder.typicode.com/users"),
fetch("https://jsonplaceholder.typicode.com/posts"),
]);
// どちらかのHTTP応答が失敗ならエラーにします
if (!usersResponse.ok || !postsResponse.ok) {
throw new Error("いずれかのAPIでHTTPエラーが発生しました");
}
// 2つの応答本文をJSONとして読み取ります
const [users, posts] = await Promise.all([
usersResponse.json(),
postsResponse.json(),
]);
// データ件数を表示します
console.log(`ユーザー数:${users.length}`);
console.log(`記事数:${posts.length}`);
} catch (error) {
// いずれかの処理で発生したエラーを表示します
console.error("データを取得できませんでした", error);
}
}
// 関数を呼び出します
loadIndependentData();JavaScriptPromise.all()は、渡したすべてのPromiseが成功すると結果をまとめて返します。どれかひとつが失敗した場合は、全体が失敗として扱われます。初めは通常のawaitを理解してから、必要に応じて並行処理に使いましょう。
11. よくあるつまずき
awaitを書き忘れる
fetch()の戻り値はPromiseです。awaitを付けずにそのままJSONとして扱おうとすると、期待したデータではなくPromiseを扱ってしまいます。
// awaitがないため、responseはPromiseのままです
const response = fetch("https://jsonplaceholder.typicode.com/posts/1");
// 正しくはawaitで応答を待ちます
// const response = await fetch("https://jsonplaceholder.typicode.com/posts/1");JavaScriptresponse.json()にもawaitが必要
応答を受け取った後、JSON本文を読み取る処理も非同期です。結果を使う前にawaitで待ちます。
// response.json()の完了を待たずに変数へ入れると、Promiseになります
const postPromise = response.json();
// 正しくは完了を待って、読み取られたデータを受け取ります
const post = await response.json();JavaScriptcatchがない
エラーを処理しないと、利用者に何が起きたのか分かりにくくなります。通信を使う関数には、適切なエラー処理を用意しましょう。
fetch()が成功したからAPIも成功とは限らない
通信が成立しても、APIが404や500を返すことがあります。response.okを確認する習慣をつけましょう。
12. セキュリティと実務での注意点
APIを使うときは、次の点も意識してください。
- APIキーやパスワードなどの秘密情報を、公開されるフロントエンドのコードに直接書かないでください。
- APIから受け取ったデータは、想定した形式や値か確認してから利用します。
- 実在するユーザーの個人情報を、練習用の公開コードやログに載せないようにします。
- APIの利用規約やアクセス制限を確認し、短時間に大量のリクエストを送らないようにします。
ブラウザーで動くコードに秘密情報を埋め込むと、利用者から見られる可能性があります。秘密情報が必要なAPIでは、サーバー側で安全に扱う方法を検討します。
13. 練習用テンプレート
次のテンプレートのTODO部分を埋め、記事のタイトルと本文を表示してみましょう。
// APIから記事を取得する非同期関数です
async function getPostById(postId) {
try {
// TODO: postIdを使ってAPIにリクエストを送ります
const response = await fetch(
`https://jsonplaceholder.typicode.com/posts/${postId}`
);
// TODO: response.okを確認し、失敗時はエラーを発生させます
if (!response.ok) {
throw new Error(`HTTPエラー: ${response.status}`);
}
// TODO: 応答本文をJSONとして読み込みます
const post = await response.json();
// 記事タイトルと本文を表示します
console.log(`タイトル:${post.title}`);
console.log(`本文:${post.body}`);
} catch (error) {
// TODO: 取得失敗時のメッセージを表示します
console.error("記事を取得できませんでした", error);
}
}
// IDが1の記事を取得します
getPostById(1);JavaScript練習するときは、getPostById(1)の数字を変えてみてください。また、存在しないIDを指定し、API応答がどうなるか、エラー処理が想定どおり動くかも確認しましょう。
14. Day 7のチェックリスト
- 同期処理と非同期処理の違いを説明できます。
- Promiseの「処理中・成功・失敗」という状態を理解しています。
async関数とawaitで非同期処理を書けます。tryとcatchでエラーを扱えます。fetch()でAPIにリクエストを送り、response.json()でデータを読み取れます。response.okでHTTPエラーを確認できます。- APIの応答が成功する場合だけでなく、失敗する場合の処理も用意できます。
- 秘密情報をフロントエンドのコードに直接書かない理由が分かります。
非同期処理では、処理の結果がいつ届くか、成功したか失敗したかを考える必要があります。まずは「awaitで結果を待つ」「tryとcatchで失敗を扱う」「response.okでHTTP応答を確認する」の3点を身につけましょう。この考え方は、ReactやNext.jsでAPIからデータを取得するときの基礎になります。
