HOWTO · React

React での console.log() の使い方

React のデバッグで console.log() を使い、ブラウザーの開発者コンソールで JavaScript の値、コンポーネントの state、props、イベントデータを確認する方法を紹介します。ログが実行されるタイミングと、一時的なログを安全に整理する方法も説明します。

このページの内容

React のデバッグ中に console.log() を使うと、値をブラウザーの開発者コンソールに出力して JavaScript のデータを確認できます。調べたい値が使える場所に呼び出しを置きましょう。props やそのレンダー時点の state はコンポーネント内で、確定後の state はエフェクト内で、ユーザー入力はイベントハンドラー内で確認できます。

React における console.log() の役割

console.log() は JavaScript のメソッドであり、React 固有の機能ではありません。渡した引数を開発者コンソールに出力しますが、ページ上に表示するものではありません。ブラウザーの開発者ツールを開き、「Console」パネルを選ぶとメッセージを確認できます。コンポーネントがレンダーされても、実行が呼び出し箇所に到達しなければログは出ません。

console API とそのメソッドのリファレンスは、MDN の console ドキュメントを参照してください。

JavaScript での基本的なコンソール出力

console.log() には、文字列、数値、オブジェクト、配列、または複数の値を渡せます。次の JavaScript の例は、挨拶の文字列を開発者コンソールに出力します。表示される行はその下のとおりです。

console.log("Hello, React!");
Hello, React!

たとえば、console.log("user", user) のように書くと、ラベルとオブジェクトを一緒に確認できます。ブラウザーのコンソールはオブジェクトを調べやすい形で表示しますが、具体的な見え方はブラウザーによって異なります。メッセージにスタイルを付けるには、console.log("%cImportant", "color: red; font-weight: bold") のように %c フォーマット指定子を使います。%c の後に渡したスタイル文字列がメッセージに適用されます。console.important() は組み込みメソッドではないため、その動作を使うには独自のラッパーを定義する必要があります。

コンポーネントの state を記録する

関数コンポーネントの本体に console.log(count) を置くと、そのレンダーで使われている count の値を確認できます。React がコンポーネントを再レンダーすると本体も再実行されるため、このログは何度も表示されることがあります。Strict Mode などの開発時の動作によって追加のレンダーが発生する場合もあるので、ユーザー操作 1 回につきログも 1 回だけとは限りません。

state の更新は後続のレンダーを予定します。setCount(count + 1) の直後にログを出しても、読み取られるのは現在のレンダーに対応する count です。確定した各値を確認するには、依存配列に [count] を指定したエフェクト内で console.log(count) を実行します。このエフェクトは初回のマウント後にも実行されます。更新を要求した操作そのものを記録したい場合は、state updater の中に副作用としてログを書くのではなく、イベントやアクションを処理する箇所で記録しましょう。

props を確認する

props を受け取るコンポーネント内で、その prop をログに出します。たとえば、user を受け取る子コンポーネントなら、関数本体で console.log("user prop", user) を呼び出せます。そのレンダーに渡された値を確認でき、親から子へのデータの流れを追うのに役立ちます。レンダーのたびに同じ prop が繰り返し記録されることがあります。入れ子になったデータを調べる場合は、確認したいフィールドだけを出力すると結果を追いやすくなります。

イベントデータを記録する

ユーザーがページを操作したときのデータを確認するには、イベントハンドラーにログを置きます。入力欄の変更ハンドラーなら、console.log(event.currentTarget.value) でハンドラー実行時点の入力値を読み取れます。ハンドラー内で state も更新する場合、イベントの値はその場で取得できますが、新しい state が反映されるのは後続のレンダーです。ハンドラー内で記録すれば、関係のないコンポーネントのレンダーによって同じメッセージが出るのを避けられます。

ログを安全に扱い、削除する

ログは一時的なデバッグ用として扱いましょう。リリース前にコードを検索し、不要になったログを削除してください。個人データ、トークンなどの機密情報を含む値を出力するログは特に注意が必要です。本番ビルドですべての console.log() が自動的に削除されるわけではなく、削除されるかどうかはプロジェクトのビルド設定によります。運用目的で残すログは、アプリケーションのログ方針に合うものに限りましょう。

値を確認するときは、その値が利用できる場所で記録します。コンポーネントのデータならレンダー中またはエフェクト内、ユーザー操作のデータならイベントハンドラー内が適しています。長めのデバッグでは、ブラウザーのブレークポイントや React Developer Tools を使うと、コードにログを残さずに実行の流れやコンポーネントのデータを調べられます。ブラウザーコンソールのクリア操作、または console.clear() で表示中の内容を消せますが、コード内のログ呼び出しは削除されません。本番バンドルからログを取り除く想定ならビルド設定を確認し、そうでなければリリース前に一時的な呼び出しをソースから削除してください。