<StrictMode>
<StrictMode>
は、開発環境においてコンポーネントの一般的なバグを早期に見つけるのに役立ちます。
<StrictMode>
<App />
</StrictMode>
リファレンス
<StrictMode>
StrictMode
を使用して、内側のコンポーネントツリーに対して開発時専用の挙動と警告を有効にします。
import { StrictMode } from 'react';
import { createRoot } from 'react-dom/client';
const root = createRoot(document.getElementById('root'));
root.render(
<StrictMode>
<App />
</StrictMode>
);
Strict Mode では、以下のような開発時専用の挙動が有効になります。
- コンポーネントは、純粋でない (impure) レンダーによって引き起こされるバグを見つけるために、レンダーを追加で 1 回行います。
- コンポーネントは、エフェクトのクリーンアップし忘れによるバグを見つけるために、エフェクトの実行を追加で 1 回行います。
- コンポーネントが非推奨の API を使用していないかチェックします。
props
StrictMode
は props を受け付けません。
注意点
- 一旦
<StrictMode>
でラップされたツリー内で Strict Mode を無効化する方法はありません。これにより、<StrictMode>
内のすべてのコンポーネントがチェックされていることを確信できます。あるプロダクト内で、チェックに価値があると感じるかどうかに関して 2 つのチームの意見が割れた場合、合意に達するか、もしくは<StrictMode>
をツリーの下側へ移動する必要があります。
使用法
アプリ全体で Strict Mode を有効にする
Strict Mode は、<StrictMode>
コンポーネント内の全コンポーネントツリーに対して追加の開発時専用チェックを有効にします。これらのチェックは、開発プロセスの早い段階でコンポーネントの一般的なバグを見つけるのに役立ちます。
アプリ全体で Strict Mode を有効にするには、ルートコンポーネントをレンダーする際にそれを <StrictMode>
でラップします。
import { StrictMode } from 'react';
import { createRoot } from 'react-dom/client';
const root = createRoot(document.getElementById('root'));
root.render(
<StrictMode>
<App />
</StrictMode>
);
特に新しく作成されたアプリについては、アプリ全体を Strict Mode でラップすることをお勧めします。createRoot
の呼び出しを自動的に行うフレームワークを使用している場合は、ドキュメンテーションを参照して Strict Mode を有効にする方法を確認してください。
Strict Mode のチェックは開発中にのみ実行されるものですが、これらは既にコード内に存在するが本番環境での確実な再現が難しいバグを見つけるのに役立ちます。Strict Mode を使用することで、バグをユーザが報告してくる前に修正することができます。
アプリの一部で Strict Mode を有効にする
アプリケーションの任意の一部分でのみ Strict Mode を有効にすることも可能です。
import { StrictMode } from 'react';
function App() {
return (
<>
<Header />
<StrictMode>
<main>
<Sidebar />
<Content />
</main>
</StrictMode>
<Footer />
</>
);
}
上記の例では、Strict Mode のチェックは Header
と Footer
コンポーネントに対しては実行されません。しかし、Sidebar
と Content
、およびそれらの中にあるすべてのコンポーネントに対しては、どれだけ深いところにあってもチェックが実行されます。
開発中の二重レンダーによって見つかったバグの修正
React は、あなたの書くすべてのコンポーネントが純関数 (pure function) であると仮定しています。これは、あなたが書く React コンポーネントは、同じ入力(props、state、context)が与えられた場合に常に同じ JSX を返さなければならないという意味です。
このルールを守らないコンポーネントは予測不能な挙動を示し、バグを引き起こします。うっかり純粋でなくなってしまったコードを見つけるために、Strict Mode はあなたの関数の一部(純粋であるべきものだけ)を開発中に 2 回呼び出します。これには以下が含まれます。
- あなたのコンポーネント関数本体(トップレベルのロジックのみ。イベントハンドラ内のコードは含まれません。)
useState
、set
関数、useMemo
、およびuseReducer
に渡す関数constructor
、render
、shouldComponentUpdate
などの一部のクラスコンポーネントメソッド(全リストを見る)
関数が純粋であれば、結果は毎回同じになるので、2 回実行してもその振る舞いは変わりません。しかし、関数が純粋でない(例えば、受け取ったデータを書き換えている)場合、2 回実行することで目に見える影響が出る(まさにそれが純粋でないということです!)傾向があります。これにより、バグを早期に見つけて修正するのに役立ちます。
以下は、Strict Mode での二重レンダーがどのように早期にバグを見つけるのに役立つかを示す例です。
この StoryTray
コンポーネントは stories
の配列を受け取り、その最後に “Create Story” という項目を加えて表示します。
export default function StoryTray({ stories }) { const items = stories; items.push({ id: 'create', label: 'Create Story' }); return ( <ul> {items.map(story => ( <li key={story.id}> {story.label} </li> ))} </ul> ); }
上記のコードには間違いがあります。しかし、初回の出力は正しく見えるため、容易に見落としてしまいます。
StoryTray
コンポーネントが複数回レンダーされるとこの間違いに気付きやすくなります。例えば、マウスを StoryTray
の上にホバーすると背景色を変えて StoryTray
が再レンダーされるようにしてみましょう。
import { useState } from 'react'; export default function StoryTray({ stories }) { const [isHover, setIsHover] = useState(false); const items = stories; items.push({ id: 'create', label: 'Create Story' }); return ( <ul onPointerEnter={() => setIsHover(true)} onPointerLeave={() => setIsHover(false)} style={{ backgroundColor: isHover ? '#ddd' : '#fff' }} > {items.map(story => ( <li key={story.id}> {story.label} </li> ))} </ul> ); }
StoryTray
コンポーネントの上にマウスをホバーするたびに、“Create Story” が再度リストに追加されることに注意してください。コードの意図は、最後に一度だけ追加することでした。しかし、StoryTray
は props の stories
配列を直接書き換えています。StoryTray
がレンダーされるたびに、同じ配列の最後に “Create Story” を再び追加しています。つまり、StoryTray
は純関数ではなく、複数回実行することで異なる結果が返ってきます。
この問題を解決するためには、配列のコピーを作り、元の配列の代わりにそのコピーを書き換えるようにできます。
export default function StoryTray({ stories }) {
const items = stories.slice(); // Clone the array
// ✅ Good: Pushing into a new array
items.push({ id: 'create', label: 'Create Story' });
これにより、StoryTray
関数は純関数になります。呼び出されるたびに、新しい配列のコピーだけが書き換わり、外部のオブジェクトや変数には影響を与えません。これによりバグは修正されましたが、振る舞いに問題があることに気付けるようになる前に、コンポーネントを通常より多く再レンダーする必要がありました。
この例では、バグが明らかではありませんでした。では、元の(バグがある)コードを <StrictMode>
でラップしてみましょう:
export default function StoryTray({ stories }) { const items = stories; items.push({ id: 'create', label: 'Create Story' }); return ( <ul> {items.map(story => ( <li key={story.id}> {story.label} </li> ))} </ul> ); }
Strict Mode は常にレンダー関数を 2 回呼び出すため、すぐに間違った結果が目に入ります(“Create Story” が 2 回表示されます)。これにより、早期にこのような間違いに気づくことができます。Strict Mode でコンポーネントをレンダーするようにすることで、先ほどのホバー機能のような、将来本番環境で発生しうる多くのバグも、あらかじめ潰しておけるのです。
import { useState } from 'react'; export default function StoryTray({ stories }) { const [isHover, setIsHover] = useState(false); const items = stories.slice(); // Clone the array items.push({ id: 'create', label: 'Create Story' }); return ( <ul onPointerEnter={() => setIsHover(true)} onPointerLeave={() => setIsHover(false)} style={{ backgroundColor: isHover ? '#ddd' : '#fff' }} > {items.map(story => ( <li key={story.id}> {story.label} </li> ))} </ul> ); }
Strict Mode がなければ、再レンダーを追加しない限りバグを容易に見逃してしまう状態でした。Strict Mode は同じバグをすぐに見つかるようにします。Strict Mode は、チームやユーザに公開してしまう前にバグを見つけるのに役立ちます。
開発中にエフェクトを再実行して見つかったバグの修正
Strict Mode は、エフェクトのバグを見つけるのにも役立ちます。
すべてのエフェクトにはセットアップコードがあり、一部のエフェクトにはクリーンアップコードもあります。通常、React はコンポーネントがマウント(画面に追加)されたときにセットアップコードを呼び出し、コンポーネントがアンマウント(画面から削除)されたときにクリーンアップコードを呼び出します。その後、前回のレンダー以降に依存配列が変更された場合、React は再度クリーンアップとセットアップを呼び出します。
Strict Mode がオンの場合、React は開発中にすべてのエフェクトに対して 追加で 1 回、セットアップ+クリーンアップのサイクルを実行します。この挙動に驚くかもしれませんが、手動で見つけるのが難しい微妙なバグを明らかにするのに役立ちます。
Strict Mode でエフェクトを再実行することが、早期にバグを見つけるのにどのように役立つかを示す例を示します。
以下の例では、コンポーネントをチャットに接続しています。
import { createRoot } from 'react-dom/client'; import './styles.css'; import App from './App'; const root = createRoot(document.getElementById("root")); root.render(<App />);
このコードには問題がありますが、すぐには明らかではないかもしれません。
問題を目立たせるため、機能を実装してみましょう。以下の例では、roomId
はハードコードされておらず、代わりに、ユーザはドロップダウンから接続したい roomId
を選択できます。“Open chat” をクリックし、次にひとつずつ異なるチャットルームを選択してください。コンソールでアクティブな接続の数を数えてみてください。
import { createRoot } from 'react-dom/client'; import './styles.css'; import App from './App'; const root = createRoot(document.getElementById("root")); root.render(<App />);
開いている接続の数が増え続けていくことにお気づきでしょう。実際のアプリケーションでは、これによりパフォーマンスやネットワークの問題が発生します。問題は、エフェクトにクリーンアップ関数がないことです。
useEffect(() => {
const connection = createConnection(serverUrl, roomId);
connection.connect();
return () => connection.disconnect();
}, [roomId]);
これでエフェクトが自身を「クリーンアップ」し、古い接続を破棄するようになったので、リークは解消されました。しかし、問題が見えてくるのは、より多くの機能(選択ボックス)を追加した後でした。
元の例では、バグは明らかではありませんでした。では、元の(バグのある)コードを <StrictMode>
でラップしてみましょう:
import { StrictMode } from 'react'; import { createRoot } from 'react-dom/client'; import './styles.css'; import App from './App'; const root = createRoot(document.getElementById("root")); root.render( <StrictMode> <App /> </StrictMode> );
Strict Mode を使用すると、すぐに問題があることがわかります(アクティブな接続の数が 2 に跳ね上がります)。Strict Mode は、すべてのエフェクトに対してセットアップ+クリーンアップのサイクルを追加で実行します。このエフェクトにはクリーンアップロジックがないため、余分な接続が作成されても破棄されませんでした。これは、クリーンアップ関数が欠けていることを示すヒントです。
Strict Mode を使用すると、このようなミスを早期に気付くことができます。Strict Mode でエフェクトにクリーンアップ関数を追加して修正することで、先ほどの選択ボックスのような、将来本番環境で発生しうる多くのバグも、あらかじめ潰しておけるのです。
import { StrictMode } from 'react'; import { createRoot } from 'react-dom/client'; import './styles.css'; import App from './App'; const root = createRoot(document.getElementById("root")); root.render( <StrictMode> <App /> </StrictMode> );
コンソールに表示されるアクティブな接続の数が増えていかなくなったことに注目してください。
Strict Mode がなければ、エフェクトがクリーンアップを必要としていることを容易に見逃すところでした。開発中にエフェクトに対して「セットアップ → クリーンアップ → セットアップ」を実行することで、Strict Mode はクリーンアップロジックが欠けていることにより気付きやすくしたのです。
Strict Mode によって有効化された非推奨警告の修正
React は、<StrictMode>
ツリー内のいずれかのコンポーネントが以下の非推奨 API を使用している場合に警告を発します。
findDOMNode
。代替手段を見るUNSAFE_
クラスライフサイクルメソッド(UNSAFE_componentWillMount
など)。代替手段を見る- レガシーコンテクスト(
childContextTypes
、contextTypes
、getChildContext
)。代替手段を見る - レガシーの文字列型 ref(
this.refs
)。代替手段を見る
これらの API は主に古いクラスコンポーネントで使用されているものであり、現在のアプリケーションではほとんど見られません。