以前、こういうコードを書きました。商品一覧とお知らせ一覧が、どちらも「読み込み中を出して、取ってきて、失敗したらエラーを出す」形をしていたので、「同じだから共通化しよう」と思ったのです。
これは深掘りです。本線の順路ではありません。 本線のコンポーネントとpropsの回まで終わった人が、「同じような処理が増えてきたので自作フックに切り出したいが、どこで切ればいいのか分からない」ところで止まったときに読む記事です。飛ばしても本線は進みます。
この記事のコマンドは、すべて VM の中(Ubuntu Server)で打ちます。 Windows の PowerShell ではありません。 画面の確認は、ホストの Windows のブラウザで行います。 本線で作った
~/react-demo/には触りません。 この記事では、まっさらな~/reactlab/を新しく作ります。
const { items, loading, error } = useList("/api/products")
最初はうまくいきました。 2週間後、お知らせ一覧にページ送りが付きました。
const { items, loading, error, page, setPage } = useList("/api/news", { paged: true })
さらに1週間後、商品一覧に絞り込みが付きました。
const { items, loading, error, page, setPage } = useList("/api/products", {
paged: false,
filter: keyword,
filterMode: "prefix",
keepPreviousOnError: true,
})
このフックの中は、if (options.paged) と if (options.filter) だらけになりました。 そして、商品一覧を直すたびに、お知らせ一覧が壊れました。
最後にはこうなりました。
useListを読むより、それぞれの画面に直接書いてあったほうが、短くて、速く直せる。
問題は「共通化した」ことではありません。 問題は、共通化してよいものと、よくないものを見分ける基準を持っていなかったことです。
商品一覧とお知らせ一覧は、「見た目の形」が同じだっただけで、「意味」は最初から別物でした。別物を1つにまとめると、違いは必ず引数になって戻ってきます。
「似ているから」は、切り出す理由になりません。 切り出す理由は「同じ意味だから」だけです。
この記事では、その基準を3つに絞って言葉にしたあと、実際に自作フックを3つ作ります。
対象レベル: 中級〜上級 / 区分: 発展
この記事でわかること
- 自作フックは「フックを呼ぶ、ただの関数」でしかないこと。React の特別な仕組みではない
useで始める理由は、慣習ではなく「ESLint がフックの規則を検査できるようにするため」であること- 見た目が同じだけのものを共通化すると、あとから分岐が増えて壊れること。似ていることは理由にならない
- 切り出す基準は3つしかないこと(①状態と更新がセットで再利用される ②外の世界との同期がある ③2箇所以上で本当に同じ意味)
- 「1箇所でしか使わないが、読みやすくなる」も正当な理由であること。再利用だけが目的ではない
- 同じフックを2箇所で呼んでも、状態は共有されないこと。呼んだ数だけ、別々の状態ができる
- 返り値を配列にするかオブジェクトにするかには基準があること(名前を変えたいなら配列 / 数が多いならオブジェクト)
- 自作フックは、画面を作らずにテストできること(
renderHook)
この記事でやること
~/reactlab/を新しく作り、ポート 5180 で起動する- 共通化に失敗するコードを実際に書いて、引数が増えていくところを見る
useToggle/useLocalStorage/useDebounceの3つを作り、使う側の before/after を並べる- 同じフックを2箇所で呼び、状態が共有されないことを画面で確かめる
@testing-library/reactのrenderHookで、自作フックのテストを1本書いて走らせる
先に知る言葉
この記事に初めて出てくる言葉です。 詳しくは用語集にもあります。
| 言葉 | この記事での意味 |
|---|---|
| カスタムフック(自作フック) | 中で useState などのフックを呼んでいる、自分で書いた関数。名前を use で始める |
| フックの規則 | フックはコンポーネント(かカスタムフック)のトップレベルでだけ呼ぶという決まり(前々回でやりました) |
| ロジック(logic) | 画面の見た目ではなく、「どう動くか」の部分。状態の持ち方、更新の仕方、外部との通信など |
localStorage | ブラウザが持っている、閉じても消えない小さな保存場所。文字列しか入りません |
| デバウンス(debounce) | 「打ち終わってから動かす」やり方。入力のたびに動かさず、手が止まって一定時間たってから1回だけ動かす |
renderHook | 画面を作らずに、フックだけを動かして結果を見るためのテスト用の関数 |
| Vitest | Vite と同じ設定で動くテスト実行ツール(本線のテストの回で使いました) |
| jsdom | ブラウザの代わりに、Node の中に DOM を用意するもの。window や localStorage が使えるようになる |
① 準備 — reactlab を新しく作る
本線で作った ~/react-demo/ は、そのまま残します。 この記事はまっさらなプロジェクトでやります。わざと壊れるコードを書くからです。
VMの中で、ホームディレクトリに戻って作ります。
質問が出たら、そのまま Enter で構いません。 版によっては「このまま npm install して起動しますか?」と聞かれます。そこは No(n)を選んでください。 ポートを自分で決めたいからです。
eslint.config.js index.html package.json public README.md src vite.config.js
この一覧が出れば成功です。 npm install は初回だけ数分かかります。何が起きているかはnpmの回、dist/ が何なのかはビルドツールの回にあります。
すでに
~/reactlab/がある場合(この深掘りシリーズの別の回で作っている場合)は、作り直さずにそのまま使って構いません。 その場合npm create viteは飛ばして、cd ~/reactlab && npm installだけ実行してください。
ポートを開ける
本線で 5173番を使っています。 ぶつからないように、この記事は 5180番でやります。
Status: active
To Action From
-- ------ ----
22/tcp ALLOW Anywhere
5173/tcp ALLOW Anywhere
5180/tcp ALLOW Anywhere
5180/tcp の行が出れば準備完了です。開けずに起動すると、ターミナルには「起動しました」と出るのに、ブラウザは読み込み中のままになります。「ポートが開いていない」ことは、ブラウザ側からは「サーバーが無い」ようにしか見えません。
起動する
ホストの Windows のブラウザで http://192.168.226.50:5180/ を開いてください(IPは自分の値に。分からなければ VM の中で ip a)。Vite のロゴとカウンターが出れば成功です。
止め方: ターミナルで Ctrl+C。この記事の間は起動したままで構いません。 保存するたびにブラウザが自動で更新されます。
[スクリーンショット: 01_reactlab起動.png] ホストのブラウザで :5180 を開き、Vite + React の初期画面が出ているところを撮ってください。アドレスバーのポート番号が 5180 になっているのが見える形で。
置き場所を先に作る
この記事で作るフックは、全部ここに入れます。
App.css App.jsx assets components hooks index.css main.jsx
components と hooks が両方出れば成功です。 なぜこの場所なのかは⑧で書きます。
開発者ツールを開いておく
この記事は、途中で Console を何度も見ます。 ブラウザで F12 を押して、Console タブを開いたままにしてください。開発者ツール自体の使い方は開発者ツールの回にあります。
② 自作フックとは何か — 特別な仕組みではない
先に、いちばん大事なことを書きます。
カスタムフックは、React の機能ではありません。 中で
useStateやuseEffectを呼んでいる、ただの JavaScript の関数です。
React.createCustomHook() のような API はありません。登録もしません。 関数を書いて、export して、import して呼ぶだけです。
// これで、もうカスタムフックです
export function useToggle(initial = false) {
const [on, setOn] = useState(initial)
const toggle = () => setOn((v) => !v)
return [on, toggle]
}
普通の関数と違うのは1点だけです。
中でフックを呼んでいるので、この関数自身も「フックの規則」に縛られる。 つまり、呼んでよい場所が、コンポーネントか、別のカスタムフックのトップレベルだけになります。
use で始める理由は、慣習ではない
「フックは use で始める決まりです」とだけ覚えている人が多いのですが、理由があります。
useで始まっているかどうかで、ESLint が「これはフックだ」と判定している。
前々回のフックの規則の回で、if の中に useState を書いて画面を壊しました。あのとき、実行する前に止めてくれたのは eslint-plugin-react-hooks です。
そのプラグインは、関数の名前を見ています。
| 名前 | ESLint の扱い |
|---|---|
useToggle | フックとして検査する。 if の中で呼んだら警告 |
toggleHook | ただの関数として扱う。 中で useState を呼ぶと「フックでもコンポーネントでもない関数の中で呼んだ」とエラーになる。その代わり、この関数を if の中で呼んでも検査されない |
getUserState | 同上。呼ぶ側が if の中で呼んでいても、規則違反を見逃す |
実際に確かめます。 src/hooks/badName.js を作ってください。
import { useState } from "react";
// わざと use で始めない
export function makeToggle(initial) {
const [on, setOn] = useState(initial);
return [on, () => setOn((v) => !v)];
}
VMの中で ESLint を走らせます。
/home/user/reactlab/src/hooks/badName.js
5:23 error React Hook "useState" is called in function "makeToggle"
that is neither a React function component nor a custom React Hook function.
React component names must start with an uppercase letter.
React Hook names must start with the word "use"
✖ 1 problem (1 error, 0 warnings)
この場合は「名前が違う」と怒られました。 ここで怖いのは、怒られたことではありません。 名前を useMakeToggle に変えれば通るということは、逆に言えば、ESLint はファイルの中身ではなく名前で判断しているということです。
確認したら、このファイルは消します。
useで始めるのは、React に伝えるためではなく、道具に検査させるため。 名前を間違えると、その関数を呼ぶ側の規則違反(ifの中で呼ぶなど)が検査されなくなります。
ESLint そのものの設定はESLintとPrettierの回にあります。
③ 切り出してよいものと、よくないもの
ここがこの記事の本題です。
まず、失敗するほうを実際に書く
冒頭の useList を、小さくして再現します。src/hooks/useList.js を作ってください。
import { useState, useEffect } from "react";
// ⚠️ これは「悪い例」です。あとで消します
export function useList(kind) {
const [items, setItems] = useState([]);
const [loading, setLoading] = useState(true);
useEffect(() => {
setLoading(true);
const data =
kind === "products"
? [{ id: 1, label: "コーヒー豆" }, { id: 2, label: "ドリッパー" }]
: [{ id: 1, label: "年末の休業について" }];
setItems(data);
setLoading(false);
}, [kind]);
return { items, loading };
}
この時点では、きれいに見えます。 使う側も短いです。
const { items, loading } = useList("products")
ここに、現実の要求を2つ足します。
- お知らせだけ、新しい順に並べたい
- 商品だけ、在庫切れを隠したい
素直に足すと、こうなります。
export function useList(kind, options = {}) {
const [items, setItems] = useState([]);
const [loading, setLoading] = useState(true);
useEffect(() => {
setLoading(true);
let data = kind === "products" ? PRODUCTS : NEWS;
if (options.sortDesc) {
data = [...data].sort((a, b) => b.id - a.id);
}
if (options.hideSoldOut) {
data = data.filter((x) => !x.soldOut);
}
setItems(data);
setLoading(false);
}, [kind, options.sortDesc, options.hideSoldOut]);
return { items, loading };
}
ここで、何が起きているかを言葉にします。
sortDescは、お知らせでしか使いません。hideSoldOutは、商品でしか使いません。 つまり、この関数の中身は、実質2つの別の関数がifで縫い合わされているだけです。
そして、この形には必ず次があります。
- 商品の絞り込みを直そうとして
ifを触る → お知らせ側のテストが落ちる - 引数が増える → 呼び出し側が
useList("news", { sortDesc: true, hideSoldOut: false })になる hideSoldOut: falseを書かされる。 お知らせに在庫の概念は無いのに
これが「見た目だけが同じで、意味が違うものを共通化した」ときに起きることです。
共通化したのは「一覧を取ってくる」という形であって、「同じ仕事」ではなかった。
確認したら、悪い例は消します。
判断のしかた — 引数を数える
切り出す前に、簡単な検査ができます。
「動きを切り替えるための引数(フラグ)」が2つ以上必要になったら、それは1つのフックではありません。
kind のような「対象を指す引数」は問題ありません。 危ないのは sortDesc hideSoldOut paged のような、中の if を増やすためだけの引数です。
フラグが2つあると、組み合わせは4通りあります。 そのうち、実際に使われるのは2通りだけです。残りの2通りは、誰も試していないのに、コードとしては存在します。
切り出す基準3つ
逆に、切り出してよいものです。 この3つのどれかに当てはまるときだけ切り出します。
① 状態と、その更新のしかたがセットで再利用される
useState と、それを更新する関数が、いつも一緒に現れるとき。
// 3箇所で、この2行が必ずセットで出てくる
const [open, setOpen] = useState(false)
const toggle = () => setOpen((v) => !v)
この2行は、切り離して使うことがありません。 「状態」と「その状態の正しい変え方」が1組になっているなら、フックにして構いません。→ ④で useToggle として作ります。
② 外の世界との同期がある
React の外にあるもの(localStorage、window のサイズ、タイマー、通信、ブラウザのイベント)とやりとりするとき。
理由は、後片づけが必要だからです。useEffect の回で見たとおり、後片づけを書き忘れると、多重に動きます。
後片づけを書き忘れる場所を、1箇所に減らすためにフックにする。
これは、再利用のためではありません。 間違えられる場所を減らすためです。→ ④で useLocalStorage と useDebounce として作ります。
③ 2箇所以上で、本当に同じ意味である
「同じ形」ではなく「同じ意味」です。 判定は、こう聞くと分かります。
「片方の仕様が変わったとき、もう片方も同じように変わってほしいか?」
- はい → 同じ意味。切り出してよい
- いいえ、別々に変わってほしい → 別物。絶対に共通化しない
商品一覧とお知らせ一覧は、後者でした。「商品の並び順を変えたら、お知らせの並び順も変わってほしい」とは、誰も思っていません。
「1箇所でしか使わないが、読みやすくなる」も正当な理由
ここを誤解している人が多いところです。
カスタムフックの目的は、再利用だけではありません。 「コンポーネントから、見た目に関係ない部分を追い出す」ことも、同じくらい正当な理由です。
1箇所でしか使わなくても、切り出していい場面があります。
// before: コンポーネントの中に、見た目と関係ない20行がある
function SearchPage() {
const [text, setText] = useState("")
const [debounced, setDebounced] = useState("")
useEffect(() => {
const id = setTimeout(() => setDebounced(text), 300)
return () => clearTimeout(id)
}, [text])
// ...ここから下が、やっと「見た目」の話
// after: 見た目の話だけが残る
function SearchPage() {
const [text, setText] = useState("")
const debounced = useDebounce(text, 300)
行数はほとんど減っていません。 減ったのは「この画面を読むときに、頭に入れないといけないことの数」です。
ただし、条件があります。
切り出した先に、名前が付けられること。
useSearchPageStuffとしか名付けられないなら、切り出してはいけません。 それは1つの仕事ではないという意味です。
まとめると、こうです。
| 状況 | 切り出すか |
|---|---|
| 状態と更新関数が、いつもセットで現れる | 切り出す |
| 外の世界(保存・タイマー・通信・イベント)と同期する | 切り出す(後片づけを1箇所にするため) |
| 2箇所にあり、片方を直したらもう片方も同じように直したい | 切り出す |
| 2箇所にあるが、形が似ているだけ | 切り出さない |
| 1箇所だけだが、名前が付いて、画面が読みやすくなる | 切り出してよい |
1箇所だけで、名前が useXxxPageLogic にしかならない | 切り出さない |
④ 実際に3つ作る
基準を言葉にしただけでは身に付かないので、実物を3つ作ります。 3つとも、上の基準のどれに当たるかを最初に書きます。
1つ目 — useToggle(基準①・いちばん小さい例)
src/hooks/useToggle.js(新規)
import { useState, useCallback } from "react";
export function useToggle(initial = false) {
const [on, setOn] = useState(initial);
const toggle = useCallback(() => setOn((v) => !v), []);
const turnOn = useCallback(() => setOn(true), []);
const turnOff = useCallback(() => setOn(false), []);
return [on, { toggle, on: turnOn, off: turnOff }];
}
3箇所、意図があります。
setOn((v) => !v)と関数で書いています。setOn(!on)にすると、前々回の関数型更新でやったとおり、続けて2回押したときに古い値を掴みます- 依存配列が
[]で済んでいます。 関数型更新にしたので、onを見ていないからです useCallbackを使っています。 速くするためではありません。 前回で書いたとおり、受け取る側がReact.memoでなければ効果はありません。 ここでは、「フックの返り値は毎回別物になる」という事故を、フックを作る側で防いでおくために付けています
使う側の before / after を並べます。
src/components/ToggleBefore.jsx(新規)
import { useState } from "react";
export function ToggleBefore() {
const [openA, setOpenA] = useState(false);
const [openB, setOpenB] = useState(false);
return (
<section>
<h3>before</h3>
<button onClick={() => setOpenA((v) => !v)}>詳細A</button>
{openA && <p>Aの中身</p>}
<button onClick={() => setOpenB((v) => !v)}>詳細B</button>
{openB && <p>Bの中身</p>}
<button onClick={() => { setOpenA(false); setOpenB(false); }}>
全部閉じる
</button>
</section>
);
}
src/components/ToggleAfter.jsx(新規)
import { useToggle } from "../hooks/useToggle.js";
export function ToggleAfter() {
const [openA, a] = useToggle(false);
const [openB, b] = useToggle(false);
return (
<section>
<h3>after</h3>
<button onClick={a.toggle}>詳細A</button>
{openA && <p>Aの中身</p>}
<button onClick={b.toggle}>詳細B</button>
{openB && <p>Bの中身</p>}
<button onClick={() => { a.off(); b.off(); }}>全部閉じる</button>
</section>
);
}
何が変わったのか、正直に書きます。
- 行数はほぼ同じです。 これで「短くなった」と言うのは嘘になります
- 変わったのは、
setOpenA((v) => !v)という書き方が、画面のファイルから消えたことです。関数型更新を書き忘れる場所が、2箇所から0箇所になりました a.off()という名前が付きました。setOpenA(false)より、何をしたいのかが読めます
切り出しの効果は「短くなる」ではなく「間違える場所が減る」ことのほうが大きい。
2つ目 — useLocalStorage(基準②・外の世界との同期)
ここが、この記事でいちばん間違えやすいところです。
src/hooks/useLocalStorage.js(新規)
import { useState, useEffect, useCallback } from "react";
export function useLocalStorage(key, initialValue) {
// ① 初期化は「1回だけ」動かす(遅延初期化)
const [value, setValue] = useState(() => {
try {
const raw = window.localStorage.getItem(key);
if (raw === null) return initialValue;
return JSON.parse(raw);
} catch {
// ② 壊れた文字列が入っていても、画面は落とさない
console.warn(`localStorage の "${key}" が読めませんでした。初期値に戻します`);
return initialValue;
}
});
// ③ value が変わったら書き戻す
useEffect(() => {
try {
window.localStorage.setItem(key, JSON.stringify(value));
} catch (e) {
console.warn("localStorage に書けませんでした", e);
}
}, [key, value]);
// ④ 別のタブで変わったら追従する
useEffect(() => {
const onStorage = (e) => {
if (e.key !== key) return;
try {
setValue(e.newValue === null ? initialValue : JSON.parse(e.newValue));
} catch {
setValue(initialValue);
}
};
window.addEventListener("storage", onStorage);
return () => window.removeEventListener("storage", onStorage);
}, [key, initialValue]);
const clear = useCallback(() => {
window.localStorage.removeItem(key);
setValue(initialValue);
}, [key, initialValue]);
return [value, setValue, clear];
}
①〜④を、1つずつ説明します。 ここを飛ばすと、この記事の価値はありません。
① 初期化のタイミング
useState(() => JSON.parse(...)) // ✅ 関数を渡す
useState(JSON.parse(...)) // ❌ 値を渡す
下は、再描画のたびに localStorage を読みます。 使われるのは初回だけなのに、毎回読んで、毎回 JSON.parse します。 前々回の遅延初期化と同じ話です。
そして、useEffect の中で読むのも間違いです。
// ❌ よくある書き方
const [value, setValue] = useState(initialValue)
useEffect(() => {
setValue(JSON.parse(localStorage.getItem(key)))
}, [key])
これは動きますが、初回に一瞬だけ initialValue が表示されてから、保存値に切り替わります。 ダークモードの設定なら、開くたびに一瞬白く光ります。 「読んでから描く」と「描いてから読み直す」は、別物です。
② JSON の失敗
localStorage には、文字列しか入りません。 だから JSON.stringify して入れ、JSON.parse して取り出します。問題は、JSON.parse は失敗すると例外を投げることです。
失敗する状況は、実際にあります。
- 前の版のコードが、
JSON.stringifyせずに生の文字列を入れていた - 手で開発者ツールから値を書き換えた
- 別のアプリが、同じキーを使っていた
try で囲っていないと、useState の初期化で例外が飛びます。 これは、描画の途中で落ちるということです。画面が真っ白になります。
わざと壊して、確かめます。 ブラウザの Console で打ってください。
localStorage.setItem("memo", "これはJSONではない")
そのあとページを再読み込みすると、try があるので「読めませんでした」の警告が出るだけで、画面は生きています。
[スクリーンショット: 02_JSON壊れ警告.png] Console に localStorage の "memo" が読めませんでした の警告が出て、画面は正常に表示されているところを撮ってください。
③ 書き戻し
[key, value] が依存です。 key を入れ忘れると、キーを変えたのに前のキーに書き続けます。
④ 複数タブ
ここが、いちばん知られていない落とし穴です。
storageイベントは、「自分以外のタブ」でだけ発火します。
つまり、同じページを2つのタブで開いて、片方で値を変えても、もう片方は何もしなければ古い値を表示し続けます。 ④の useEffect は、そのためのものです。
実際に確かめます。 ④のコードがある状態で、同じ URL をタブ2つで開き、片方でメモを書き換えてください。 もう片方も、自動で変わります。
[スクリーンショット: 03_2タブ同期.png] ブラウザのタブを2つ並べて、片方で入力した文字がもう片方にも出ているところを撮ってください。
④を書かなくても、1つのタブで使う限り、バグは絶対に出ません。 だから、書き忘れても気付けません。 これが「外の世界との同期はフックにまとめる」理由です。
なお、window を直接触っているので、このフックはブラウザの外(サーバー側での描画)では動きません。 SSRの回の環境で使うときは、そのままでは使えません。この記事の範囲では、ブラウザだけを考えます。
使う側の before / after — メモ欄(useLocalStorage)
src/components/MemoAfter.jsx(新規)
import { useLocalStorage } from "../hooks/useLocalStorage.js";
export function MemoAfter() {
const [memo, setMemo, clear] = useLocalStorage("memo", "");
return (
<section>
<h3>メモ(閉じても残ります)</h3>
<textarea value={memo} onChange={(e) => setMemo(e.target.value)} rows={3} />
<button onClick={clear}>消す</button>
</section>
);
}
before は、上の①〜④を全部この画面に書いた形になります。約30行です。 after は3行です。
ここは、はっきり短くなります。
useToggleと違って、外の世界を相手にしているからです。
3つ目 — useDebounce(基準②・タイマーと後片づけ)
src/hooks/useDebounce.js(新規)
import { useState, useEffect } from "react";
export function useDebounce(value, delay = 300) {
const [debounced, setDebounced] = useState(value);
useEffect(() => {
const id = setTimeout(() => setDebounced(value), delay);
return () => clearTimeout(id);
}, [value, delay]);
return debounced;
}
8行しかありませんが、依存配列と後片づけの両方が入っています。
return () => clearTimeout(id) を消すと、どうなるか。
valueが変わるたびに、新しいタイマーが積まれます- 前のタイマーは、消されずに生き残ります
- 「あいうえお」と5文字打つと、5個のタイマーが順に発火します
- 結果、デバウンスしていないのと同じです
そして、画面は正しく動いているように見えます。 最後に発火するのは最新の値だからです。壊れているのに、目には見えません。
確かめます。 useDebounce の中に1行足してください。
const id = setTimeout(() => {
console.log("発火:", value);
setDebounced(value);
}, delay);
後片づけがある状態で速く5文字打つと、Console に出るのは1回です。return () => clearTimeout(id) の行を消して同じことをすると、5回出ます。
[スクリーンショット: 04_デバウンス発火回数.png] 後片づけありで1回、なしで5回、Console に出ているところを2枚、または上下に見える形で撮ってください。
確認したら、後片づけの行を戻して、console.log は消してください。
依存配列の扱い
[value, delay] です。 ここに debounced を入れてはいけません。
}, [value, delay, debounced]) // ❌ 無限ループ
debounced が変わる → effect が動く → タイマーが debounced を変える → effect が動く、が止まりません。
逆に、delay を消してもいけません。
}, [value]) // ❌ delay を変えても反映されない
ESLint が警告します。 前回とuseEffectの回で書いたとおり、依存配列の警告は、消さずに従います。
使う側の before / after — 検索欄(useDebounce)
src/components/SearchAfter.jsx(新規)
import { useState, useEffect } from "react";
import { useDebounce } from "../hooks/useDebounce.js";
export function SearchAfter() {
const [text, setText] = useState("");
const keyword = useDebounce(text, 300);
useEffect(() => {
if (!keyword) return;
console.log("検索する:", keyword);
}, [keyword]);
return (
<section>
<h3>検索</h3>
<input value={text} onChange={(e) => setText(e.target.value)} />
<p>入力: {text} / 実際に検索する語: {keyword}</p>
</section>
);
}
画面に、2つの値を並べて出しているのがポイントです。 打っている最中は上だけが変わり、手を止めて0.3秒たつと下が追いつきます。 デバウンスは、目に見えると一瞬で理解できます。
通信を実際にやる場合は、非同期処理の回とuseEffect の競合状態の話が、そのまま必要になります。
3つを画面に出す
src/App.jsx(全文を置き換え)
import { ToggleBefore } from "./components/ToggleBefore.jsx";
import { ToggleAfter } from "./components/ToggleAfter.jsx";
import { MemoAfter } from "./components/MemoAfter.jsx";
import { SearchAfter } from "./components/SearchAfter.jsx";
export default function App() {
return (
<main style={{ padding: 16, fontFamily: "sans-serif" }}>
<h1>自作フックの練習</h1>
<ToggleBefore />
<ToggleAfter />
<MemoAfter />
<SearchAfter />
</main>
);
}
保存すると、ブラウザが勝手に更新されます。 4つのブロックが縦に並べば成功です。
[スクリーンショット: 05_3つのフック.png] before/after のボタン、メモ欄、検索欄が縦に並んでいる画面を撮ってください。
⑤ フックは、状態を共有しない
ここを誤解すると、必ず事故ります。 実際に何度も見てきた勘違いです。
❌ 「
useLocalStorage("memo", "")を2つの画面で呼べば、同じ状態を共有できる」
共有されません。
✅ フックを呼ぶと、呼んだ場所ごとに、まったく別の状態ができます。 共有されるのは「コード」だけで、「状態」は共有されません。
実演する
src/components/ShareDemo.jsx(新規)
import { useToggle } from "../hooks/useToggle.js";
function Lamp({ name }) {
const [on, ctrl] = useToggle(false);
return (
<p>
{name}: <strong>{on ? "点灯" : "消灯"}</strong>{" "}
<button onClick={ctrl.toggle}>切り替え</button>
</p>
);
}
export function ShareDemo() {
return (
<section>
<h3>同じフックを2箇所で呼ぶ</h3>
<Lamp name="ランプA" />
<Lamp name="ランプB" />
</section>
);
}
App.jsx に足して、ホストのブラウザで A のボタンを押してください。
A だけが「点灯」になり、B は「消灯」のままです。
[スクリーンショット: 06_状態は共有されない.png] ランプAが「点灯」、ランプBが「消灯」で並んでいる画面を撮ってください。
なぜかというと、useToggle の中の useState は、useToggle に属していないからです。
useStateは、それを呼んだ「コンポーネントのインスタンス」に属します。useToggleは、そのuseStateを呼ぶ手続きを書いた紙にすぎません。
同じレシピを2人が使えば、料理は2皿できます。 1皿を2人で共有することにはなりません。
useLocalStorage は、なぜ「共有されているように見える」のか
ここが厄介です。 useLocalStorage("memo", "") を2箇所で呼ぶと、片方を変えて再読み込みすると、両方が同じ値になります。
共有されたのではありません。 2つの別々の状態が、たまたま同じ保存場所を読んだだけです。
再読み込みするまでは、ずれます。 片方に打っても、もう片方は古い値を表示し続けます(④の storage イベントは、同じタブの中では発火しません)。
「保存先が同じ」と「状態が同じ」は、別のこと。
では、本当に共有したいときは
選択肢は2つで、どちらもこの記事の範囲外です。
- 状態を、共通の親に持たせて props で配る(本線のコンポーネントとpropsの回)
- Context か、状態管理のライブラリを使う
カスタムフックは、その3つ目にはなりません。 フックは「持ち方」を配る道具であって、「持ち物」を配る道具ではありません。
⑥ 返り値の形 — 配列か、オブジェクトか
useToggle は配列を返し、useLocalStorage も配列を返し、useList(悪い例)はオブジェクトを返していました。 どちらでもよいのではなく、基準があります。
const [on, toggle] = useToggle() // 配列
const { items, loading } = useList() // オブジェクト
| 配列 | オブジェクト | |
|---|---|---|
| 受け取り側で名前を | 自由に付けられる | 決まった名前になる(: 別名 で変えられるが、面倒) |
| 要素の順番 | 意味を持つ。入れ替えると壊れる | 関係ない |
| 一部だけ受け取る | 前から順に埋める必要がある | 要るものだけ書ける |
| 数が増えたとき | const [a, , , d] = ... になる。読めない | 平気 |
判断基準は、2つだけです。
① 同じフックを1つの画面で複数回呼び、それぞれ違う名前を付けたいなら → 配列 ② 返すものが3つ以上あるなら → オブジェクト
useToggle が配列なのは、①だからです。
const [openA, a] = useToggle()
const [openB, b] = useToggle()
オブジェクトだったら、こうなります。
const { on: openA, toggle: toggleA } = useToggle()
const { on: openB, toggle: toggleB } = useToggle()
動きますが、毎回名前を付け替える手間が乗ります。 useState が配列を返すのも、まったく同じ理由です。
逆に、{ items, loading, error, refetch } のように4つ返すなら、オブジェクトです。 配列だと、呼び出し側が順番を覚えていないといけません。
迷ったらオブジェクトにしてください。 オブジェクトは、あとから返り値を1つ増やしても、既存の呼び出し側を壊しません。 配列は、増やす位置を間違えると全部壊れます。
⑦ 自作フックをテストする
②で書いたとおり、カスタムフックは「フックを呼ぶ関数」です。 だから、そのまま useToggle() と呼んでもテストできません。 コンポーネントの外だからです。
renderHook は、「そのフックを呼ぶだけの、中身の無いコンポーネント」を裏で作ってくれる関数です。
入れるもの
VMの中で打ちます。
@testing-library/dom も要ります。 入れないと、テスト実行時に「peer dependency が無い」という趣旨のエラーになります。@testing-library/react が中で使っているのに、自動では入りません。
jsdom は、Node の中に window と document を用意するものです。これが無いと、React が描画できません。
設定する
vite.config.js(全文を置き換え)
import { defineConfig } from "vite";
import react from "@vitejs/plugin-react";
export default defineConfig({
plugins: [react()],
test: {
environment: "jsdom",
},
});
test: の3行を足しただけです。Vitest は Vite の設定をそのまま読むので、別の設定ファイルは要りません。 本線のテストの回と同じ形です。
テストを1本書く
src/hooks/useToggle.test.js(新規)
import { test, expect } from "vitest";
import { renderHook, act } from "@testing-library/react";
import { useToggle } from "./useToggle.js";
test("toggle を呼ぶと、真偽が入れ替わる", () => {
const { result } = renderHook(() => useToggle(false));
expect(result.current[0]).toBe(false);
act(() => {
result.current[1].toggle();
});
expect(result.current[0]).toBe(true);
});
test("off は、何度呼んでも false のまま", () => {
const { result } = renderHook(() => useToggle(true));
act(() => {
result.current[1].off();
result.current[1].off();
});
expect(result.current[0]).toBe(false);
});
2つ、説明が要ります。
result.current— フックの「いまの返り値」です。result.currentを変数に取り置きしてはいけません。 更新後は別のオブジェクトに差し替わるので、取り置いた変数は古いままですact()— 「この中で状態を変えるので、変わり終わるまで待て」という囲いです。これで囲まないと、更新が反映される前に次の行に進みます
走らせる
✓ src/hooks/useToggle.test.js (2 tests) 24ms
Test Files 1 passed (1)
Tests 2 passed (2)
2 passed が出れば成功です。
[スクリーンショット: 07_renderHook成功.png] Test Files 1 passed / Tests 2 passed が見えているところを撮ってください。
わざと落とす
テストが本当に効いているか、必ず確かめます。 useToggle.js の turnOff を、わざと間違えてください。
const turnOff = useCallback(() => setOn(true), []);
✗ off は、何度呼んでも false のまま
Test Files 1 failed (1)
Tests 1 failed | 1 passed (2)
落ちれば、テストが仕事をしています。 確認したら setOn(false) に戻してください。
画面を1つも作らずに、フックの動きを固定できました。 これは「ロジックをコンポーネントから追い出す」ことの、見返りのほうです。
なお、コンポーネントごとテストする方法は本線のテストの回にあります。 どちらが上ということはなく、renderHook は準備が軽いぶん、フック単体の仕様を固めるのに向いています。
⑧ 命名と置き場所
ここまで作ったものを、機械的な決まりにします。
src/
├── components/ ← 見た目(.jsx)
│ ├── ToggleAfter.jsx
│ └── MemoAfter.jsx
└── hooks/ ← ロジック(.js)
├── useToggle.js
├── useToggle.test.js
├── useLocalStorage.js
└── useDebounce.js
決まりは4つです。
| 決まり | 理由 |
|---|---|
src/hooks/ に置く | 「見た目のファイル」と「ロジックのファイル」を、フォルダで分ける。探す場所が1つになる |
| 1ファイル1フック | hooks.js に全部入れると、必ず肥大化する。 ファイル名がフック名なら ls が索引になる |
| ファイル名 = フック名 | useToggle.js の中には useToggle しか無い。import 文を見れば、どのファイルか分かる |
拡張子は .js(.jsx ではない) | フックは JSX を返さない。 返すのは値と関数だけ。拡張子が、それを示す |
最後の1つは、思っているより効きます。
useXxx.jsxになっていたら、そのフックは JSX を返している可能性が高い。 JSX を返すなら、それはフックではなく、コンポーネントです。
名前の付け方も、1つだけ守ります。
use+ 「何を扱うか」。useToggle(開閉を扱う)、useLocalStorage(保存場所を扱う)useUtilsuseHelperuseCommonは禁止。 名前が付けられないものは、1つの仕事ではありません(③の最後)
なお、フックが別のフックを呼ぶのは、まったく問題ありません。
export function useSearchKeyword(delay = 300) {
const [text, setText] = useState("");
const keyword = useDebounce(text, delay); // 自作フックの中で、自作フックを呼ぶ
return { text, setText, keyword };
}
これも「コンポーネントかカスタムフックのトップレベル」なので、規則を守っています。
つまずいたところ
useList の引数が4つになったとき、「設計が下手だからだ」と思って、もっと汎用にしようとしました。 options にコールバックを渡せるようにして、transform という関数の引数まで足しました。結果、useList は「配列を受け取って配列を返す関数を、引数で渡せるフック」になりました。 それは、ただの Array.prototype.map です。 汎用にすればするほど、「何もしないもの」に近づいていました。 正解は、汎用にすることではなく、2つに割って、共通化をやめることでした。「引数が増えたら、抽象化が足りないのではなく、間違っている」という見方ができていませんでした。
useLocalStorage を作ったとき、初期値の読み込みを useEffect に書いていました。 動いてはいたのですが、ダークモードの設定を読ませたら、ページを開くたびに一瞬だけ白く光りました。 「Reactが遅いのかな」と思って useMemo を足したりして、丸1日、見当違いのところを探しました。 原因は単純で、「初期値で1回描いてから、effect で読み直して、もう1回描いていた」だけでした。useState(() => 読む) にしたら、一発で消えました。 「一瞬ちらつく」は、たいてい「描いてから直している」という症状です。
JSON.parse を try で囲っていなくて、画面を真っ白にしました。 開発中に開発者ツールから localStorage の値を手で書き換えたのが原因です。useState の初期化の中で例外が出ると、コンポーネントが1つも描けません。 エラー画面には Unexpected token としか出ないので、localStorage が原因だと気付くまで30分かかりました。 外から来る値は、必ず壊れていると思って書く。 これはエラーの読み方の回で書いたことの、実例です。
storage イベントが「自分のタブでは発火しない」ことを知らず、2時間デバッグしました。 同じタブの中で2つのコンポーネントを同期させようとして、storage を待っていたのです。発火しないので、当然動きません。 console.log を入れても何も出ないので、「イベント名を間違えているのでは」と、綴りを何度も確かめました。 綴りは合っていて、仕様どおりでした。 MDN を読めば1行書いてありました。 「動かない」ときに、まず自分のコードを疑いすぎるのも遠回りです。
useDebounce の後片づけを消しても、画面が正しく動いていたので、しばらく気付きませんでした。 最後に発火するのが最新の値なので、結果だけ見ると正しいのです。console.log を1行入れて、5回出ているのを見て、初めて壊れていると分かりました。 「タイマーが5個動いている」ことは、画面からは絶対に見えません。 useEffect の回で同じことを書いたのに、別の題材だと、また同じ間違いをしました。
renderHook のテストで、result.current を変数に取っておいて、ずっと false のままになりました。
const [on, ctrl] = result.current // ❌ ここで取り置く
act(() => ctrl.toggle())
expect(on).toBe(true) // 通らない。on は古い値のまま
on は、あの瞬間の値のコピーです。更新されても、変数は変わりません。 毎回 result.current[0] と書き直すのが正解でした。「変数に入れたら楽」という癖が、そのまま罠になりました。
npm install -D vitest jsdom @testing-library/react だけで始めて、実行時に peer dependency が無いと言われました。 @testing-library/react は @testing-library/dom を自分では入れません。エラーメッセージには「入れてください」と書いてあったのに、テストのエラーだと思い込んで、テストコードのほうを30分見ていました。 エラーは下から読む、をまた忘れていました。
「1箇所でしか使わないから、切り出すべきではない」と思い込んでいた時期があります。 その結果、1つのコンポーネントが300行になりました。 「再利用しないなら切り出さない」は、半分しか合っていません。 名前が付いて、画面のファイルから雑音が消えるなら、1箇所でも切り出してよい——これに気付くのが、いちばん遅かったところです。
後片づけ
開発サーバーを止める
起動しているターミナルで Ctrl+C。
確認: 何も出なければ、止まっています。
ポートを閉じる
開けっぱなしにしません。
確認: 5180/tcp の行が消えていれば成功です。5173番は、本線で使うので残してあります。
ブラウザに残ったデータを消す
localStorage は、サーバーを止めても消えません。 ブラウザの中に残ります。
ホストのブラウザの Console で打ってください。
localStorage.removeItem("memo")
localStorage.length
確認: 0 が返れば、空です。 開発者ツールの Application タブ(Firefox なら ストレージ タブ)でも確認できます。
プロジェクトをどうするか
~/reactlab/ は、消しても消さなくても構いません。
残す場合、node_modules が数百MBあります。中身は package.json から復元できるので、容量が気になるなら消して構いません。
戻すときは cd ~/reactlab && npm install だけです。この考え方はnpmの回にあります。
丸ごと消す場合。
~/react-demo/ は絶対に消さないでください。 本線がその続きで進みます。
確認: 本線のファイル一覧が出れば、無事です。
まとめ
- カスタムフックは React の機能ではない。 中でフックを呼んでいる、ただの関数
useで始めるのは慣習ではない。 ESLint が「フックとして検査するかどうか」を、名前で判断している- 見た目が同じだけのものを共通化すると、違いが引数になって戻ってくる。
ifが増え、片方を直すと片方が壊れる - 動きを切り替えるフラグ引数が2つ以上要るなら、それは1つのフックではない
- 切り出す基準は3つ。①状態と更新がセット ②外の世界との同期がある ③2箇所以上で「同じ意味」
- 「同じ意味」の判定は、「片方の仕様が変わったら、もう片方も同じように変わってほしいか」
- 「1箇所でしか使わないが、名前が付いて画面が読みやすくなる」も正当な理由。 再利用だけが目的ではない
- ただし
useXxxPageLogicとしか名付けられないなら、切り出さない useToggleは、行数はほぼ減らない。 減ったのは「関数型更新を書き忘れる場所」の数useLocalStorageは、はっきり短くなる。 外の世界を相手にしていて、注意点が4つもあるから- 初期値は
useState(() => 読む)。useEffectで読むと、初回に一瞬だけ古い値が見える JSON.parseは必ずtryで囲う。 初期化で例外が出ると、画面が真っ白になるstorageイベントは、自分のタブでは発火しない。 書かなくても、1タブで使う限りバグは出ないuseDebounceの後片づけを消しても、画面は正しく動いて見える。 タイマーが5個動いていることは、画面からは見えない- 同じフックを2箇所で呼んでも、状態は共有されない。 共有されるのはコードだけ
useLocalStorageが共有されて見えるのは、別々の状態が同じ保存場所を読んでいるだけ。 再読み込みするまでずれる- 本当に共有したいなら、親に持たせて props で配るか、Context か状態管理ライブラリ。 フックは3つ目にならない
- 返り値は、同じフックを複数回呼んで名前を変えたいなら配列。 3つ以上返すならオブジェクト
- 迷ったらオブジェクト。 あとから1つ増やしても、既存の呼び出し側が壊れない
renderHookで、画面を作らずにフックをテストできる。jsdomと@testing-library/domも要るresult.currentを変数に取り置かない。 更新後は差し替わるので、取り置いた値は古いまま- 置き場所は
src/hooks/useXxx.js。 1ファイル1フック、ファイル名 = フック名、拡張子は.js .jsxになっているフックは、たぶんコンポーネント
参考リンク
- roadmap.sh — React
- React 公式 — カスタムフックでロジックを再利用する
- React 公式 — フックの規則
- React 公式 — useEffect は必要ないかもしれない
- React 公式 — useState
- React 公式 — useSyncExternalStore
- Testing Library — renderHook
- Vitest 公式ガイド
- MDN — Window.localStorage
- MDN — storage イベント
- MDN — JSON.parse
- MDN — setTimeout
- eslint-plugin-react-hooks
- Vite 公式ガイド
次に読む
この記事は 【深掘り】React の 9 / 24 本目です。
| 記事 | |
|---|---|
| ← 前の記事 | Context — 入れたら全部再描画される |
| → 次の記事 | フォームと制御コンポーネント — 1文字ごとに全部再描画 |
上から順に読めば積み上がるように並べています。 飛ばしても構いませんが、詰まったら前の回に戻ってください。
全体の順路は はじめに にあります。
roadmap.sh のどこをやっているか
- 切り出す基準と、切り出してはいけないもの
- useToggle / useLocalStorage / useDebounce
この記事は、上の項目を実際に手を動かして確かめる回です。

コメント