リストのkey — 添字を使うとチェックがズレる

リストのkeyを理解する。固有の鍵タグとチェックボックスを付けたリストのカード。

一覧の並べ替えでチェックがずれるのは、keyに添字を使っているからです。Reactが要素をどう見分けているのかを確かめます。

前回: フォームと制御コンポーネント — 1文字ごとに全部再描画

これは深掘りです。本線の順路ではありません。 本線のコンポーネントとpropsの回で map を使って一覧を描き、「key を付けろと警告が出たから付けた」ところで止まっている人が読む記事です。飛ばしても本線は進みます。

この記事のコマンドは、すべて VM(Ubuntu Server)の中で打ちます。 Windows の PowerShell ではありません。 画面の確認は、ホストの Windows のブラウザで行います。 本線で作った ~/react-demo/ には触りません。 この記事では、まっさらな ~/reactlab/ を新しく作って、最後に丸ごと消します。

自分が実際にやった事故から書きます。

やることリストを作っていました。1行ごとにチェックボックスが付いた、ただの一覧です。動いていました。そこに「一番上に追加」ボタンを足しました。

3件のうち2件目にチェックを入れた状態で、先頭に1件追加しました。 期待したのは「チェックの付いた行が1つ下にずれて、上に空の行が増える」ことです。実際に画面に出たのは、これでした。

(追加前)
[ ] 牛乳を買う
[x] 郵便を出す
[ ] ゴミを捨てる

(先頭に「銀行に行く」を追加したあと)
[ ] 銀行に行く
[x] 牛乳を買う      ← チェックが上にずれた
[ ] 郵便を出す      ← チェックが消えた
[ ] ゴミを捨てる

チェックが、別の行に移りました。 データは正しいのです。console.log で配列を見ると、郵便を出す の done は true のままです。画面のチェックボックスだけが、1つ上の行に付いている。

原因は1行でした。

{items.map((item, index) => <Row key={index} item={item} />)}

key に配列の添字(index)を使っていたことです。 警告を消すためだけに index を入れた、あの1行です。

key は「一覧に付ける通し番号」ではありません。 そう思っている限り、この事故は必ずもう一度起きます。この記事では、事故を自分の手でもう一度起こしてから、直します。

対象レベル: 中級〜上級 / 区分: 発展

目次

この記事でわかること

  • key は表示のためのものではないこと。前回の描画と今回の描画で「これは同じものだ」と対応づけるための目印であること
  • key={index} は「順番が変わらない」ことに賭けていること。先頭に1件足した瞬間に、全員の key が別の行にずれる
  • ズレるのは「見た目」ではなく「DOM と state」であること。チェックの状態も、入力欄に打った文字も、key に付いていく
  • key={Math.random()} は index より悪いこと。再描画のたびにすべてが別物になり、入力欄とチェックが全部消える
  • key を変えると、そのコンポーネントは作り直され、state が初期化されること。これは事故であると同時に、意図して使える道具であること
  • 添字を使ってよいのは、3つの条件を全部満たすときだけであること(並び替えない・追加削除しない・state を持たない)
  • key はページ全体で一意である必要はないこと。同じ map の中(兄弟の中)で一意ならよい

この記事でやること

  1. ~/reactlab を新しく作る(本線の ~/react-demo は残したまま)。ポートは 5177
  2. チェックボックス付きの一覧を key={index} で作り、先頭に1件足して、チェックが別の行に移るのを再現する
  3. 同じ一覧の各行に入力欄を足して、打った文字も別の行に残ることを確かめる
  4. key={item.id} に直して、まったく同じ操作でズレなくなることを確認する
  5. key={Math.random()} に変えて、再描画のたびに入力欄とチェックが全部消えるところを見る
  6. key を変えて state をわざとリセットする(編集フォームの定石)を作る
  7. ~/reactlab を消して片づける

先に知る言葉

この記事で初めて出てくる言葉です。 基本的な言葉は用語集にもまとめてあります。

言葉意味
key一覧の各要素に付ける目印の文字列。前回の描画の誰と、今回の描画の誰が同じものかを React に教える
添字(index)配列の何番目かを表す数。0 から始まる。「どれか」ではなく「何番目か」しか表さない
リコンサイル(reconciliation)React が前回の設計図と今回の設計図を見比べて、DOM に何をするか決める処理。日本語では「差分照合」
マウント / アンマウントコンポーネントが新しく作られること / 捨てられること。アンマウントされると、そのコンポーネントの state は消える
非制御コンポーネント入力欄の値を state で持たず、DOM 自身に持たせている書き方。<input type="checkbox" /> をそのまま置くとこれになる
crypto.randomUUID()ブラウザが持っている、重複しないID文字列を作る関数。3f2a... のような36文字を返す
仮想スクロール(virtual scrolling)画面に見えている数十件だけを DOM に置き、残りは置かないという表示のしかた

① 準備 — reactlab を新しく作る

本線で作った ~/react-demo/ は、そのまま残します。 この記事はわざと壊す手順を含むので、新しいプロジェクトでやります。

VMの中で打ちます。

bash
$ cd ~
$ npm create vite@latest reactlab -- --template react

質問が出たら、そのまま Enter で構いません。 版によっては「このまま npm install して起動しますか?」と聞かれます。そこは No(n)を選んでください。 ポートを自分で決めたいからです。

bash
$ cd ~/reactlab
$ npm install
$ ls
eslint.config.js  index.html  package.json  public  README.md  src  vite.config.js

この一覧が出れば成功です。 npm install は初回だけ数分かかります。何が起きているかはnpmの回、dist/ が何なのかはビルドツールの回にあります。

ポートを開ける

本線で 5173番を使っています。 ぶつからないように、この記事は 5177番でやります。

bash
$ sudo ufw allow 5177/tcp
$ sudo ufw status
Status: active

To                         Action      From
--                         ------      ----
22/tcp                     ALLOW       Anywhere
5173/tcp                   ALLOW       Anywhere
5177/tcp                   ALLOW       Anywhere

5177/tcp の行が出れば準備完了です。開けずに起動すると、ターミナルには「起動しました」と出るのに、ブラウザは読み込み中のままになります。

起動する

bash
$ npm run dev -- --host 0.0.0.0 --port 5177

ホストの Windows のブラウザで http://192.168.226.50:5177/ を開いてください(IPは自分の値に。分からなければ VM の中で ip a)。Vite のロゴとカウンターが出れば成功です。

止め方: ターミナルで Ctrl+C。この記事の間は起動したままで構いません。 保存するたびにブラウザが自動で更新されます。

[スクリーンショット: 01_reactlab起動.png] ホストのブラウザで :5177 を開き、Vite + React の初期画面が出ているところを撮ってください。アドレスバーのポート番号が 5177 になっているのが見える形で。


② key は何のためにあるのか

先に、誤解を1つ壊します。

key は、画面に出るものではありません。 並び順を決めるものでもありません。

key に何を入れても、画面の表示は1文字も変わりません。では何のためにあるのか。

React は、ボタンを押すたびに新しい設計図を作ります(再描画の回で見たとおりです)。そして、前回の設計図と今回の設計図を見比べて、DOM に何をするか決めます。 このとき、React は毎回この質問に答えなければいけません。

前回あった3つの行と、今回ある4つの行。どれとどれが「同じもの」なのか。

この質問に、React は自力では答えられません。 中身の文字列が似ているかどうかで判断することもできません(「牛乳を買う」を「牛乳を買った」に書き換えたら別物になってしまいます)。

だから、私たちが教えます。それが key です。

key が伝えていること伝えていないこと
前回のこれと、今回のこれは同じものです何番目に出すか
前回のこれは、今回もういません(消えた)どう見えるか
今回のこれは、前回いませんでした(新しい)どんなデータか

そして、「同じもの」と判断された行は、DOM もコンポーネントの state もそのまま引き継がれます。 逆に、「別物」と判断された行は、いったん捨てられて作り直されます。 作り直された行の state は初期値に戻ります。

つまり key は、「チェックの状態がどの行に付いていくか」を決めているわけです。ここまで分かれば、冒頭の事故はもう半分説明できています。

key を付け忘れると出る警告(Each child in a list should have a unique "key" prop.)は、「デザインが崩れます」ではありません。 「どれが同じものか分からないので、こちらで適当に決めます」という宣言です。


③ key={index} で事故を起こす

読んで納得するのではなく、自分の画面で起こします。

src/App.jsx をまるごとこの内容にしてください(VS Code から編集できます)。

import { useState } from 'react'

// 1行ぶんの部品。チェックの状態は「この部品が自分で」持つ
function Row({ label }) {
  return (
    <li style={{ padding: '4px 0' }}>
      <input type="checkbox" />
      <span style={{ marginLeft: 8 }}>{label}</span>
    </li>
  )
}

export default function App() {
  const [items, setItems] = useState([
    '牛乳を買う',
    '郵便を出す',
    'ゴミを捨てる',
  ])

  function addTop() {
    setItems(['銀行に行く', ...items])
  }

  return (
    <div style={{ fontFamily: 'sans-serif', padding: 24 }}>
      <h1>key の実験</h1>
      <button onClick={addTop}>先頭に追加</button>
      <ul>
        {items.map((label, index) => (
          <Row key={index} label={label} />
        ))}
      </ul>
    </div>
  )
}

ブラウザを見てください。 3行の一覧と「先頭に追加」ボタンが出ます。

手順どおりに操作する

  1. 2行目「郵便を出す」のチェックボックスにチェックを入れる
  2. 「先頭に追加」を1回押す

[スクリーンショット: 02_indexでズレる.png] チェックを入れたあと、先頭に追加を押した直後の画面を撮ってください。チェックが「牛乳を買う」の行に付いているところが写るように。

こうなります。

[ ] 銀行に行く
[x] 牛乳を買う      ← チェックが移動した
[ ] 郵便を出す      ← 自分でチェックした行から消えた
[ ] ゴミを捨てる

チェックした覚えのない行にチェックが付いています。 バグに見えますが、React は指示どおりに動いています。

入力欄でも同じことが起きる

「チェックボックスだから起きる特殊な話だろう」と思った人のために、もう1つ足します。 Row を、こう書き換えてください。

function Row({ label }) {
  return (
    <li style={{ padding: '4px 0' }}>
      <input type="checkbox" />
      <span style={{ marginLeft: 8, marginRight: 8 }}>{label}</span>
      <input placeholder="メモ" />
    </li>
  )
}

もう一度やります。

  1. 2行目「郵便を出す」のメモ欄に あとで と打つ
  2. 「先頭に追加」を押す

[スクリーンショット: 03_入力欄がズレる.png] あとで と打った文字が、「牛乳を買う」の行のメモ欄に残っているところを撮ってください。

打った文字が、別の行に残ります。 チェックボックスとまったく同じ現象です。

共通しているのは、「その行が自分で持っている状態」だという点です。チェックの入り切りも、入力欄の文字も、React の state ではなく DOM 自身が持っています(これを非制御コンポーネントと呼びます)。DOM が使い回されると、中身も一緒に付いてきます。

useState で持っていても同じです。 後で確かめます。問題は state の持ち方ではなく、key の付け方です。


④ なぜそうなるのか — 添字は「どれか」を表さない

さっきの操作で、key に何が入っていたかを並べます。

追加前

行key中身チェック
10牛乳を買うなし
21郵便を出すあり
32ゴミを捨てるなし

追加後

行key中身
10銀行に行く
21牛乳を買う
32郵便を出す
43ゴミを捨てる

React から見えているものを、そのまま読みます。

key=0 は、前回も今回もいる。だから同じもの。DOM は使い回す。 key=1 は、前回も今回もいる。だから同じもの。DOM は使い回す。 key=2 も同じ。key=3 は新しいので作る。

React は正しく仕事をしました。 前回の key=1(郵便を出す・チェック済み)の DOM を、今回の key=1(牛乳を買う)にそのまま使い回したのです。中の label だけが 牛乳を買う に書き換わり、チェックボックスは触られませんでした。

結論はこの1行です。

添字は「何番目か」であって「どれか」ではありません。

「何番目か」は、1件足しただけで全員分が変わります。 一方、「どれか」は、並び替えても追加しても変わりません。 key が欲しいのは後者です。

先頭に1件追加すると
添字2件目以降の全員が、別の番号になる
そのデータ固有のID誰も変わらない。新しい1件に新しいIDが増えるだけ

⑤ 安定したIDに直す

データに、そのデータ固有のIDを持たせます。 文字列の配列をやめて、オブジェクトの配列にします。

src/App.jsx をまるごと書き換えてください。

import { useState } from 'react'

function Row({ label }) {
  return (
    <li style={{ padding: '4px 0' }}>
      <input type="checkbox" />
      <span style={{ marginLeft: 8, marginRight: 8 }}>{label}</span>
      <input placeholder="メモ" />
    </li>
  )
}

// IDを作る係。連番でよい(この画面の中で重複しなければよい)
let nextId = 100
function makeId() {
  nextId += 1
  return String(nextId)
}

export default function App() {
  const [items, setItems] = useState([
    { id: 'a1', label: '牛乳を買う' },
    { id: 'a2', label: '郵便を出す' },
    { id: 'a3', label: 'ゴミを捨てる' },
  ])

  function addTop() {
    setItems([{ id: makeId(), label: '銀行に行く' }, ...items])
  }

  return (
    <div style={{ fontFamily: 'sans-serif', padding: 24 }}>
      <h1>key の実験</h1>
      <button onClick={addTop}>先頭に追加</button>
      <ul>
        {items.map((item) => (
          <Row key={item.id} label={item.label} />
        ))}
      </ul>
    </div>
  )
}

変わったのは2箇所だけです。 データが { id, label } になったことと、key={index} が key={item.id} になったこと。

まったく同じ操作をしてください。

  1. 2行目のチェックを入れ、メモに あとで と打つ
  2. 「先頭に追加」を押す

[スクリーンショット: 04_idで直る.png] チェックとメモが「郵便を出す」の行に残ったまま、上に新しい行が増えたところを撮ってください。

今度はズレません。 key=a2 は前回も今回も a2 なので、React は同じものだと分かり、DOM をその行のまま残したからです。位置が2番目から3番目に動いても、key が同じなら同じものです。

IDが無いデータの場合

サーバーから来るデータには、たいてい id が付いています。 問題は、画面の中で新しく作るときです。

作る瞬間に、自分で振ります。 ブラウザには専用の関数があります。

const item = { id: crypto.randomUUID(), label: '銀行に行く' }

ポイントは「作るときに1回だけ振る」ことです。 描画のたびに振ってはいけません。

// ダメな例:描画のたびに新しいIDが生まれる
{items.map((item) => <Row key={crypto.randomUUID()} label={item.label} />)}

これは次に説明する Math.random() と同じ事故です。

crypto.randomUUID() は、この記事の環境(http://192.168.…)では使えません。 理由と対処は後半の「つまずいたところ」に書きました。上の makeId() のような連番で代用してください。 実運用(HTTPS)では crypto.randomUUID() が使えます。

key={Math.random()} は最悪

「ユニークならいいんでしょう」と思ったときのために、実際にやります。 さっきの map を、一時的にこうしてください。

{items.map((item) => (
  <Row key={Math.random()} label={item.label} />
))}

保存したら、メモ欄に何か打ち、チェックも入れてから「先頭に追加」を押してください。

[スクリーンショット: 05_random最悪.png] メモ欄に文字を打ち、チェックを入れてから「先頭に追加」を押した直後、全行のメモとチェックが消えたところを撮ってください。

全部消えます。 押すと再描画が起き、そのたびに全員の key が新しい値になるからです(メモ欄は非制御なので、打っているあいだは再描画が起きず、文字は普通に打てます)。React にはこう見えています。

前回の行は全員いなくなった。今回の行は全員はじめて見る。

結果、再描画のたびにすべての行が捨てられて作り直されます。 チェックも、入力中の文字も、フォーカスも消えます。index は「ときどきズレる」でしたが、Math.random() は「再描画のたびに全部壊れる」です。

key の値React から見た結果
item.id(安定)同じものは同じもの。 必要な行だけ作る
index並びが変わると、中身と目印がズレる
Math.random()毎回全員が別物。全部作り直す

確認できたら、key={item.id} に戻してください。


⑥ key を変えると作り直される — これを逆手に取る

⑤で見たことを、もう一度言い換えます。

key が変わったコンポーネントは、捨てられて、新しく作られます。 中の state は初期値に戻ります。

事故として見れば最悪の性質ですが、これは道具としても使えます。 定石になっている使い方が1つあります。

編集フォームで、別の項目を選んだら入力欄をリセットしたい。

やってみます。 src/App.jsx を書き換えてください。

import { useState } from 'react'

// 名前を編集するフォーム。入力中の文字は自分の state に持つ
function EditForm({ initialName }) {
  const [name, setName] = useState(initialName)
  return (
    <div style={{ marginTop: 16 }}>
      <input value={name} onChange={(e) => setName(e.target.value)} />
      <p>入力中: {name}</p>
    </div>
  )
}

const users = [
  { id: 'u1', name: '田中' },
  { id: 'u2', name: '佐藤' },
  { id: 'u3', name: '鈴木' },
]

export default function App() {
  const [selectedId, setSelectedId] = useState('u1')
  const selected = users.find((u) => u.id === selectedId)

  return (
    <div style={{ fontFamily: 'sans-serif', padding: 24 }}>
      <h1>key で state をリセットする</h1>
      {users.map((u) => (
        <button key={u.id} onClick={() => setSelectedId(u.id)}>
          {u.name}
        </button>
      ))}

      {/* key を付けていない版 */}
      <EditForm initialName={selected.name} />
    </div>
  )
}

操作してください。

  1. 入力欄の文字を 田中太郎 に書き換える
  2. 「佐藤」ボタンを押す

入力欄は 田中太郎 のままです。 useState(initialName) の初期値は最初の1回しか使われないためです(useStateの回で見たとおりです)。同じ位置に同じ種類のコンポーネントがあるので、React は「同じもの」と判断し、作り直しませんでした。

[スクリーンショット: 06_リセットされない.png] 「佐藤」を押したのに、入力欄が 田中太郎 のままになっているところを撮ってください。

では、key を1つ足します。

<EditForm key={selected.id} initialName={selected.name} />

同じ操作をしてください。 今度は「佐藤」を押した瞬間に、入力欄が 佐藤 になります。

key が u1 から u2 に変わった → 別物 → 前のフォームは捨てられ、新しいフォームが useState('佐藤') から始まった、というだけです。リセット用のコードは1行も書いていません。

これは map の中でなくても使えます。 key は「一覧に付けるもの」ではなく、「このコンポーネントの同一性を表すもの」です。一覧はその一番よくある使い道にすぎません。


⑦ 添字を使ってよい条件

key={index} が常に間違いというわけではありません。 ただし、3つを全部満たすときだけです。

条件満たさないとどうなるか
1. 並び替えない並べ替えた瞬間、中身と DOM がズレる
2. 追加も削除もしない(末尾への追加だけなら可)途中に足す・途中を消すと、そこから下が全部ズレる
3. 各行が state を持たない(入力欄・チェックボックス・開閉状態などが無い)ズレても気づかないが、入力を足した日に壊れる

「今は3を満たしている」は、いちばん危険です。 一覧に入力欄が足される日は、たいてい来ます。そのとき、原因の1行は半年前に書かれています。

判断に迷ったら id を振ってください。 id を持たせるコストは、この事故を1回調べるコストより、はるかに小さいです。

逆に、安心して index を使ってよい例を挙げます。

// 固定の見出し。並び替えも追加も state も無い
{['名前', '年齢', '住所'].map((h, i) => <th key={i}>{h}</th>)}

⑧ key はグローバルではない

よくある誤解です。

❌ 「ページ全体で一意なIDにしないといけない」

違います。 key を比べるのは、同じ親の下にいる兄弟どうしの中だけです。

<ul>
  {todo.map((t) => <li key={t.id}>{t.label}</li>)}
</ul>
<ul>
  {done.map((t) => <li key={t.id}>{t.label}</li>)}
</ul>

上のリストに key="1" があり、下のリストにも key="1" があっても、まったく問題ありません。 別々の親の下にいるからです。

そのかわり、同じ map の中では絶対に重複させてはいけません。 重複すると、React は警告を出したうえで、どちらか一方の行を落とすか、意図しない使い回しをします。

Encountered two children with the same key, `a2`.

この警告が出たら、必ず直してください。 「表示は合っているから」で放置すると、後で必ず刺さります。


⑨ 一覧を描くときの型

毎回この形で書けば、迷いません。

<ul>
  {items.map((item) => (
    <li key={item.id}>{item.label}</li>
  ))}
</ul>

3つだけ守ります。

  1. key は map が返す一番外側の要素に付ける。 中の <span> に付けても意味がありません
  2. key は item.id のような、そのデータについて回る値にする
  3. key を props として読もうとしない。 props.key は undefined です(理由はJSXの回で、変換後のコードから確かめました)。中でIDが必要なら、<Row key={item.id} id={item.id} /> のように、もう1つ渡します

1行に複数の要素を出したいとき

<dt> と <dd> のように、ラッパーの <div> を入れたくない場合があります。 そのとき使うのが Fragment ですが、省略記法の <> には key が付けられません。

import { Fragment } from 'react'

<dl>
  {items.map((item) => (
    <Fragment key={item.id}>
      <dt>{item.label}</dt>
      <dd>{item.note}</dd>
    </Fragment>
  ))}
</dl>

<> を <Fragment key={...}> に書き換える。これだけです。 React をまとめて import しているなら <React.Fragment key={item.id}> でも同じです。


⑩ 長い一覧の話(この記事では導入しません)

行が1万件になると、key を正しく付けていても画面は重くなります。 DOM の要素が1万個できるからです。

そのときの答えが「仮想スクロール」です。画面に見えている数十件だけを DOM に置き、スクロールに合わせて中身を差し替えるという手法で、react-window などのライブラリがあります。

ただし、この記事では導入しません。 理由は2つです。

  • 数百件なら、たいていの環境で必要ありません。 パフォーマンス改善の回と同じで、測る前に入れない
  • 仮想スクロールは、Ctrl+F での検索・印刷・スクリーンリーダーの挙動を変えます。 入れると失うものがあるので、必要になってから選ぶべきものです

いま覚えておくのは「そういう手がある」ことだけで十分です。


つまずいたところ

crypto.randomUUID is not a function と言われた

crypto.randomUUID() の話を書いた直後に、自分の画面で落ちました。

TypeError: crypto.randomUUID is not a function

関数名は合っています。 ブラウザも新しい。原因は、開いていた URL でした。

crypto.randomUUID() は「安全なコンテキスト(secure context)」でしか使えません。 安全なコンテキストとは、https:// か、http://localhost のことです。この記事のように http://192.168.226.50:5177/ で開いていると、crypto の一部の機能が最初から存在しません。

ブラウザのコンソールで確かめられます。

> window.isSecureContext
false
> typeof crypto.randomUUID
"undefined"

「関数が無い」のではなく「この接続では渡されていない」のです。 対処は3つあります。

対処向いている場面
連番で振る(この記事の makeId())学習中はこれで十分。 1画面の中で重複しなければ key としては完璧
サーバーが振ったIDを使う本来はこれが正解。 データベースのIDをそのまま使う
HTTPSにする / localhost で開く本番。VM 上での学習には手間が大きい

Math.random().toString(36) で代用しないでください。 作るときに1回だけ呼ぶなら動きますが、「乱数でIDを作る」と書いた自分のコードを、後日 map の中に移してしまうからです(実際にやりました)。makeId() のように名前を付けた関数にしておくと、map の中に書く気になりません。

useState で持たせても直らなかった

「チェックの状態を DOM に持たせているのが悪い」と考えて、Row の中を useState に書き換えました。

function Row({ label }) {
  const [done, setDone] = useState(false)
  return (
    <li>
      <input type="checkbox" checked={done} onChange={(e) => setDone(e.target.checked)} />
      <span>{label}</span>
    </li>
  )
}

まったく同じようにズレます。 state の持ち方は関係ありません。 key が同じならコンポーネントごと使い回されるので、その中の useState の値も一緒に付いてきます。むしろ「state を上に上げれば直る」という誤った教訓を得るところでした。

直し方は1つだけです。key を、そのデータについて回る値にすることです。

警告が出ないから正しいと思っていた

key={index} は警告を出しません。 React が出すのは「key が無い」「key が重複している」の2つだけで、「その key は不安定です」とは言ってくれません。

つまり、この事故は静かに埋まります。 気づくのは、一覧に入力欄を足した日か、並び替えボタンを足した日です。そのとき、原因のコードは何ヶ月も前に書かれていて、直近の変更を疑って何時間も溶かします。(自分は「並び替えの実装を疑って2時間」でした)

先頭ではなく末尾に足していて気づかなかった

最初に一覧を作ったとき、追加ボタンは末尾に足すものでした。末尾への追加だけなら、key={index} でもズレません。 既存の行の添字が変わらないからです。

「動いていた」のではなく、「まだ踏んでいなかった」だけでした。 key の検証は、必ず「先頭または途中に追加する」「途中を削除する」「並び替える」の3つでやってください。 末尾追加は、この問題を一切炙り出しません。


後片づけ

開発サーバーを止めます。 起動しているターミナルで Ctrl+C。

開けたポートを閉じます。

bash
$ sudo ufw delete allow 5177/tcp
$ sudo ufw status

確認: 一覧に 5177/tcp が残っていなければ成功です。

プロジェクトを消します。

bash
$ rm -rf ~/reactlab
$ ls ~

確認: reactlab が消えて、react-demo が残っていれば片づけ完了です。

戻し方: もう一度試したくなったら、①の npm create vite@latest reactlab -- --template react からやるだけです。数分で戻せます(node_modulesは消してよい)。


まとめ

  • key は表示のためのものではない。 前回の描画と今回の描画で「これは同じものだ」と対応づけるための目印
  • 「同じもの」と判断された行は DOM も state も引き継がれ、「別物」と判断された行は捨てられて作り直される。 チェックの状態も、入力中の文字も、key に付いていく
  • 添字は「何番目か」であって「どれか」ではない。 先頭に1件足すと、2件目以降の全員の添字が変わる
  • だから key={index} は、中身と DOM の対応を1つずつズラす。 React のバグではなく、指示どおりの動作
  • key={Math.random()} は index より悪い。 再描画のたびに全員が別物になり、入力欄の文字もチェックも全部消える
  • 直し方は1つ。key={item.id} にする。 IDが無いデータは、作るときに1回だけ振る(crypto.randomUUID() か連番)
  • crypto.randomUUID() は https か localhost でしか使えない。 VM に IP で繋いでいる間は undefined。連番で代用してよい
  • key を変えるとコンポーネントは作り直され、state が初期化される。 これは道具として使える
  • 編集フォームに key={selected.id} を付けるだけで、選択を切り替えたときの入力リセットが1行で済む。 key は一覧専用ではない
  • 添字を使ってよいのは、並び替えない・追加削除しない・state を持たない、の3つを全部満たすときだけ
  • key はグローバルではない。 同じ親の下の兄弟の中で一意ならよい。別のリストとの重複は問題にならない
  • key は map が返す一番外側の要素に付ける。 props.key は読めない。 中でIDが必要なら別の props としてもう1つ渡す
  • <> には key を付けられない。 <Fragment key={item.id}> と書く
  • key={index} に警告は出ない。 静かに埋まり、入力欄を足した日に爆発する
  • key の検証は「先頭に追加」「途中を削除」「並び替え」の3つでやる。 末尾追加では絶対に見つからない
  • 1万件が重いのは key の問題ではない。 仮想スクロールという手はあるが、測る前に入れない

参考リンク


次に読む

この記事は 【深掘り】React の 11 / 24 本目です。

記事
← 前の記事フォームと制御コンポーネント — 1文字ごとに全部再描画
→ 次の記事条件分岐の書き方 — 三項演算子が5段ネストした

上から順に読めば積み上がるように並べています。 飛ばしても構いませんが、詰まったら前の回に戻ってください。

全体の順路は はじめに にあります。

roadmap.sh のどこをやっているか

Frontend›React — Lists & Keys
  • key に添字を使うと状態がズレる
  • key を変えてstateをリセットする

この記事は、上の項目を実際に手を動かして確かめる回です。

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

コメント

コメントする

目次