Day 28:Custom Hooksを作る
Custom Hook(カスタムHook)は、ReactのHookを使った処理を関数としてまとめ、複数のコンポーネントで再利用する仕組みです。この日は、useToggle、useLocalStorage、useFetchの3つを作り、Next.jsのページで使います。
カスタムHookを使うと、状態管理や通信の手順をコンポーネントから切り離せます。ただし、Hookを再利用しても、呼び出したコンポーネント同士でStateが自動的に共有されるわけではありません。同じ処理の書き方を再利用する仕組みと、ひとつの状態を共有する仕組みは別です。
1. Custom Hookの基本
Custom Hookは、名前をuseから始める関数です。中でuseStateやuseEffectなどのHookを使えます。
// ReactのHookをまとめて使うカスタムHookの例です
function useExample() {
// Hookを使って状態や処理をまとめます
const [value, setValue] = useState("");
// 呼び出し元に必要な値や関数を返します
return { value, setValue };
}JSX通常の関数との大きな違いは、カスタムHook自身がReactのHookを使えることです。呼び出す側は、内部の処理を毎回書かずに済みます。
2. Hookのルール
カスタムHookも、通常のHookと同じルールに従います。
- Reactコンポーネントか、別のカスタムHookの中で呼び出します。
if文やループの中など、条件によって呼び出したり呼び出さなかったりしないようにします。- コンポーネントのトップレベルで、毎回同じ順番で呼び出します。
次のように条件の中でHookを呼び出すのは避けます。
// 避ける例:条件によってHookを呼ぶかどうかが変わります
if (isReady) {
const [value, setValue] = useState("");
}JSX条件によって処理を変えたい場合も、Hook自体はコンポーネントのトップレベルで呼び出し、その中の処理を条件分岐します。
3. ファイルを用意する
Next.js App Routerでは、カスタムHookをhooksフォルダーに置くと整理しやすくなります。
my-app/
├── app/
│ └── page.js
└── hooks/
├── useToggle.js
├── useLocalStorage.js
└── useFetch.js
srcフォルダーを使っている場合は、src/hooksに置いても構いません。
4. Hook 1:useToggleを作る
useToggleは、開閉状態やオン・オフ状態の切り替えを再利用するHookです。メニューの表示、詳細欄の開閉などに使えます。
hooks/useToggle.jsを作成します。
// Reactの状態管理と関数を安定させるHookを読み込みます
import { useCallback, useState } from "react";
// 真偽値の切り替えを管理するカスタムHookです
export function useToggle(initialValue = false) {
// 初期値を使ってオン・オフ状態を管理します
const [isOn, setIsOn] = useState(initialValue);
// 現在の状態を反転します
const toggle = useCallback(() => {
// 前の状態を使って反転するため、最新の値を安全に扱えます
setIsOn((currentValue) => !currentValue);
}, []);
// 状態をオンにします
const turnOn = useCallback(() => {
setIsOn(true);
}, []);
// 状態をオフにします
const turnOff = useCallback(() => {
setIsOn(false);
}, []);
// 状態と操作関数を呼び出し元へ返します
return {
isOn,
toggle,
turnOn,
turnOff,
};
}JSXコンポーネントでは、次のように使えます。
// useToggleを読み込みます
import { useToggle } from "../hooks/useToggle.js";
// 開閉するパネルの例です
function DetailsPanel() {
// 初期状態を閉じた状態にします
const { isOn, toggle } = useToggle(false);
return (
<section>
{/* 押すたびに表示状態を切り替えます */}
<button type="button" onClick={toggle}>
{isOn ? "詳細を閉じる" : "詳細を開く"}
</button>
{/* isOnがtrueのときだけ詳細を表示します */}
{isOn && <p>ここに詳細情報を表示します。</p>}
</section>
);
}JSXuseToggleを2つのコンポーネントで使うと、それぞれに独立したStateが作られます。共有したい状態なら、Contextや親コンポーネントのStateなど別の方法が必要です。
5. Hook 2:useLocalStorageを作る
useLocalStorageは、Stateを更新するとブラウザーのLocalStorageにも保存するHookです。ページを再読み込みしても、保存した値が残ります。
localStorageはブラウザーにある機能で、Next.jsのサーバーにはありません。コンポーネントの初回表示ではサーバーとブラウザーの表示が一致する必要があるため、最初のレンダー中にlocalStorageを読まないようにします。ここでは初回表示後のuseEffectで読み込みます。
hooks/useLocalStorage.jsを作成します。
// ReactのStateとEffectを読み込みます
import { useEffect, useState } from "react";
// StateをLocalStorageと同期するカスタムHookです
export function useLocalStorage(key, initialValue) {
// 最初はサーバーとブラウザーで同じ初期値を使います
const [value, setValue] = useState(initialValue);
// LocalStorageの読み込みが終わったかを管理します
const [isReady, setIsReady] = useState(false);
// 初回表示後に、ブラウザーから保存値を読み込みます
useEffect(() => {
try {
// 保存済みの文字列を読み込みます
const savedValue = window.localStorage.getItem(key);
// 保存値があればJSONからJavaScriptの値へ戻します
if (savedValue !== null) {
setValue(JSON.parse(savedValue));
}
} catch {
// 読み込みに失敗しても初期値でアプリを続けます
// 必要に応じて、ここでエラー状態を返す設計にできます
} finally {
// 読み込み処理の終了を記録します
setIsReady(true);
}
}, [key]);
// 読み込み完了後、値が変わるたびに保存します
useEffect(() => {
// 読み込み前の初期値で保存済みデータを上書きしないようにします
if (!isReady) {
return;
}
try {
// JavaScriptの値をJSON文字列にして保存します
window.localStorage.setItem(key, JSON.stringify(value));
} catch {
// 保存容量やブラウザー設定による失敗をここで扱えます
}
}, [key, value, isReady]);
// 保存値、更新関数、読み込み状態を返します
return [value, setValue, isReady];
}JSXLocalStorageを使うときの注意
localStorageには文字列しか保存できないため、値をJSONに変換して保存します。- このHookでは、読み込みが終わるまで
isReadyがfalseです。 - LocalStorageの読み書きはブラウザーの設定や保存容量などで失敗することがあるため、実アプリでは失敗時の案内も検討します。
- パスワード、認証トークン、秘密鍵などの機密情報をLocalStorageに保存しないでください。
このHookを使うコンポーネントの例です。
// useLocalStorageを読み込みます
import { useLocalStorage } from "../hooks/useLocalStorage.js";
// メモを保存するコンポーネントです
function SavedNote() {
// メモのStateをLocalStorageと同期します
const [note, setNote, isReady] = useLocalStorage(
"day28-note",
""
);
// 保存値の読み込み中は案内を表示します
if (!isReady) {
return <p>保存したメモを読み込んでいます...</p>;
}
return (
<section>
<label htmlFor="note">メモ</label>
{/* 入力値をStateへ反映します */}
<textarea
id="note"
value={note}
onChange={(event) => setNote(event.target.value)}
/>
<p>ページを再読み込みしても、メモが残るか確認できます。</p>
</section>
);
}JSX6. Hook 3:useFetchを作る
useFetchは、URLからデータを取得する処理をまとめるHookです。取得中・成功・失敗を状態として返します。
hooks/useFetch.jsを作成します。
// ReactのStateとEffectを読み込みます
import { useEffect, useState } from "react";
// URLからJSONを取得するカスタムHookです
export function useFetch(url) {
// 取得データを管理します
const [data, setData] = useState(null);
// エラー内容を管理します
const [error, setError] = useState("");
// idle、loading、success、errorの状態を管理します
const [status, setStatus] = useState("idle");
// URLが変わったときに新しいデータを取得します
useEffect(() => {
// URLがない場合は通信をせず、待機状態にします
if (!url) {
setData(null);
setError("");
setStatus("idle");
return;
}
// この通信を中断するためのコントローラーを作ります
const controller = new AbortController();
// 前回のデータを消し、読み込み中にします
setData(null);
setError("");
setStatus("loading");
// APIからデータを取得する非同期関数です
async function loadData() {
try {
// URLへリクエストを送り、cleanupで中断できるようにします
const response = await fetch(url, {
signal: controller.signal,
});
// HTTPエラーを確認します
if (!response.ok) {
throw new Error(`HTTPエラー:${response.status}`);
}
// 応答本文をJSONとして読み込みます
const result = await response.json();
// 中断されていない場合だけ結果を反映します
if (!controller.signal.aborted) {
setData(result);
setStatus("success");
}
} catch (requestError) {
// 通信を中断した場合は通常のエラーにしません
if (requestError.name === "AbortError") {
return;
}
// その他のエラーをStateへ保存します
setError("データを取得できませんでした。");
setStatus("error");
}
}
// データ取得を開始します
loadData();
// URL変更またはコンポーネント終了時に通信を中断します
return () => {
controller.abort();
};
}, [url]);
// データと通信状態を呼び出し元に返します
return {
data,
error,
status,
isLoading: status === "loading",
};
}JSXfetch()は、404や500などのHTTPエラー応答を受け取っても、必ずしも例外を投げません。そのため、response.okを確認してからデータを処理します。不要になった通信をAbortControllerで中断することで、URL変更後に古い応答が画面へ反映されるのを防ぎやすくなります。
7. 3つのHookをNext.jsのページで使う
app/page.jsまたはsrc/app/page.jsを作成します。Hooksや入力イベントを使うため、このページはClient Componentにします。
この例では、メモをLocalStorageに保存し、詳細欄を開閉し、サンプルのブログAPIからデータを取得します。
// このファイルをClient Componentとして扱います
"use client";
// 3つのカスタムHookを読み込みます
import { useFetch } from "../hooks/useFetch.js";
import { useLocalStorage } from "../hooks/useLocalStorage.js";
import { useToggle } from "../hooks/useToggle.js";
// 各Hookの使い方を示すページです
export default function HomePage() {
// メモをLocalStorageと同期します
const [note, setNote, isNoteReady] = useLocalStorage(
"day28-learning-note",
""
);
// 詳細パネルの開閉状態を管理します
const {
isOn: isDetailsOpen,
toggle: toggleDetails,
} = useToggle(false);
// ブログAPIからデータを取得します
const {
data: posts,
error: postsError,
status: postsStatus,
isLoading: postsLoading,
} = useFetch("https://api.vercel.app/blog");
// APIの結果が配列の場合にだけ、先頭3件を表示します
const visiblePosts = Array.isArray(posts) ? posts.slice(0, 3) : [];
return (
<main>
<h1>Day 28:Custom Hooks</h1>
<section>
<h2>useToggle:詳細の開閉</h2>
{/* 押すたびに詳細欄の表示を切り替えます */}
<button
type="button"
onClick={toggleDetails}
aria-expanded={isDetailsOpen}
>
{isDetailsOpen ? "詳細を閉じる" : "詳細を開く"}
</button>
{/* 開いているときだけ説明を表示します */}
{isDetailsOpen && <p>この表示状態はuseToggleで管理しています。</p>}
</section>
<section>
<h2>useLocalStorage:メモの保存</h2>
{/* 初回読み込み前は入力欄を表示しません */}
{!isNoteReady ? (
<p>保存したメモを読み込んでいます...</p>
) : (
<>
<label htmlFor="learning-note">学習メモ</label>
{/* 入力するたびにStateとLocalStorageが更新されます */}
<textarea
id="learning-note"
value={note}
onChange={(event) => setNote(event.target.value)}
rows={4}
/>
<p>再読み込み後もメモが残るか試してください。</p>
</>
)}
</section>
<section>
<h2>useFetch:ブログデータの取得</h2>
{/* 通信中の表示です */}
{postsLoading && <p aria-live="polite">読み込み中です...</p>}
{/* 取得に失敗した場合の表示です */}
{postsStatus === "error" && <p role="alert">{postsError}</p>}
{/* 取得に成功した場合の一覧表示です */}
{postsStatus === "success" && visiblePosts.length > 0 && (
<ul>
{visiblePosts.map((post) => (
// APIから受け取ったIDをkeyとして使います
<li key={post.id}>{post.title}</li>
))}
</ul>
)}
{/* 取得できた配列が空の場合の案内です */}
{postsStatus === "success" && visiblePosts.length === 0 && (
<p>表示できる記事はありません。</p>
)}
</section>
</main>
);
}JSXサンプルAPIへの通信にはインターネット接続が必要です。通信に失敗しても、useFetchのローディングやエラー表示を確認できます。アプリで使うAPIに置き換えるときは、そのAPIのURLとレスポンス形式を確認してください。
8. Hookを分けると何がよくなるか
カスタムHookを使わない場合、LocalStorageの読み書き、API取得、開閉Stateなどがページの中に混在します。Hookへ処理を分けると、ページは「何を表示するか」を中心に読めるようになります。
useToggleは、真偽値の切り替え方法をまとめます。useLocalStorageは、Stateとブラウザー保存の同期をまとめます。useFetchは、通信・読み込み・エラーの扱いをまとめます。
ただし、処理が一度しか使われず、とても短い場合は、カスタムHookに分けることでファイル移動が増え、分かりにくくなることもあります。再利用性や読みやすさを基準に判断しましょう。
9. カスタムHookは状態を共有しない
同じカスタムHookを複数のコンポーネントから呼び出しても、それぞれ別のHook呼び出しです。たとえば、2つのコンポーネントがuseToggle()を使えば、通常は独立した開閉Stateになります。
- 同じ処理の仕組みを再利用する:カスタムHookを使います。
- 複数コンポーネントで同じStateを共有する:親のState、Contextなどを検討します。
この違いを理解しておくと、「一方のボタンを押したのに別のコンポーネントが変わらない」という混乱を避けられます。
10. LocalStorage Hookの注意点
この例のuseLocalStorageは、初回表示後に保存値を読み込みます。そのため、読み込み前にinitialValueが一瞬表示される可能性があります。利用者に誤解を与える表示なら、例のようにisReadyがtrueになるまで読み込み中の画面を表示します。
また、この例はデータをJSONにできることを前提としています。関数や循環参照を含むオブジェクトなど、JSONに変換できない値には向きません。保存値をアプリの更新後も使う場合は、過去の形式との互換性をどうするかも検討が必要です。
11. useFetchを広げるときの考え方
今回のuseFetchは、JSONを取得する基本的な学習用Hookです。実際のアプリでは、APIに応じて次のような機能が必要になる場合があります。
- リクエストヘッダーや認証情報の扱い。
- 再取得、キャッシュ、ページネーション。
- エラーメッセージの詳細化。
- POSTやPUTなど、データ更新の通信。
- 複数コンポーネント間でのデータ共有。
複雑なキャッシュや再検証が必要なら、独自Hookを拡張し続けるのではなく、専用のデータ取得ライブラリやNext.jsのサーバー側データ取得を検討します。また、このuseFetchのようなHookを使うため、APIのデータ取得をすべてブラウザー側で行う必要があるわけではありません。
12. よくあるつまずき
- カスタムHookを条件の中で呼び出してしまう:コンポーネントのトップレベルで呼び出します。
- Hookを普通の関数として呼び出す:カスタムHookはReactコンポーネントか別のHookから使います。
- LocalStorageの初期値が保存データを上書きする:読み込みが終わる前に保存しないよう、準備状態を管理します。
- HTTPエラーがエラー扱いにならない:`fetch`の後に`response.ok`を確認します。
- URLを変えても古い通信が続く:cleanupで`AbortController`を使います。
- カスタムHookを呼べばStateも共有されると思う:Hook呼び出しごとにStateができるため、共有にはContextなどが必要です。
- 機密情報をLocalStorageに保存する:パスワードや認証情報は保存しないでください。
13. Day 28のチェックリスト
- カスタムHookの名前を`use`から始めています。
- Hookを条件分岐やループの中で呼び出していません。
- `useToggle`で開閉状態を再利用できます。
- `useLocalStorage`でブラウザー保存を扱い、読み込み完了状態を確認できます。
- `useFetch`で通信中、成功、失敗を区別できます。
- 不要になった通信を中断できる理由を説明できます。
- カスタムHookは処理を再利用するもので、呼び出し間のState共有とは別だと理解しています。
Custom Hookは、Reactの状態や副作用を伴う処理を、名前の付いた再利用可能な単位に整理する方法です。今回は、開閉状態を扱うuseToggle、ブラウザー保存を扱うuseLocalStorage、API通信を扱うuseFetchを作りました。まずはそれぞれ単独で試し、次にページで組み合わせて、処理の再利用と状態共有の違いを確かめましょう。
