デバッガの使い方 — ブレークポイントで止めて変数を確かめる

デバッガの使い方。ブレークポイントで停止したコードと変数を確認するイメージ。

console.log を10箇所に足して原因を探しているなら、道具を1つ覚えるだけで終わります。

動かないコードを調べるとき、多くの人が最初にやるのは「怪しいところに表示を挟む」ことです。これは間違いではありませんが、遅い。挟んで、動かして、消して、また挟む。1回の実行で1箇所しか見えません。

デバッガは、実行を途中で止めて、その時点の全部の変数を見る道具です。挟む必要がなく、消し忘れも起きません。この記事では、わざと壊した画面を、表示を1つも足さずに直すところまでをやります。

対象レベル: 初級 / 区分: 必修

目次

この記事でわかること

  • 止めた瞬間の変数が全部見えること。1つずつ表示させる必要が無いこと
  • どこで止めるかの決め方。行を指定する以外の止め方
  • 「1行進む」と「中に入る」の違い(ステップオーバーとステップイン)
  • 呼び出し履歴(Call Stack)から、誰がこの関数を呼んだかを辿ること
  • console.log のほうが向いている場面もあること

この記事でやること

  1. わざと結果が合わない画面を1つ作る
  2. 止める場所を決めて実行を止める
  3. 止まった時点の変数を見て、どこで値がおかしくなったかを特定する
  4. 条件を付けて止める(3周目だけ止める)
  5. 例外が出た瞬間に自動で止める設定を試す

先に知る言葉

この記事で初めて出てくる言葉です。 詳しくは用語集にもまとめてあります。

言葉意味
デバッガ実行を途中で止めて、その時点の変数を見る道具
ブレークポイントここに来たら止まれという指示。行番号をクリックして置く
ステップ実行1 行ずつ進めること。関数の中へ入るかどうかで 2 種類ある
スコープその場所から見えている変数の範囲
呼び出し履歴(Call Stack)誰がこの関数を呼んだかの積み重ね

前提と作業場所

ブラウザだけで進みます。 VM も Node.js も要りません。前の回で使った開発者ツールを使います。

作業用のフォルダを1つ作ります。Windows の PowerShell で打ってください。

bash
$ cd ~
$ mkdir debuglab
$ cd debuglab

わざと壊した画面を作る

合計金額を出す、小さな画面を作ります。結果がわざと合いません。

index.html を作ります。

PowerShell
PS> notepad index.html
<!DOCTYPE html>
<html lang="ja">
<head><meta charset="utf-8"><title>合計</title></head>
<body>
  <h1>買い物かご</h1>
  <p id="total">計算中</p>
  <script src="cart.js"></script>
</body>
</html>

cart.js を作ります。

PowerShell
PS> notepad cart.js
const items = [
  { name: "ノート", price: 200, count: 3 },
  { name: "ペン",   price: 120, count: 2 },
  { name: "消しゴム", price: 80, count: "1" }
];

function lineTotal(item) {
  return item.price * item.count;
}

function sum(list) {
  let total = 0;
  for (const item of list) {
    total = total + lineTotal(item);
  }
  return total;
}

document.getElementById("total").textContent = "合計 " + sum(items) + " 円";

index.html をブラウザで開きます。

PowerShell
PS> start index.html

表示は「合計 920 円」のはずです。手で計算すると 200×3 + 120×2 + 80×1 = 920。 合っています。 ここでは、まず正しく動いているものを止めて見るところから始めます。

止めて、中を見る

F12 で開発者ツールを開き、Sources(Firefox ではデバッガー)のタブを開きます。 左のファイル一覧から cart.js を選んでください。

コードが表示されます。行番号をクリックしてください。 total = total + lineTotal(item); の行です。 行番号に印が付きます。これがブレークポイント——「ここに来たら止まれ」という指示です。

ページを再読み込みします(F5)。 画面が途中で止まり、その行が強調されます。

ここで右側のパネルを見てください。

パネル何が見えるか
Scope(スコープ)いま生きている変数の全部。 total・item・items
Call Stack(呼び出し履歴)誰がこの関数を呼んだか。 下から上へ辿る
Breakpointsいま仕掛けてある止め場所の一覧

Scope に total: 0 と item: {name: "ノート", ...} が出ています。 表示を1つも足していないのに、その時点の値が全部見えていることを確かめてください。

コードの上に、変数の上へマウスを乗せても値が出ます。

進めるボタンの意味

止まっている間、上部に並ぶボタンで進めます。使うのは3つだけです。

操作何をするかいつ使うか
再開(▶)次に止まるところまで走るループの次の周へ行きたい
ステップオーバー1行進む。 関数呼び出しは中に入らず、結果だけ受け取るふだんはこれ
ステップイン関数の中へ入るその関数が怪しいとき

ステップオーバーを3回押してください。 total が 0 → 600 と変わります。 1周ごとに値が積み上がる様子が、そのまま見えます。

次に、lineTotal(item) の行でステップインを押してください。 lineTotal の中へ移動し、Call Stack が lineTotal → sum の2段になります。 「いまどこから呼ばれているか」が読めます。

わざと壊して、探す

ここからが本番です。cart.js の lineTotal を、こう変えてください。

function lineTotal(item) {
  return item.price + item.count;
}

* を + にしただけです。保存して再読み込みします。

表示は「合計 325801 円」になります。エラーは出ません。 桁数からして違いますが、なぜこうなるのかは、この時点では分かりません。

ここで console.log を挟みたくなりますが、挟みません。

total = total + lineTotal(item); の行で止めて、ステップインしてください。 lineTotal の中で、Scope を見ます。

item: { name: "ノート", price: 200, count: 3 }

ステップオーバーを1回押すと、返り値が見えます。 Console に item.price + item.count と 打っても確かめられます(止まっている間、Console はその場所の変数を使えます)。

203

200 × 3 = 600 のはずが 203。 掛けていないと分かりました。1回の実行で、 値がおかしくなった場所まで辿り着いています。

桁が跳ねた理由も、進めれば見えます。 再開を押して3周目まで進み、total の変化を見てください。203 → 325 と数値で進んだあと、3周目で "325801" という文字列になります。3つ目の count が文字列なので 80 + "1" が "801" になり、そこから先は足し算ではなく連結に変わったためです。Scope の表示に引用符が付いた瞬間が、その境目です。

* に戻して、再読み込みしてください。920 円に戻ります。

3周目だけ止める — 条件付きブレークポイント

データが 1000 件あるとき、毎回止まっていては終わりません。 「特定の1件のときだけ止めたい」ときに使います。

3つ目の商品 消しゴム は、count が文字列の "1" になっています。 ここだけ止めます。

ブレークポイントの印を右クリックし、「条件付きブレークポイントを編集」を選びます。 条件を入れます。

item.name === "消しゴム"

再読み込みすると、3周目でだけ止まります。 Scope を見てください。

item: { name: "消しゴム", price: 80, count: "1" }

count が "1" と引用符付きで表示されています。 文字列です。 80 * "1" は JavaScript では数値に変換されるのでたまたま 80 になり、 このデータでは表面化しません。足し算に変えた瞬間に "801" のような文字列連結になります。

Console で確かめられます。

item.price * item.count
item.price + item.count
80
"801"

型が違うことが、値を見ただけで分かりました。 引用符が付いているかどうかを見る癖を付けてください。

例外が出た瞬間に止める

エラーの行は分かっても、「そのときの変数」は事後には見られません。 出た瞬間に止める設定があります。

右側の Breakpoints の近くに「例外で一時停止」のチェックがあります。入れてください。

わざと落とします。cart.js の最終行を、こう変えます。

document.getElementById("totl").textContent = "合計 " + sum(items) + " 円";

total を totl と打ち間違えた形です。再読み込みするとその行で止まり、 Scope に document.getElementById("totl") が null であることが見えます。

前の回で見た Cannot read properties of null の仲間で、代入なので Cannot set properties of null と表示されます。 止めて見れば、「読めなかった側」ではなく「null だった側」が一目で分かります。

綴りを total に戻してください。

console.log のほうが向いている場面

デバッガが常に上ではありません。 使い分けます。

場面向いているもの理由
値がどこでおかしくなったか探すデバッガ1回の実行で全部見える
変化を時系列で並べて眺めたいconsole.log止めずに流れが残る
止めると再現しない(タイミングの問題)console.log止めること自体が条件を変える
本番のサーバーで起きているログそもそも止められない

「止めると再現しなくなる」は実際に起きます。 通信の順序が絡む不具合では、 止めている間に処理が終わってしまい、狙った状態を作れません。そのときは素直にログにします。

つまずいたところ

ブレークポイントを置いたのに止まりませんでした。 その行がそもそも実行されていない だけでした。止まらないことも情報です——「ここには来ていない」と分かります。

console.log を消し忘れて公開しました。 開発者ツールを開いた人に、内部の値が見えていました。 デバッガなら、コードに何も残りません。

ステップインを押しすぎて、自分が書いていないコードの中に入り込みました。 ライブラリの中まで潜って迷子になります。入ったら「呼び出し元へ戻る」で1段上がるか、 Call Stack で自分の関数をクリックすれば戻れます。

後片づけ

ブレークポイントを消してください。 Breakpoints の一覧からチェックを外すか、 行番号をもう一度クリックします。「例外で一時停止」も外してください。付けたままだと、 別のサイトを見ているときに止まります。

作業用のフォルダを消します。

cd ~
Remove-Item -Recurse -Force debuglab

まとめ

  • デバッガは実行を止めて、その時点の変数を全部見る道具。表示を挟む必要が無い
  • 使う操作は3つ。再開・ステップオーバー・ステップイン
  • Call Stack で「誰が呼んだか」を辿れる。 迷子になったらここから戻る
  • 件数が多いときは条件付きブレークポイントで、その1件だけ止める
  • 止めると再現しないときと、本番はログ。 道具を使い分ける

参考リンク

次に読む

この記事は 【第2段階】Webの土台 の 6 / 7 本目です。

記事
← 前の記事F12は「壊れたときに開くもの」ではない — 開発者ツール
→ 次の記事スマホ用のページは作らない — レスポンシブ対応

上から順に読めば積み上がるように並べています。 飛ばしても構いませんが、詰まったら前の回に戻ってください。

全体の順路は はじめに にあります。

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

コメント

コメントする

目次