- Day 21:useEffectでAPIからデータを取得する
- 1. 副作用とは
- 2. useEffectの基本形
- 3. 依存配列の違い
- 4. cleanupとは
- 5. Next.jsでAPI取得を練習する
- 6. API取得の流れを作る
- 7. ブログ一覧を取得するコード
- 8. async関数をEffectの外側に書く理由
- 9. APIのレスポンスを確認する
- 10. cleanupとAbortController
- 11. Strict ModeでAPIが複数回呼ばれることがある
- 12. useEffectは何にでも使わない
- 13. Next.jsでAPIを取得する方法の選び方
- 14. よくあるつまずき
- 15. 練習用テンプレート
- 16. Day 21のチェックリスト
Day 21:useEffectでAPIからデータを取得する
useEffectは、ReactコンポーネントをブラウザーのAPIやネットワークなど、Reactの外にある仕組みと同期させるためのHookです。この日は、依存配列やcleanupの役割を学び、APIからデータを取得して一覧表示します。(🔗 react.dev)
Next.jsでは、初期表示に必要なデータはサーバー側で取得する方法がよく選ばれます。今回はuseEffectを学ぶため、ブラウザー側でAPIを取得する練習をします。(🔗 nextjs.org)
1. 副作用とは
Reactコンポーネントは、StateやPropsをもとに画面を表示します。一方、APIからデータを取得する、タイマーを開始する、ブラウザーイベントを登録するといった処理は、画面表示だけでは完結しない処理です。こうした処理を副作用(side effect)と呼びます。
- APIからデータを取得する
- タイマーを開始・停止する
- ブラウザーのイベントを登録・解除する
- 外部のサービスやウィジェットと接続する
データから表示内容を計算するだけなら、必ずしもuseEffectは必要ありません。useEffectは、Reactの外にあるものとの同期が必要なときに使います。(🔗 react.dev)
2. useEffectの基本形
useEffectは、Reactから読み込み、コンポーネントの中で呼び出します。
// ReactからuseEffectを読み込みます
import { useEffect } from "react";
// Effectを試すコンポーネントです
function Example() {
// コンポーネントが表示された後に実行する処理を登録します
useEffect(() => {
// 外部システムと同期する処理をここに書きます
console.log("Effectが実行されました");
}, []);
// コンポーネントの画面を返します
return <p>useEffectの例</p>;
}JSXuseEffectは、画面の描画に関わる処理が行われた後に実行されます。Effect内でStateを更新すると、そのStateを使って画面が再び描画されます。
3. 依存配列の違い
useEffectの第2引数は依存配列です。配列に何を書くかによって、Effectが実行されるタイミングが変わります。Reactは依存値を前回の値と比較し、変化したかどうかを判断します。(🔗 react.dev)
依存配列を省略する
// 依存配列を省略した例です
useEffect(() => {
// コンポーネントが更新されるたびに実行されます
});JSX依存配列を省略すると、コンポーネントが再描画されるたびにEffectが実行されます。Effect内でStateを更新すると何度も再描画され、処理が繰り返されることがあるため、意図していない限り注意が必要です。
空の依存配列[]を渡す
// 空の依存配列を渡した例です
useEffect(() => {
// 初回表示後に実行する処理を書きます
}, []);JSX依存値がないEffectは、通常、コンポーネントが表示された後に実行されます。開発時にStrict Modeが有効だと、ReactがEffectのsetupとcleanupを追加で実行し、問題がないか確認する場合があります。開発中にログが2回出ても、必ずしも本番環境で同じ回数実行されるという意味ではありません。cleanupを適切に書き、Effectが複数回実行されても安全に動くようにします。(🔗 react.dev)
依存値を指定する
// roomIdが変わったときにもEffectを再実行する例です
useEffect(() => {
// 現在のroomIdを使って外部システムと同期します
console.log(`接続先:${roomId}`);
}, [roomId]);JSXEffect内で使うPropsやStateなどの値は、依存配列に含めます。依存配列は実行回数を手動で制限するためのものではなく、Effectが参照している値をReactに伝えるものです。(🔗 react.dev)
4. cleanupとは
Effectで開始した処理を止めたり、解除したりする関数をcleanup関数と呼びます。useEffectから関数を返す形で書きます。
// タイマーを開始し、不要になったら止める例です
useEffect(() => {
// 1秒ごとに時刻をログへ出すタイマーを開始します
const timerId = window.setInterval(() => {
console.log("タイマーが動作中です");
}, 1000);
// cleanup関数を返します
return () => {
// コンポーネントが不要になったときにタイマーを止めます
window.clearInterval(timerId);
};
}, []);JSXcleanupは、コンポーネントが画面から外れるときだけでなく、依存値が変わってEffectを再実行する前にも呼ばれます。Effectが始めた処理を、cleanupで止めたり取り消したりするのが基本です。(🔗 react.dev)
5. Next.jsでAPI取得を練習する
App Routerのページは、特別な指定がない場合、サーバー側のコンポーネントとして扱われます。ブラウザーのイベントやuseState、useEffectを使う場合は、Client Componentにします。ファイルの先頭に'use client'を記述します。(🔗 nextjs.org)
今回は、app/page.jsまたはsrc/app/page.jsにコードを書きます。API取得の練習には、Next.js公式資料に例として登場するブログAPIを使います。(🔗 nextjs.org)
6. API取得の流れを作る
データ取得の処理では、次の状態を分けて管理します。
- 読み込み中:APIの応答を待っています。
- 成功:データを受け取り、表示しています。
- 失敗:通信や応答の処理に問題がありました。
この区別がないと、データがまだ届いていないのか、取得に失敗したのかが画面を見ても分かりません。
7. ブログ一覧を取得するコード
以下をapp/page.jsまたはsrc/app/page.jsに記述します。この例では、最初の表示後にAPIを呼び出し、取得したブログのタイトルを一覧表示します。
// このファイルをClient Componentとして扱います
"use client";
// ReactのStateとEffectを読み込みます
import { useEffect, useState } from "react";
// APIから取得する記事の型を意識したデータです
// JavaScriptでは型宣言は不要ですが、構造を把握するためのコメントです
// { id: number, title: string, ... }
// ブログ記事を取得して表示するページです
export default function BlogPage() {
// 取得した記事の配列を管理します
const [posts, setPosts] = useState([]);
// 読み込み中かどうかを管理します
const [isLoading, setIsLoading] = useState(true);
// 取得に失敗したときのメッセージを管理します
const [errorMessage, setErrorMessage] = useState("");
// 初回表示後にAPIから記事を取得します
useEffect(() => {
// 通信を中断するためのコントローラーを作ります
const controller = new AbortController();
// 非同期関数の中でAPI通信を行います
async function fetchPosts() {
try {
// APIにリクエストを送り、cleanup時に中断できるようsignalを渡します
const response = await fetch("https://api.vercel.app/blog", {
signal: controller.signal,
});
// HTTPエラーの場合は例外にしてcatchへ進めます
if (!response.ok) {
throw new Error(`HTTPエラー:${response.status}`);
}
// レスポンスのJSONをJavaScriptのデータに変換します
const data = await response.json();
// 受け取ったデータが配列か確認してからStateに保存します
if (!Array.isArray(data)) {
throw new Error("APIから想定外のデータが返されました。");
}
// 取得した記事をStateに保存します
setPosts(data);
} catch (error) {
// cleanupで通信を中断した場合は、エラー表示を行いません
if (error.name === "AbortError") {
return;
}
// それ以外のエラーは画面表示用のメッセージにします
setErrorMessage("記事を読み込めませんでした。時間をおいて再度お試しください。");
} finally {
// 通信が完了したら読み込み状態を終了します
// 中断された場合に画面がすでに外れていることもあるため、
// 通常の完了時だけStateを更新します
if (!controller.signal.aborted) {
setIsLoading(false);
}
}
}
// API取得を開始します
fetchPosts();
// コンポーネントが外れるときに通信を中断します
return () => {
controller.abort();
};
}, []);
// 読み込み中の表示です
if (isLoading) {
return (
<main>
<h1>ブログ記事</h1>
<p aria-live="polite">記事を読み込んでいます...</p>
</main>
);
}
// エラーがある場合の表示です
if (errorMessage !== "") {
return (
<main>
<h1>ブログ記事</h1>
<p role="alert">{errorMessage}</p>
</main>
);
}
// データが取得できた場合の一覧表示です
return (
<main>
<h1>ブログ記事</h1>
{/* map()で記事を一覧にします */}
<ul>
{posts.map((post) => (
// APIから取得したidを各項目のkeyとして使います
<li key={post.id}>
<h2>{post.title}</h2>
</li>
))}
</ul>
{/* 配列が空の場合に案内を表示します */}
{posts.length === 0 && <p>表示できる記事はありません。</p>}
</main>
);
}JSX8. async関数をEffectの外側に書く理由
useEffectのコールバック関数そのものをasyncにすると、Promiseを返す関数になります。一方、EffectのコールバックからReactが受け取るものは、cleanup関数または何も返さない値である必要があります。そのため、Effectの中で非同期関数を定義し、それを呼び出す形にします。
// Effectのコールバック自体はasyncにしません
useEffect(() => {
// 非同期処理を別関数にまとめます
async function loadData() {
// awaitを使う通信処理をここに書きます
}
// 非同期関数を実行します
loadData();
}, []);JSX9. APIのレスポンスを確認する
APIから受け取ったデータは、期待した構造になっているかを考えて使います。上の例では、配列であることを確認してからpostsに保存し、記事のidとtitleを表示しています。
// 記事データをひとつ表示する例です
<li key={post.id}>
<h2>{post.title}</h2>
</li>JSXAPIのレスポンスが想定と違う場合に、map is not a functionなどのエラーが出ることがあります。APIの仕様を確認し、データ形式を必要に応じて検証してください。
10. cleanupとAbortController
API取得中にページを離れたり、依存値が変わって別の取得を始めたりすることがあります。AbortControllerを使うと、不要になった通信を中断できます。(🔗 react.dev)
// 通信を中断できるようにします
const controller = new AbortController();
// fetchにsignalを渡すと、中断操作が反映されます
fetch(url, { signal: controller.signal });
// 不要になったら通信を中断します
controller.abort();JSX上の完成コードでは、Effectのcleanupでcontroller.abort()を呼んでいます。通信が中断されたときのAbortErrorは、通常の取得失敗と分けて扱っています。
11. Strict ModeでAPIが複数回呼ばれることがある
開発環境でStrict Modeが有効な場合、ReactはEffectのsetupとcleanupを追加で実行し、cleanupが適切か確認することがあります。その結果、開発中にAPIリクエストが複数回見えることがあります。これはEffectを安全に書けているか確認するための動作で、本番環境で同じ挙動になるとは限りません。(🔗 react.dev)
「一度だけ実行したい」と無理に抑え込むより、Effectが複数回開始・終了しても正しく動く設計にします。API通信の重複排除やキャッシュが必要になるアプリでは、データ取得用ライブラリを検討します。
12. useEffectは何にでも使わない
Stateから表示用の値を計算できる場合は、useEffectで別のStateへコピーする必要はありません。たとえば、記事の件数は次のように直接計算できます。
// postsの数から件数を計算します
const postCount = posts.length;JSXこの件数をさらにStateへ保存し、Effectで同期するのは避けましょう。データの重複を減らすと、値の食い違いも防げます。Effectは、主にネットワークやブラウザー機能など外部システムとの同期に使います。(🔗 react.dev)
13. Next.jsでAPIを取得する方法の選び方
このレッスンではuseEffectを使うために、ブラウザー側でデータを取得しました。ただし、Next.jsでは最初の画面に必要なデータをサーバー側で取得する方法が一般に推奨されます。クライアント側取得は、利用者の操作後に取得したいデータ、頻繁に更新されるデータなどに向いています。(🔗 nextjs.org)
- ページの初期表示に必要なデータ:Server Componentでの取得を検討します。
- 入力や操作に応じてブラウザーから取得するデータ:Client Componentでの取得を検討します。
- キャッシュ、再取得、複数コンポーネント間での共有が必要:データ取得用ライブラリを検討します。
14. よくあるつまずき
- Effectを使うファイルに`’use client’`がない:App Routerでは、Client Componentのファイル先頭に指定します。
- Effect内の非同期処理を書けない:Effect関数自体を`async`にせず、中で非同期関数を定義して実行します。
- 読み込み中の表示がない:初期状態を`isLoading`で管理し、完了まで案内を表示します。
- HTTPエラーを見落とす:`fetch`はHTTP 404や500だけでは必ずしも例外にならないため、`response.ok`を確認します。
- 依存配列が不足している:Effect内で使うPropsやStateなどを依存配列に含めます。
- 画面を離れた後も通信が続く:必要に応じてcleanupで`AbortController`を使います。
- API取得のたびにEffectが繰り返される:依存配列や、Effect内で更新しているStateを確認します。
15. 練習用テンプレート
次のテンプレートを完成させ、APIデータを一覧表示してみましょう。
// Reactから必要なHookを読み込みます
import { useEffect, useState } from "react";
// API取得を練習するコンポーネントです
export default function ApiPractice() {
// TODO: データを保存するStateを作ります
// TODO: ローディング状態を保存するStateを作ります
// TODO: エラーメッセージを保存するStateを作ります
// TODO: useEffect内でfetchを実行します
// TODO: response.okを確認します
// TODO: JSONを読み取り、Stateに保存します
// TODO: cleanupで不要な通信を中断できるようにします
// TODO: ローディング、エラー、データ一覧を条件に応じて表示します
return <main><h1>APIデータ</h1></main>;
}JSX16. Day 21のチェックリスト
- `useEffect`がReactの外にある仕組みとの同期に使われることを説明できます。
- 依存配列を省略した場合、空配列、値を指定した場合の違いを理解しています。
- Effect内で使うPropsやStateなどを依存配列に含めると分かっています。
- cleanup関数が再実行前やコンポーネントが外れるときに呼ばれることを理解しています。
- API取得でローディング、成功、エラーを分けて表示できます。
- `fetch`後に`response.ok`を確認できます。
- 不要になった通信を`AbortController`で中断できます。
- Next.jsでは初期表示のデータ取得にサーバー側取得も検討すると分かっています。
useEffectを使ったAPI取得では、取得中・成功・失敗の状態を分け、依存配列とcleanupを適切に扱います。今回はブラウザー側で取得する練習をしましたが、Next.jsでは初期表示に必要なデータをサーバー側で取得する方法も重要です。目的に応じて取得場所を選び、Effectを外部システムとの同期に使う習慣を身につけましょう。
