React + TypeScript: 連続した状態変更をキューに加えて処理する

React公式サイトのドキュメントが2023年3月16日に改訂されました(「[Introducing react.dev](https://react.dev/blog/2023/03/16/introducing-react-dev)」参照)。本稿は、基本解説の「[Queueing a Series of State Updates](https://beta.reactjs.org/learn/queueing-a-series-of-state-updates)」をかいつまんでまとめた記事です。ただし、コードにはTypeScriptを加えました。反面、初心者向けのJavaScriptの基礎的な説明は省いています。

なお、本シリーズ解説の他の記事については「[React + TypeScript: React公式ドキュメントの基本解説『Learn React』を学ぶ](https://qiita.com/FumioNonaka/items/d70585bd3c0a6d4edc24)」をご参照ください。

状態変数を設定すると、レンダリングはキューに入ります。けれど、つぎのレンダリングがキューに加えられる前に、変数値に複数の操作を行いたい場合もあるでしょう。そのためには、Reactが状態の更新をどうバッチ処理するのかを理解しておくと役立ちます。


# Reactによる状態更新のバッチ処理
たとえば、つぎのコードで[+3]ボタンをクリックしたら、カウンターの状態変数(`number`)の値はいくつ加算されるでしょう。以下のサンプル001のCodeSandboxのコードで結果は確かめられます。

```react
export default function Counter() {
	const [number, setNumber] = useState(0);
	return (
		<>
			<h1>{number}</h1>
			<button
				onClick={() => {
					setNumber(number + 1);
					setNumber(number + 1);
					setNumber(number + 1);
				}}
			>
				+3
			</button>
		</>
	);
}
```

#### サンプル001■React + TypeScript: Queueing a Series of State Updates 01

https://codesandbox.io/embed/react-typescript-queueing-a-series-of-state-updates-01-i1r3yg?fontsize=14&hidenavigation=1&theme=dark

ボタンクリックするたびに設定関数`setNumber(number + 1)`を3回呼び出しているにもかかわらず、変数値は1ずつしか加算されません。レンダリングごとに状態変数値は固定されるからです(「[レンダリングはそのときとったスナップショット](https://qiita.com/FumioNonaka/items/de813331817014bac2e6#%E3%83%AC%E3%83%B3%E3%83%80%E3%83%AA%E3%83%B3%E3%82%B0%E3%81%AF%E3%81%9D%E3%81%AE%E3%81%A8%E3%81%8D%E3%81%A8%E3%81%A3%E3%81%9F%E3%82%B9%E3%83%8A%E3%83%83%E3%83%97%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88)」参照)。つまり、はじめてボタンをクリックしてレンダリングされるとき、イベントハンドラ内で何度設定関数(`setNumber()`)を呼び出して加算しても、対象となる状態変数(`number`)の値は`0`のまま変わりません。

```react
setNumber(0 + 1);
setNumber(0 + 1);
setNumber(0 + 1);
```

ここで、もうひとつ押さえておくべきことがあります。Reactはイベントハンドラの中のコードがすべて実行されるのを待ったうえで、状態を更新するのです。そのため、`setNumber()`の呼び出しがすべて終わってから、再レンダリングされることになります。

レストランでウェイターが注文を取るのと似ているかもしれません。ウェイターは料理をひとつ注文するたびに、厨房に駆け込んだりしないでしょう。テーブルの注文をひととおり聞くはずです。その間に、料理を変更することや、同席の人の注文も受けつけます。

![menu_tenin_yobu.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/128949/d490e29c-f05e-dbfd-708c-751ce7d9ba6d.png)

こうして、無駄な再レンダリングは省いて、複数の状態変数が更新できます。コンポーネントが複数あっても同じです。これは、イベントハンドラとその中のコードを処理し終えるまで、UIが更新されないことも意味します。この「バッチ処理」と呼ばれる機能により、Reactアプリケーションの実行は大幅に速められるのです。また、一部の変数を更新していない「中途半端」なまま、レンダリングされることも避けられます。

他方で、Reactはクリックのような意図的なイベントを、複数バッチ処理することはありません。クリックごとに個別に扱います。Reactがバッチ処理するのは、一般に安全とみなせるときだけです。たとえば、ボタンクリックでフォームを無効にすれば、つぎのクリックで送信されてしまうことはありません。


# レンダリング前に同じ状態変数を複数回更新する
使うことは少ないものの、つぎにレンダリングする前に、同じ状態変数を複数回更新することもできないわけではありません。つぎの状態変数値は、設定関数に`setNumber(number + 1)`のように引数値で書き替えるのでなく、つぎの状態を計算するコールバック関数として渡すことです(「[関数型の更新](https://ja.reactjs.org/docs/hooks-reference.html#functional-updates)」参照)。`setNumber((n) => n + 1)`のようにすると、キュー内の直前の状態をもとにつぎの値が計算されます。Reactに、書き替える値をそのまま渡すのでなく、状態値をどう扱えばよいのか定めるのです。結果の違いは、以下のサンプル002でお確かめください。

```react
<button
	onClick={() => {
		setNumber((n) => n + 1);
		setNumber((n) => n + 1);
		setNumber((n) => n + 1);
	}}
>
	+3
</button>
```

#### サンプル002■React + TypeScript: Queueing a Series of State Updates 02

https://codesandbox.io/embed/react-typescript-queueing-a-series-of-state-updates-02-1weji5?fontsize=14&hidenavigation=1&theme=dark

設定関数(`setNumber()`)の引数に渡したコールバックは「更新関数」と呼ばれます。

1. Reactは更新関数をキューに入れ、イベントハンドラのコードがすべて実行されたあと呼び出して処理します。
2. つぎのレンダリング時に、Reactはキューを処理したうえで、最終的に更新された状態が返ります。

つぎのレンダリング時に呼び出した`useState`について、Reactはキューを順に進みます。前回の状態変数`number`の値は0でした。Reactがはじめの更新関数に引数`n`として渡すのはその値です。すると、Reactはその更新された戻り値を、つぎの更新関数に与える引数`n`とします。これが順に繰り返されるのです。

| キューに入った更新 | n | 戻り値 |
| :---: | :---: | :---: |
| `(n) => n + 1` | `0` | `0 + 1 = 1` |
| `(n) => n + 1` | `1` | `1 + 1 = 2` |
| `(n) => n + 1` | `2` | `2 + 1 = 3` |

前掲のコード例で、Reactはこのようにして`3`を最終的な値として保持し、`useState`から返します。そのため、[+3]ボタンのクリックで、状態変数値は3加算されたのです。


# 状態変数値を書き替えたあと更新した場合
状態変数値を書き替えたあと、更新関数で値を処理した場合はどうなるでしょう。結果は、以下のサンプル003で確認してください。

```react
<button
	onClick={() => {
		setNumber(number + 5);
		setNumber((n) => n + 1);
	}}
>
		Increase the number
</button>
```

#### サンプル003■React + TypeScript: Queueing a Series of State Updates 03

https://codesandbox.io/embed/react-typescript-queueing-a-series-of-state-updates-03-sdneyl?fontsize=14&hidenavigation=1&theme=dark

イベントハンドラは、Reactにつぎのように告げます。

1. `setNumber(number + 5)`: 前回の状態変数`number`の値は`0`。Reactは、`0 + 5 = 5`への「書き替え」をキューに入れます。
2. `setNumber((n) => n + 1)`: `(n) => n + 1`は更新関数。Reactはこの「更新関数」をキューに加えます。

| キューに入った更新 | n | 戻り値 |
| :---: | :---: | :---: |
| 「`5`への書き替え」 | `0`(使用せず) | `5` |
| `(n) => n + 1` | `5` | `5 + 1 = 6` |

つぎのレンダリング時、Reactはキューを順に進みます。そして、`6`を最終的な値として保持し、`useState`から返すのです。値の書き替えというのは、更新関数として`((n) => x)`が渡され、引数が使われないと捉えることもできます。


# 状態変数値を更新したあと書き替えた場合
更新関数で状態変数値が処理されたあと、さらに値を書き替えた場合はどうでしょうか。設定関数`setNumber()`のはじめのふたつの呼び出しは前掲コード例と同じです。そのあと、`setNumber(42)`を加えました。

```react
<button
	onClick={() => {
		setNumber(number + 5);
		setNumber((n) => n + 1);
		setNumber(42);
	}}
>
		Increase the number
</button>
```

#### サンプル004■React + TypeScript: Queueing a Series of State Updates 04

https://codesandbox.io/embed/react-typescript-queueing-a-series-of-state-updates-04-6gmr5h?fontsize=14&hidenavigation=1&theme=dark

3つめの設定関数の呼び出しは、状態変数の値を`42`に書き替えます。Reactは`42`を最終的な値として保持し、`useState`から返すのです。なお、3つめの設定関数を`setNumber(number + 42)`としても結果は変わりません。状態変数`number`の値は前回の`0`に固定されているからです。ふたつめの設定関数に渡した更新関数の戻り値`6`は使われません。

| キューに入った更新 | n | 戻り値 |
| :---: | :---: | :---: |
| 「`5`への書き替え」 | `0`(使用せず) | `5` |
| `(n) => n + 1` | `5` | `5 + 1 = 6` |
| 「`42`への書き替え」 | `6`(使用せず) | `42` |

設定関数`setNumber()`に、更新関数と書き替え値をそれぞれ渡した場合についてまとめましょう。

* **更新関数**(例: `(n) => n + 1`): キューには更新関数が加えられて値を処理する。
* **値の書き替え**(例: `number = 5`): キューに「`5`への書き替え」が加えられ、それまでのキューで処理した値は上書きされる。

イベントハンドラのコードを実行し終えると、Reactの再レンダリングが開始されます。再レンダリング時にReactにより進められるのがキューの処理です。更新関数はレンダリング中に実行されます。そのため、**結果のみを返す純粋な関数**でなければなりません。更新関数の中から状態を設定したり、他の副作用を実行することは許されないのです。

なお、[`StrictMode`](https://ja.reactjs.org/docs/strict-mode.html)が有効な開発時には、Reactは更新関数をそれぞれ2回ずつ呼び出します(ただし、2回目の結果は破棄)。これはコードの問題を見つけやすくするためです(「[React + TypeScript: React 18でコンポーネントのマウント時にuseEffectが2度実行されてしまう](https://qiita.com/FumioNonaka/items/f89443bc056eec5d8829)」参照)。


# 命名規則
更新関数の引数名には、状態変数の頭文字を用いるのが一般的です。

```react
setEnabled((e) => !e);
setLastName((ln) => ln.reverse());
setFriendCount((fc) => fc * 2);
```

コードをより詳しく書きたいときは、`setEnabled((enabled) => !enabled)`のように状態変数名をそのまま使ったり、`setEnabled((prevEnabled) => !prevEnabled)`のような接頭辞が添えられることもあります。


# まとめ
この記事では、つぎのような項目についてご説明しました。

* 状態を設定しても、既存のレンダリングの変数は変わりません。新たなレンダリングが求められます。
* Reactはイベントハンドラの実行が終わったあと、状態の更新を処理します。これがバッチ処理です。
* 1回のイベントで状態を複数回更新するには、`setNumber((n) => n + 1)`といった更新関数を用います。