ReactとImmerで、入れ子になったstateを短く書き換える方法

​​React​Immer,TypeScript,useReducer,useState

React の state が入れ子のオブジェクトだと、奥の値を1つ変えるだけでも、スプレッド構文を何段も重ねることになります。Immer を使うと、draft.address.city = city のように直接代入する書き方のまま、元の state は変えずに新しい state を作れます。会員情報の編集フォームや設定画面のように、住所や通知設定などをまとめて1つの state に持つ画面で、一部だけを更新するときに使う書き方です。

補足

検証環境は Ubuntu 24.04、Node.js 22.23.4、React 19.3.1(開発用ビルド)、Immer 11.2.10、use-immer 0.11.0、TypeScript 7.0.2、Playwright 1.63.0、Chromium 153 です。produce の動きは Node.js で、コンポーネントは tsc で型エラーがないことを確かめてから、Playwright で Chromium を動かして試しました。本番用ビルド、Strict Mode を有効にした状態、Firefox と Safari では試していません。

スプレッド構文で書くと、変える場所までのすべての段をコピーする

検証には、次の形の state を使いました。

ts
export type Profile = {
  name: string;
  address: { pref: string; city: string };
  notifications: { email: boolean; push: boolean };
};

export const initialProfile: Profile = {
  name: 'ねこ',
  address: { pref: '東京都', city: '千代田区' },
  notifications: { email: true, push: false },
};

address.city だけを変えるには、外側のオブジェクトと address の両方をコピーし直します。

tsx
function changeCity(city: string) {
  setProfile((prev) => ({
    ...prev,
    address: { ...prev.address, city },
  }));
}

React の公式ドキュメントのオブジェクトの state を更新する方法を説明したページには、スプレッド構文は1段しかコピーしないと書かれています。そのため、入れ子の値を変えるときは、変える場所から一番上までのオブジェクトをすべてコピーします。2段なら読めますが、段が深くなるほど、どこを変えているのかが見えにくくなります。

useState のまま、produce に書き換え方だけを渡す

Immer の produce に関数だけを渡すと、「前の state を受け取って、新しい state を返す関数」が返ってきます(Immer のドキュメントにある、produce に関数だけを渡す使い方の説明)。これをそのまま setProfile に渡せば、React の更新用関数として使えます。

tsx
import { useState } from 'react';
import { produce } from 'immer';
import { initialProfile, type Profile } from './profile';

export function ProduceForm() {
  const [profile, setProfile] = useState<Profile>(initialProfile);

  function changeCity(city: string) {
    setProfile(
      produce((draft) => {
        draft.address.city = city;
      }),
    );
  }
  function togglePush() {
    setProfile(
      produce((draft) => {
        draft.notifications.push = !draft.notifications.push;
      }),
    );
  }
  // ...
}

draft は、Immer が渡す下書きのオブジェクトです。ここに代入した内容をもとに、Immer が新しいオブジェクトを作ります。draft の型は Profile から決まるので、draft.address.citty のような書き間違いは型チェックで止まります。この書き方は、Immer の公式ドキュメントの React と組み合わせる例にも載っています。

検証環境で、市区町村の入力欄に「港区」と入れ、プッシュ通知の切り替えボタンを押すと、スプレッド構文の版も produce の版も、state は同じ次の値になりました。

text
{"name":"ねこ","address":{"pref":"東京都","city":"港区"},"notifications":{"email":true,"push":true}}

useImmer なら、produce を書かずに済む

更新のたびに produce(...) で包むのが手間なら、use-immer パッケージの useImmer を使います。useState の代わりに呼ぶと、返ってくる更新用の関数に draft を受け取る関数を直接渡せます(use-immer の README)。React の公式ドキュメントで Immer を使う例として紹介されているのも、この useImmer です。

bash
npm install immer use-immer
tsx
import { useImmer } from 'use-immer';
import { initialProfile } from './profile';

export function ImmerForm() {
  const [profile, updateProfile] = useImmer(initialProfile);

  function changeCity(city: string) {
    updateProfile((draft) => {
      draft.address.city = city;
    });
  }
  function togglePush() {
    updateProfile((draft) => {
      draft.notifications.push = !draft.notifications.push;
    });
  }
  function reset() {
    updateProfile(initialProfile);
  }
  // ...
}

reset のように、関数ではなく値を渡すと、useState と同じようにその値に置き換わります。検証環境でも、市区町村とプッシュ通知を変えたあとに reset を呼ぶと、state は最初の値に戻りました。

更新の種類が多いときは、同じパッケージの useImmerReducer で、reducer の中でも draft に代入する書き方ができます。

tsx
import { useImmerReducer } from 'use-immer';
import { initialProfile, type Profile } from './profile';

type Action =
  | { type: 'changeCity'; city: string }
  | { type: 'togglePush' };

function profileReducer(draft: Profile, action: Action) {
  switch (action.type) {
    case 'changeCity':
      draft.address.city = action.city;
      break;
    case 'togglePush':
      draft.notifications.push = !draft.notifications.push;
      break;
  }
}

export function ReducerForm() {
  const [profile, dispatch] = useImmerReducer(profileReducer, initialProfile);
  // dispatch({ type: 'changeCity', city: '港区' }) のように呼ぶ
}

検証環境では、useImmer の版と useImmerReducer の版でも、同じ操作のあとの state は上の値と同じになりました。

変えていない部分は、前と同じオブジェクトのまま残る

Immer が作る新しい state では、変えた場所と、そこから一番上までのオブジェクトだけが新しくなります。変えていない部分は、前の state と同じオブジェクトがそのまま使われます(Immer の produce の説明)。検証環境の Node.js で、address.city だけを変えたときの結果を比べると、次のようになりました。

text
next === base: false
next.address === base.address: false
next.notifications === base.notifications: true

structuredClone() でまるごとコピーしてから書き換える方法でも、新しい state は作れます。ただし、こちらは変えていない notifications まで新しいオブジェクトになります(変えていない部分まで別のオブジェクトになる点は、別の記事「ReactのstateをstructuredCloneでコピーする方法」でも扱っています)。この違いは、memo で包んだ子コンポーネントに、state の一部を props として渡したときに表れます。memo は props を Object.is で比べ、同じなら再レンダーを飛ばすからです(memo の公式リファレンス)。

検証では、住所と通知を表示する子コンポーネントを memo で包み、それぞれ profile.address と profile.notifications を渡しました。そのうえで、親の state を structuredClone() で更新する版と useImmer で更新する版を並べ、市区町村を3回変えたときのレンダー回数を数えました。

上下2つの欄で「市区町村を変更」を3回ずつ押す画面。上の structuredClone の欄は、住所と通知の両方のレンダー回数が2回、3回、4回と増える。下の Immer の欄は、住所のレンダー回数だけが増え、通知は1回のまま変わらない。増えた数字はその瞬間だけピンクになる
上の structuredClone の欄と下の Immer の欄で、「市区町村を変更」を3回ずつ押す様子。Immer の欄では通知のレンダー回数が増えない
更新のしかた 親 住所の子 通知の子
structuredClone() でコピー 4回 4回 4回
useImmer 4回 4回 1回

どちらも、最初の表示の1回を含めて、市区町村を3回変えたあとの回数です。useImmer の版では、notifications が前と同じオブジェクトのままなので、通知の子は最初の1回しかレンダーされていません。

さらに、今と同じ市区町村を入れ直す操作を1回足すと、structuredClone() の版は親も子も5回に増えました。useImmer の版は4回のままでした。Immer は、何も変わらなかったときは元の state をそのまま返します(Immer のパフォーマンスについての説明)。Node.js でも、同じ値を代入した produce の結果は元の state と === で一致しました。そのため、useState の公式リファレンスにあるとおり、React は前後の state が同じとみなして再レンダーを飛ばします。

Immer で書くときに引っかかりやすい3つの点

draft を変えたうえで、別の値を return しない

draft に代入しながら、新しいオブジェクトも return すると、Immer はエラーを投げます。検証環境では、次のメッセージになりました。

text
Error: [Immer] An immer producer returned a new value *and* modified its draft. Either return a new value *or* modify the draft.

produce に渡す関数から値を返すときの Immer の説明によると、draft を変えるか、新しい値を返すか、どちらか一方にします。

気づきにくいのは、アロー関数を { } で囲まずに1行で書いた場合です。代入の結果の値が、そのまま return されます。

tsx
// 動かない書き方
updateProfile((draft) => (draft.notifications.push = !draft.notifications.push));

検証環境でこの関数を呼ぶと、上と同じエラーがページで出て、画面の表示がすべて消えました(エラーバウンダリーは置いていません)。TypeScript の型チェックは通ります。同じ説明のページにあるとおり、{ } で囲んで、値を返さない形で書きます。

draft を、あとで動く処理に持ち越さない

draft が使えるのは、渡した関数が動いている間だけです。次のように setTimeout の中で draft を書き換えると、その時点ではもう使えません。

tsx
// 動かない書き方
function changeCityLater() {
  updateProfile((draft) => {
    setTimeout(() => {
      draft.address.city = '港区';
    }, 100);
  });
}

検証環境で呼ぶと、画面の市区町村は変わらず、ページで Cannot perform 'get' on a proxy that has been revoked というエラーが出ました。あとで更新したいときは、setTimeout や await のあとで updateProfile を呼びます。

tsx
function changeCityLater() {
  setTimeout(() => {
    updateProfile((draft) => {
      draft.address.city = '港区';
    });
  }, 100);
}

こちらは、エラーなく市区町村が「港区」に変わりました。データを取得してから state に入れる場合も、先に取得を終えてから produce や updateProfile を呼ぶ順にします。Immer の createDraft の説明にも、先にデータを取得してから draft を作るよう書かれています。

できあがった state は凍結されている

Immer が返した state は、中のオブジェクトまで凍結(Object.freeze)されています(結果を自動で凍結する仕組みについての Immer の説明)。検証環境の Node.js で、produce の結果の next.address.city に直接代入すると、次のエラーになりました。

text
TypeError: Cannot assign to read only property 'city' of object '#<Object>'

ブラウザでも同じです。検証環境で、useImmer で更新したあとの state を profile.address.city = '新宿区' のように直接書き換える関数を呼ぶと、同じ TypeError がページで出ました。書き換えは、updateProfile などに渡した関数の中で、draft に対して行います。

​Posted by 86