ReactのuseRefで、前のレンダーの値を覚えておく方法

​​React​ESLint,TypeScript,useEffect,useRef,useState

useRef に値を入れておき、エフェクトの中で書き換えると、次のレンダーで「前のレンダーのときの値」を読めます。カウンターや価格の表示で、数値が前回から増えたか減ったかを出したいときや、前回の値と比べて処理を変えたいときに使う書き方です。ただし、この書き方には、関係のない再レンダーが起きると前の値が今の値と同じになるという動きがあります。画面に出す「変わる前の値」は、公式ドキュメントが案内している state を使う書き方のほうが確実でした。

補足

検証環境は Ubuntu 24.04、Node.js 22.23.4 です。使ったのは react / react-dom 19.3.1、@types/react 19.3.0、TypeScript 6.0.3、esbuild 0.28.2、ESLint 9.39.5、eslint-plugin-react-hooks 7.1.1 です。.tsx を tsc で型チェックしてから esbuild で開発用ビルドにし、Playwright 1.63.0 で Chromium 153 を動かしてボタンを押しました。本番用ビルド、React Compiler を通したコード、Firefox と Safari では試していません。

useRef とエフェクトで、前のレンダーの値を返す

前のレンダーの値を返すカスタムフックは、usePrevious という名前で書かれることがあります。中身は、useRef で作った箱と、レンダーが終わったあとに動くエフェクトだけです。

ts
import { useEffect, useRef } from 'react';

// 前のレンダーのときの value を返す
export function usePrevious<T>(value: T): T | undefined {
  const ref = useRef<T | undefined>(undefined);
  useEffect(() => {
    ref.current = value;
  });
  return ref.current;
}

しくみは、読むときと書くときの順番にあります。レンダー中に return ref.current で読むのは、前のレンダーのあとにエフェクトが入れておいた値です。useEffect の公式リファレンスにあるとおり、エフェクトは、このレンダーの結果が DOM に反映された(コミットされた)あとで動きます。今の value を ref.current に入れるのはそのときなので、読めるのは次のレンダーからです。useRef の公式リファレンスにあるとおり、ref.current を書き換えても再レンダーは起きないので、書き換えた値が画面に出るのは次に再レンダーが起きたときです。

このフックを使って、今の値と前のレンダーの値を並べて表示するカウンターを作りました。描画を起こすためだけに、count とは関係のない state を更新するボタンも置いています。log は、描画のたびに1行を記録する検証用の関数です。

tsx
import { useState } from 'react';
import { usePrevious } from './usePrevious';
import { log } from './log';

export function RefCounter() {
  const [count, setCount] = useState(0);
  const [tick, setTick] = useState(0);
  const prevCount = usePrevious(count);
  log(`描画 RefCounter count=${count} prevCount=${prevCount}`);

  return (
    <div>
      <p>今の値:{count}</p>
      <p>前のレンダーの値:{prevCount ?? 'なし'}</p>
      <button onClick={() => setCount(count + 1)}>+1</button>
      <button onClick={() => setCount(count - 1)}>-1</button>
      <button onClick={() => setTick(tick + 1)}>別の state を更新({tick})</button>
    </div>
  );
}

記事のコードでは、検証で使った className を省いています。

関係のない再レンダーで、前の値が今の値と同じになる

検証環境で「+1」「+1」「別の state を更新」「-1」「別の state を更新」の順に押すと、記録は次のようになりました。

text
--- はじめの表示
  描画 RefCounter count=0 prevCount=undefined
--- +1
  描画 RefCounter count=1 prevCount=0
--- +1
  描画 RefCounter count=2 prevCount=1
--- 別の state を更新
  描画 RefCounter count=2 prevCount=2
--- -1
  描画 RefCounter count=1 prevCount=2
--- 別の state を更新
  描画 RefCounter count=1 prevCount=1

最初の表示では、エフェクトがまだ一度も動いていないので undefined です。「+1」を2回押すと、前のレンダーの値は 0、1 と返りました。ところが「別の state を更新」を押すと、count は 2 のままなのに、前の値も 2 になりました。直前のレンダーでも count は 2 だったので、「前のレンダーの値」としては正しい結果です。

困るのは、「数値が変わる前の値」を出したいときです。上の結果では、関係のない state を更新しただけで、「前回の値 1 から 2 に増えた」という情報が消えてしまいました。

画面に出す前の値は、state に入れる

useRef の公式リファレンスは、初期化のときを除いて、レンダー中に ref.current を読み書きしないように書いています。同じページのref で値を参照する使い方の説明では、レンダー中に読み書きしなければならないときは useState を使うように案内していて、その例がuseState の公式リファレンスにある「直前のレンダーの情報を保存する」の節です。

この節の書き方をもとに、直前のレンダーの count を lastCount、変わる前の値を prevCount という state に入れ、count が変わったときだけ、レンダー中に両方を更新するようにしました。

tsx
import { useState } from 'react';
import { log } from './log';

export function StateCounter() {
  const [count, setCount] = useState(0);
  const [tick, setTick] = useState(0);
  const [prevCount, setPrevCount] = useState<number | undefined>(undefined);
  const [lastCount, setLastCount] = useState(count);
  if (lastCount !== count) {
    setPrevCount(lastCount);
    setLastCount(count);
  }
  log(`描画 StateCounter count=${count} prevCount=${prevCount}`);

  return (
    <div>
      <p>今の値:{count}</p>
      <p>変わる前の値:{prevCount ?? 'なし'}</p>
      {/* ボタンは RefCounter と同じ */}
    </div>
  );
}

同じ順にボタンを押したときの記録です。

text
--- はじめの表示
  描画 StateCounter count=0 prevCount=undefined
--- +1
  描画 StateCounter count=1 prevCount=undefined
  描画 StateCounter count=1 prevCount=0
--- +1
  描画 StateCounter count=2 prevCount=0
  描画 StateCounter count=2 prevCount=1
--- 別の state を更新
  描画 StateCounter count=2 prevCount=1
--- -1
  描画 StateCounter count=1 prevCount=1
  描画 StateCounter count=1 prevCount=2
--- 別の state を更新
  描画 StateCounter count=1 prevCount=2

「別の state を更新」を押しても、変わる前の値は 1 や 2 のまま残りました。count が変わったときは記録が2行残っています。1行目は、レンダー中に set 関数を呼んだときの、捨てられる側のレンダーです。useState の公式リファレンスの同じ節にも、レンダー中に set 関数を呼ぶと return の直後に再レンダーが行われ、関数の残りの部分は実行されるが結果は捨てられる、と書かれています。画面に出たのは2行目の値でした。

2つのカウンターを上下に並べ、同じ順でボタンを押した様子です。

上の usePrevious の欄と下の state の欄で、+1 を2回ずつ押したあと「別の state を更新」を押す。上の欄だけ、前のレンダーの値が 1 から 2 に変わってピンクになり、下の欄の変わる前の値は 1 のまま
+1 を2回と「別の state を更新」を押したときの、前の値の変わり方(上が usePrevious、下が state に入れる書き方)
注意

レンダー中に set 関数を呼ぶときは、lastCount !== count のような条件の中に書きます。同じ節によると、条件なしで呼ぶと再レンダーがくり返され、コンポーネントがクラッシュします。

usePrevious は ESLint の refs ルールでエラーになる

usePrevious は、レンダー中に ref.current を読んでいます。eslint-plugin-react-hooks 7.1.1 の recommended 設定で検証用のコードを調べると、usePrevious の return ref.current; の行だけがエラーになりました。StateCounter と、次の節のエフェクトで比べるコードには、エラーは出ていません。

text
/path/to/app/src/usePrevious.ts
  9:10  error  Error: Cannot access refs during render

出力は先頭の2行だけを抜き出し、パスは例示用の値に置き換えています。ルールの名前は react-hooks/refs です。公式ドキュメントにある refs ルールの説明では、レンダー中に ref.current を読むことと書き込むことの両方が、ルールに反する例として挙がっています。

前の値と比べるだけなら、エフェクトの中で ref を読む

画面には出さず、値が変わったときに「増えたか減ったか」で処理を分けたいだけなら、ref を読み書きするのをエフェクトの中だけにします。useRef の公式リファレンスにある、ref で値を参照する使い方の説明でも、ref はイベントハンドラかエフェクトの中で読み書きするように書かれています。

tsx
import { useEffect, useRef, useState } from 'react';
import { log } from './log';

export function EffectCompare() {
  const [count, setCount] = useState(0);
  const [tick, setTick] = useState(0);
  const prevRef = useRef(count);

  useEffect(() => {
    const prev = prevRef.current;
    if (prev !== count) {
      log(`変化 ${prev} → ${count}(${count > prev ? '増えた' : '減った'})`);
    } else {
      log(`変化なし ${prev} → ${count}`);
    }
    prevRef.current = count;
  }, [count]);

  // 表示(今の値だけ)とボタンは、ここまでのカウンターと同じ
}

同じ順にボタンを押すと、記録は次のとおりでした。

text
--- はじめの表示
  変化なし 0 → 0
--- +1
  変化 0 → 1(増えた)
--- +1
  変化 1 → 2(増えた)
--- 別の state を更新
--- -1
  変化 2 → 1(減った)
--- 別の state を更新

依存配列を [count] にしているので、「別の state を更新」ではエフェクトが動かず、何も記録されませんでした。count が変わったときだけ、前の値と今の値がそろって読めています。

useRef(count) で最初の値を入れているので、最初の表示では前の値と今の値が同じになります。prev !== count で比べているのは、そのためです。StrictMode を有効にした開発用ビルドでは、最初の表示で「変化なし 0 → 0」が2回記録されました。useEffect の公式リファレンスにあるとおり、StrictMode では開発時だけ、エフェクトのセットアップとクリーンアップが1回多く動くためです。比べる条件を入れておけば、この2回目で「増えた」「減った」の処理が動くことはありません。

usePrevious の書き方も StrictMode で試しました。記録は1回の描画ごとに2行ずつになりましたが、画面に出た値は StrictMode なしのときと同じで、「別の state を更新」で前の値が今の値と同じになる動きも変わりませんでした。

​Posted by 86