ReactのCannot update a component警告の直し方

​​React​TypeScript,useEffect,useState,Vite,トラブルシュート

React のコンソールに Cannot update a component (...) while rendering a different component (...) という警告が出るのは、子コンポーネントのレンダーの途中で、親コンポーネントの state を変えているためです。子から親へ値を知らせようとして、props で受け取った親の set 関数を、子の本体や onClick={onSelect(color)} のような書き方でその場で呼んでいると出ます。値を親で計算する形や、onClick に関数を渡す形に直すと、警告は消えます。

私は検証環境でこの警告をわざと出し、コンソールに出た文と、直したあとに消えることを確かめました。

補足

検証環境は Ubuntu 24.04、Node.js 22.23.4 です。npm create vite@latest の react-ts テンプレートで作ったプロジェクト(react / react-dom 19.3.1、Vite 8.3.8、TypeScript 7.0.2、oxlint 1.93.0)で、コンポーネントを StrictMode で囲んで試しました。ページは Chromium 153 を Playwright 1.63.0 で操作して開き、DevTools の画面は、画面ありの Chromium を仮想ディスプレイ(Xvfb)で動かして撮りました。Next.js などのフレームワークの開発サーバーや、Chromium 以外のブラウザーでの表示は試していません。

子のレンダー中に親の set 関数を呼んで、警告を出す

カートの商品の一覧を子の CartList に描かせ、その件数を親の BadCart に表示する例です。子は、props で受け取った親の setCount(onCount)を、関数の本体で呼んでいます。

tsx
import { useState } from 'react';

const items = ['りんご', 'みかん', 'ぶどう'];

// まちがい:子(CartList)のレンダーの途中で、親(BadCart)の state を変えている
function CartList({ onCount }: { onCount: (n: number) => void }) {
  onCount(items.length);
  return (
    <ul>
      {items.map((item) => <li key={item}>{item}</li>)}
    </ul>
  );
}

export default function BadCart() {
  const [count, setCount] = useState(0);
  return (
    <div>
      <p>カートの中身: {count}点</p>
      <CartList onCount={setCount} />
    </div>
  );
}

開発サーバー(npm run dev と同じ vite)で開くと、DevTools のコンソールに、赤い行で次の文が1件出ました。

text
Cannot update a component (`BadCart`) while rendering a different component (`CartList`). To locate the bad setState() call inside `CartList`, follow the stack trace as described in https://react.dev/link/setstate-in-render

1つ目のかっこ(BadCart)が state を変えられたコンポーネント、2つ目のかっこ(CartList)がそのときレンダーしていたコンポーネントです。文の後半は「CartList の中にある、まちがった setState() の呼び出しを探すには、リンク先の説明に従ってスタックをたどってください」という案内です。

ページには「カートの中身: 3点」と商品3つが表示されている。下の DevTools のコンソールに、赤い行で「Cannot update a component (`BadCart`) while rendering a different component (`CartList`).」から始まる文が出ている
子のレンダー中に親の set 関数を呼ぶページを開いたところ。画面は表示され、コンソールに赤い行が1件出た

React はこれを console.error で出しています。そのため DevTools では赤い行で表示されますが、エラーとして処理が止まるわけではありません。検証でも、ページには カートの中身: 3点 と商品3つが表示されました。表示が正しいので見落としやすい警告です。

なお、レンダーの途中で自分自身の state を条件なしに変え続けると、Too many re-renders というエラーになります。今回は、親の state が 3 になったあとは同じ 3 を渡すだけで、くり返しになりませんでした。useState のリファレンスにある set 関数の注意点のとおり、新しい値が今の state と同じなら、React は再レンダーを飛ばします。

なぜ警告になるのか

レンダーの途中で set 関数を呼んでよいのは、いまレンダーしているコンポーネント自身の state だけです。useState のリファレンスにある、前のレンダーの情報を持っておく例の説明では、レンダーの途中でほかのコンポーネントの set 関数を呼ぶのはまちがいだ、と書かれています。

この警告が加わった React 16.13.0 のリリースのお知らせにも、コンポーネントはレンダーの途中でほかのコンポーネントに副作用を起こしてはいけない、と書かれています。お知らせに載っている当時の文は Warning: Cannot update a component from inside the function body of a different component. で、いまの文とは違います。

react-dom 19.3.1 の開発用ビルドのコードを見ると、この警告は console.error で出しています。レンダーしていたコンポーネント(2つ目のかっこの名前)を Set に覚えておき、同じコンポーネントでは2回目以降は出しません。本番用ビルドのファイル(react-dom-client.production.js)には、この文そのものが入っていませんでした。

親で計算する形に直すと、警告が消える

この例の件数は、子に渡しているデータから計算できます。子から親に知らせるのをやめ、親のレンダーの中で計算して、子にはデータを渡すだけにします。

tsx
const items = ['りんご', 'みかん', 'ぶどう'];

// 直したもの:件数はデータから計算できるので、親のレンダーの中で計算する
function CartList({ items }: { items: string[] }) {
  return (
    <ul>
      {items.map((item) => <li key={item}>{item}</li>)}
    </ul>
  );
}

export default function GoodCart() {
  const count = items.length;
  return (
    <div>
      <p>カートの中身: {count}点</p>
      <CartList items={items} />
    </div>
  );
}

開発サーバーで開くと、表示は直す前と同じ カートの中身: 3点 で、コンソールに警告は出ませんでした。

直したページ。表示は直す前と同じで、DevTools のコンソールには React DevTools の案内の1行だけが出ている
親で件数を計算する形に直したページ。赤い行は出ていない

コンソールに残っている1行は React DevTools の案内です。直す前のページにも出ていました。

公式ドキュメントの Effect を使わなくてよい場面を説明したページにある、親にデータを渡す節でも、子と親が同じデータを使うなら、親がデータを持って子に渡す形を勧めています。データは親から子へ流れるので、表示がおかしいときに、どこから来た値かを追いやすくなります。

useEffect に移しても警告は消える

どうしても子から親に知らせたいときは、親の set 関数の呼び出しを useEffect の中に移します。Effect で外部と同期する方法を説明した公式ドキュメントにあるとおり、Effect の中のコードはレンダーのあとで動くので、レンダーの途中で呼ぶことはなくなります。React 16.13.0 のお知らせでも、レンダーの結果としてほかのコンポーネントの state を変えたいまれな場合の方法として、useEffect で包む形が書かれています。

tsx
import { useEffect, useState } from 'react';

const items = ['りんご', 'みかん', 'ぶどう'];

// 直したもの(別の方法):親への知らせを、レンダーのあとに動く useEffect に移す
function CartList({ onCount }: { onCount: (n: number) => void }) {
  useEffect(() => {
    onCount(items.length);
  }, [onCount]);
  return (
    <ul>
      {items.map((item) => <li key={item}>{item}</li>)}
    </ul>
  );
}

親の EffectCart は BadCart と同じで、setCount を onCount として渡しています。開発サーバーで開くと、カートの中身: 3点 と表示され、警告は出ませんでした。

ただし、さきほどの公式ドキュメントの節は、子が Effect の中で親の state を変える書き方を「避ける(Avoid)」例として挙げています。データの流れが追いにくくなるためです。親で計算できる値なら、前の節の直し方を先に考えます。

onClick で親の関数をその場で呼んでも、同じ警告になる

子のボタンを押したら親の state を変える、という作りでも同じ警告が出ることがあります。onClick に関数を渡すつもりで、onSelect(color) と呼んでしまう書き方です。

tsx
import { useState } from 'react';

// まちがい:onClick に「onSelect(color) を呼んだ結果」を渡している
function ColorButton({ color, onSelect }: { color: string; onSelect: (c: string) => void }) {
  return <button onClick={onSelect(color)}>{color}</button>;
}

export default function BadSelect() {
  const [selected, setSelected] = useState('なし');
  return (
    <div>
      <p>選んだ色: {selected}</p>
      <ColorButton color="赤" onSelect={setSelected} />
      <ColorButton color="青" onSelect={setSelected} />
    </div>
  );
}

開発サーバーで開くと、コンソールに次の警告が1件出ました。

text
Cannot update a component (`BadSelect`) while rendering a different component (`ColorButton`). To locate the bad setState() call inside `ColorButton`, follow the stack trace as described in https://react.dev/link/setstate-in-render

JSX の { } の中は、その場で実行されます。そのため、ColorButton をレンダーするたびに、ボタンを押さなくても親の setSelected が呼ばれます。イベントハンドラーの追加について説明した公式ドキュメントの節にある、onClick={handleClick()} を誤りとする例と同じ形です。

画面にもおかしなところが出ました。何も押していないのに、表示は 選んだ色: 青 でした。2つのボタンのレンダーで「赤」「青」の順に呼ばれ、あとの「青」が残ったためです。「赤」のボタンを押しても、表示は 選んだ色: 青 のまま変わりませんでした。onClick に渡っているのが関数ではないので、押しても何も呼ばれません。

直すには、押されたときに onSelect(color) を呼ぶ関数を渡します。

tsx
function ColorButton({ color, onSelect }: { color: string; onSelect: (c: string) => void }) {
  return <button onClick={() => onSelect(color)}>{color}</button>;
}

直したページを開くと、警告は出ず、表示は 選んだ色: なし で始まりました。「赤」を押すと 選んだ色: 赤、「青」を押すと 選んだ色: 青 に変わりました。

この書き間違いは、TypeScript の型チェックで見つかります。検証用のプロジェクトで npx tsc -p tsconfig.app.json --noEmit を実行すると、次のエラーが出ました。テンプレートの npm run build も、最初の tsc で止まりました。

text
src/BadSelect.tsx(5,18): error TS2322: Type 'void' is not assignable to type 'MouseEventHandler<HTMLButtonElement> | undefined'.

一方、子の本体で onCount を呼ぶ BadCart のほうは、型としては正しいので、tsc ではエラーになりませんでした。テンプレートの設定のままの oxlint(npx oxlint src)でも、どちらのファイルにも警告は出ませんでした。こちらは開発中のコンソールで見つけることになります。

原因の行は、コンソールのスタックから探す

警告に名前が出るのは、レンダーしていたコンポーネント(ここでは CartList や ColorButton)までです。その中のどの行かは、スタックで分かります。警告の文にある https://react.dev/link/setstate-in-render は、React の GitHub の issue #18178 のコメントに転送されます。そこでは、メッセージの横の小さな矢印を押してスタックを開き、React の中の行を飛ばすと、その次の行が問題の場所だと説明されています。

検証で、DevTools と同じ CDP(Chrome DevTools Protocol)からこの警告のスタックを取ると、先頭の6行は次のとおりでした(ファイルの場所は略して、関数名だけを抜き出しています)。

text
at console.<computed>
at scheduleUpdateOnFiber
at dispatchSetStateInternal
at dispatchSetState
at CartList
at react_stack_bottom_frame

console.<computed> は Vite の開発サーバーのスクリプトの中で、scheduleUpdateOnFiber から dispatchSetState までは React の中です。その次の CartList が、親の set 関数を呼んだ場所です。ColorButton のほうも、同じ位置に ColorButton がありました。

なお、検証環境の DevTools では、警告の行の右に出るファイル名は client:364 でした。これは Vite の開発サーバーのスクリプトで、原因の場所ではありません。行の右のリンクではなく、矢印を開いたスタックのほうを見ます。

本番用のビルドでは何も出ない

型チェックを飛ばして npx vite build だけで本番用にビルドし、npx vite preview で開くと、BadCart でも BadSelect でも、コンソールには何も出ませんでした。画面は開発中と同じで、BadSelect は 選んだ色: 青 のまま、ボタンを押しても変わりませんでした。

警告が出ないだけで、まちがった書き方は残っています。公開中のサイトで表示や操作がおかしいときは、開発サーバーで同じ画面を開き、コンソールにこの警告が出ていないかを確かめます。

​Posted by 86