Next.jsで学ぶReact講座 90日コース | React実践力を身につける - Day 30:Reactデバッグ

React Next.jsで学ぶReact講座90日コース
スポンサーリンク
スポンサーリンク

Day 30:Reactデバッグ

デバッグとは、アプリの不具合を見つけ、原因を確かめ、修正する作業です。この日は、console.log、React Developer Tools、エラーメッセージを使ってStateやPropsを確認し、意図的に作ったバグを順番に直します。

大切なのは、コードを手当たり次第に書き換えないことです。「何が起きているか」「本来は何が起きるはずか」「その違いを生む原因は何か」を小さく確かめていきます。

1. デバッグの基本手順

不具合が起きたら、まず再現できる操作を確認します。たとえば「追加ボタンを押すと画面が更新されない」のように、問題を具体的にします。

  • 再現する:どんな操作で問題が起きるか確認します。
  • 期待する結果を書く:ボタンを押したらタスクが1件増える、などを明確にします。
  • 実際の結果を確認する:画面、Console、エラー表示を見ます。
  • 原因の候補を絞る:State、Props、イベント処理などを確認します。
  • 小さく修正する:一度に一か所を直し、同じ操作で再確認します。

「動かない」だけでは原因が広すぎます。問題を「入力欄には文字が入るが、追加後に一覧へ出ない」のように具体化すると、確認箇所を絞りやすくなります。

2. console.logで値を確認する

console.logは、コードが実行されたか、StateやPropsにどんな値が入っているかを調べる基本的な方法です。ブラウザーの開発者ツールでConsoleを開くと、ログを確認できます。

// 現在の入力値を確認する例です
function handleSubmit() {
  // 入力値が想定どおりかConsoleで確認します
  console.log("入力値:", inputValue);

  // ここに追加処理を書きます
}
JSX

オブジェクトや配列を確認するときは、ラベルも付けると、複数のログを見分けやすくなります。

// StateとPropsの値をラベル付きで確認します
console.log("tasks:", tasks);
console.log("filter:", filter);
console.log("props:", props);
JSX

ログを置く位置も重要です。イベント処理の冒頭に置けば「クリック時に処理が呼ばれたか」を調べられ、State更新の前後に置けば「更新に使う値」を確認できます。

3. State更新直後のログに注意する

Reactでは、State更新を依頼しても、その行の直後にある変数がすぐ新しい値へ変わるわけではありません。Stateは、そのレンダーで使われる値として扱われます。

// State更新の例です
function handleClick() {
  // 次の画面更新でcountを1増やすよう依頼します
  setCount((currentCount) => currentCount + 1);

  // この行では、現在のレンダーのcountが表示されます
  console.log("更新を依頼した直後のcount:", count);
}
JSX

このログが古い値を示しても、必ずしもState更新の失敗ではありません。画面が次に描画されたときの値を確認するか、React Developer ToolsでStateを確認します。

4. React Developer ToolsでStateとPropsを見る

React Developer Toolsは、Reactコンポーネントの階層を確認するための開発者向けツールです。ブラウザーに対応する拡張機能を追加すると、開発者ツール内で主にComponentsとProfilerを使えます。

  • Components:コンポーネントの階層、選択したコンポーネントのPropsやHooksの値を確認します。
  • Profiler:記録した操作で、どのコンポーネントが描画されたかを調べるのに使います。

たとえば、タスクが一覧に出ないときは、Componentsで該当コンポーネントを選び、次を確認します。

  • 親から渡されたPropsにデータが入っているか。
  • Stateが期待した値になっているか。
  • コンポーネントが画面に描画されているか。

ツールの表示名や場所は、ブラウザーや拡張機能のバージョンによって異なることがあります。見当たらない場合は、開発者ツールを開き直すか、React Developer Toolsが有効になっているか確認します。

5. エラーメッセージの読み方

エラーが出たときは、全文を読み、まずエラーの種類と発生箇所を探します。スタックトレースには、エラーが起きたファイルや行に関する情報が含まれることがあります。

たとえば、次のエラーが出たとします。

Cannot read properties of undefined

これは、値がundefinedなのに、その値のプロパティを読もうとした可能性を示します。

// userがundefinedなら、user.nameを読むとエラーになる可能性があります
<p>{user.name}</p>
JSX

userがまだ存在しない場合もあるなら、状態に応じて表示を分けます。

// userが存在するときだけ名前を表示します
{user ? <p>{user.name}</p> : <p>ユーザー情報はありません。</p>}
JSX

エラーメッセージの最後だけを見るのではなく、最初に出たエラーと、その直前に行った操作にも注目してください。後続のエラーは、最初の不具合が原因で発生していることがあります。

6. 意図的にバグを作って直す

次の例には、State更新のバグがあります。ボタンを押しても、タスク一覧が正しく更新されないことがあります。

// バグを含む例です
function addTask() {
  // 既存のState配列を直接変更しています
  tasks.push({
    id: Date.now(),
    title: inputValue,
  });

  // 同じ配列をStateに渡しています
  setTasks(tasks);
}
JSX

ここでは、tasks.push()が既存の配列を直接変更しています。さらに、同じ配列をsetTasksへ渡しています。ReactのStateは、元の値を直接変更せず、新しい配列やオブジェクトを作って更新するのが基本です。

修正例

// Stateを直接変更せず、新しい配列を作ります
function addTask() {
  // 入力値を前後の空白を除いて確認します
  const title = inputValue.trim();

  // 空のタスクは追加しません
  if (title === "") {
    return;
  }

  // State更新関数の中で新しいタスクと配列を作ります
  setTasks((currentTasks) => [
    ...currentTasks,
    {
      id: crypto.randomUUID(),
      title,
    },
  ]);

  // 入力欄を空にします
  setInputValue("");
}
JSX

配列の末尾へ追加する場合は、スプレッド構文で既存の要素をコピーし、新しいタスクを加えます。setTasks(currentTasks => ...)のような関数形式は、最新のStateをもとに更新したいときに便利です。

7. Propsの名前を確認する

次の例では、親がitemという名前のPropsを渡しているのに、子はtaskという名前で受け取っています。

// 親:itemというProps名で渡しています
<TaskItem item={task} />

// 子:taskという名前で受け取ろうとしています
function TaskItem({ task }) {
  return <p>{task.title}</p>;
}
JSX

子のtaskはundefinedになるため、task.titleを読むとエラーになる可能性があります。Props名は、渡す側と受け取る側でそろえます。

// 修正例:渡す側と受け取る側をtaskに統一します
<TaskItem task={task} />

function TaskItem({ task }) {
  return <p>{task.title}</p>;
}
JSX

Propsを確認するときは、親から渡す場所と子で受け取る場所の両方を見ます。React Developer ToolsのComponentsでも、選択したコンポーネントのPropsを調べられます。

8. keyの警告を読む

配列をmap()で表示する場合、各項目に安定したkeyを指定します。指定しないと、Consoleに警告が表示されることがあります。

// keyがない例です
{tasks.map((task) => (
  <li>{task.title}</li>
))}
JSX

タスクごとのIDがあるなら、それを使います。

// 各タスクを識別できるIDをkeyに使います
{tasks.map((task) => (
  <li key={task.id}>{task.title}</li>
))}
JSX

keyには配列の順番より、タスクごとに安定しているIDを使うのが適しています。項目の追加や削除で順番が変わるリストでは、配列番号を使うとReactが項目を誤って対応付けることがあります。

9. Next.jsで確認する場所を分ける

Next.jsでは、エラーが出た場所によって確認する画面が異なります。

  • ブラウザーで起きたエラー:ブラウザーのConsoleや開発者ツールを確認します。
  • 開発サーバー側のエラー:ターミナルに出ているログを確認します。
  • 画面に重ねて表示されるエラー:開発時のエラー表示に書かれたファイル名や行番号を確認します。

Client Componentで起きた問題がターミナルだけに出るとは限らず、サーバー側の問題がブラウザーのConsoleだけに出るとも限りません。画面・ブラウザー・ターミナルのどこにエラーが出たかを手掛かりにします。

10. デバッグ演習:タスク追加のバグを見つける

次のコードには、タスクが追加されない原因があります。どこが問題かを自分で確認してから、修正版を見てください。

// バグを探すための練習用コードです
function TaskList() {
  // タスク一覧をStateで管理します
  const [tasks, setTasks] = useState([]);

  // タスクを追加する処理です
  function handleAdd() {
    // 新しいタスクを作ります
    const newTask = {
      id: crypto.randomUUID(),
      title: "練習タスク",
    };

    // 問題:Stateの配列を直接変更しています
    tasks.push(newTask);

    // 問題:元と同じ配列を渡しています
    setTasks(tasks);
  }

  return (
    <section>
      {/* ボタンを押してタスクを追加します */}
      <button type="button" onClick={handleAdd}>
        追加
      </button>

      {/* タスク一覧を表示します */}
      <ul>
        {tasks.map((task) => (
          // 問題:keyがありません
          <li>{task.title}</li>
        ))}
      </ul>
    </section>
  );
}
JSX

修正版

// ReactのState管理機能を読み込みます
import { useState } from "react";

// 修正済みのタスク一覧コンポーネントです
function TaskList() {
  // タスク一覧をStateで管理します
  const [tasks, setTasks] = useState([]);

  // 新しいタスクを追加する処理です
  function handleAdd() {
    // イベント処理の中でタスクを作ります
    const newTask = {
      id: crypto.randomUUID(),
      title: "練習タスク",
    };

    // 新しい配列を作ってタスクを追加します
    setTasks((currentTasks) => [...currentTasks, newTask]);
  }

  return (
    <section>
      {/* クリック時に関数を実行します */}
      <button type="button" onClick={handleAdd}>
        追加
      </button>

      {/* タスク一覧を表示します */}
      <ul>
        {tasks.map((task) => (
          // タスクのIDをkeyとして使います
          <li key={task.id}>{task.title}</li>
        ))}
      </ul>
    </section>
  );
}
JSX

修正版では、State配列を直接変更せず、新しい配列を作っています。また、各項目にタスクIDのkeyを付けました。

11. デバッグ時に便利なチェック項目

問題が起きたら、関係する項目を順番に確認します。

  • イベント:クリックや送信時にハンドラーが呼ばれていますか。
  • State:更新前の値と、更新に使う値は期待どおりですか。
  • Props:親が渡す名前と、子が受け取る名前は一致していますか。
  • 条件表示:条件が想定外で、要素が表示されない状態になっていませんか。
  • 配列表示:`map()`に正しい配列を渡し、各項目に`key`を付けていますか。
  • エラーの場所:ブラウザー、開発サーバー、画面上のエラー表示のどこに出ていますか。

12. ログの安全な扱い

デバッグログにパスワード、認証トークン、秘密鍵、個人情報を出さないようにします。開発中のConsoleは画面共有やログ収集などで他者に見えることがあります。

// 安全な例:処理状況だけをログに出します
console.log("フォーム送信を開始しました");

// 避ける例:秘密情報や個人情報をそのままログに出さないでください
// console.log("入力されたパスワード:", password);
JSX

調査が終わったログは、不要なら削除します。本番環境では、利用者の秘密情報や内部情報がログに出ないように注意してください。

13. Day 30のチェックリスト

  • 不具合を再現する操作と期待する結果を書き出せます。
  • `console.log`でイベント・State・Propsを確認できます。
  • State更新直後のログが古い値を示すことがあると理解しています。
  • React Developer Toolsでコンポーネント、Props、Hooksの値を確認できます。
  • エラーメッセージと発生箇所を手掛かりに原因を絞れます。
  • 配列やオブジェクトのStateを直接変更していません。
  • 一覧の各要素に安定した`key`を指定できます。
  • デバッグログにパスワードや認証情報を出していません。

Reactのデバッグは、エラーを見てすぐコードを書き換える作業ではありません。再現条件を整理し、ConsoleやReact Developer Toolsで値と処理の流れを確認し、原因を一つずつ絞ります。まずは演習コードのバグを自分で直し、修正前後で同じ操作を試して、期待した結果になったか確かめてください。

タイトルとURLをコピーしました