Android Studio のデバッガを使用する

1. 始める前に

この Codelab では、Android Studio のデバッガを使用して、Dice Roller アプリを実行したときの動作を調べる方法について説明します。

デバッガは、Android アプリを動かすコードの実行を検査し、バグを修正できるようにするために不可欠なツールです。コードの実行を一時停止するポイントを指定し、変数、メソッド、その他のコードの側面を手動で操作できます。

前提条件

学習内容

  • Android アプリにデバッガをアタッチする方法
  • デバッガをアタッチしたアプリを起動する方法
  • デバッガの基本的な機能を使用する方法
  • デバッガの一般的な用途

必要なもの

  • Android Studio がインストールされているパソコン
  • Compose での Dice Roller アプリの解答コード

2. Code-Along 動画を見る（省略可）

コースの講師が Codelab を完了する様子を視聴する場合は、以下の動画を再生してください。

動画を拡大して全画面表示にすることをおすすめします（動画の右下隅のアイコン 正方形の 4 つの角が強調表示されたこの記号は、全画面モードを表します。 を使用します）。そうすれば、Android Studio とコードがもっとはっきり見えるようになります。

このステップは省略可能です。動画をスキップして、すぐに Codelab の学習を開始することもできます。

3. スターター コードを取得する

まず、コードをダウンロードします。

または、コードの GitHub リポジトリのクローンを作成することもできます。

$ git clone https://github.com/google-developer-training/basic-android-kotlin-compose-training-dice-roller.git
$ cd basic-android-kotlin-compose-training-dice-roller

コードは GitHub リポジトリで確認できます。

4. デバッガを実行する

アプリとともにデバッガを実行する方法は 2 つあります。

  • デバイスまたはエミュレータで実行されている既存のアプリプロセスにデバッガをアタッチする
  • デバッガでアプリを実行する

どちらの方法でも、ある程度は同じことを実現できます。両方の方法を理解したら、好みの方法か、必要な方法を選んでください。

アプリプロセスにデバッガをアタッチする

アプリがすでに実行されている場合は、デバッガをアタッチできます。

アプリプロセスにデバッガをアタッチする手順は次のとおりです。

  1. 5e037ad7aaa36799.png（Run ‘app'）をクリックします。

アプリ実行ボタンをクリックしてアプリを実行します

  1. デバイスまたはエミュレータでアプリを実行したら、b53445df2e1bec63.png（Attach Debugger to Android Process）をクリックします。

実行中のアプリにデバッガをアタッチします

デバッガをアタッチするプロセスを選択できる [Choose Process] ダイアログが開きます。

  1. [com.example.diceroller] を選択し、[OK] をクリックします。

デバッガをアタッチするプロセスを選択します

[Debug] ペインが Android Studio の下部に表示され、ターゲット デバイスまたはエミュレータにデバッガがアタッチされたことを示すメッセージが表示されます。

デバッガは実行中のプロセスに接続されます

アプリにデバッガをアタッチしました。その意味やデバッガでできることついては、この Codelab で後ほど説明します。次に、デバッガをアタッチしたアプリを起動する方法を学びます。

デバッガでアプリを実行する

デバッガを使用することが最初からわかっている場合は、デバッガでアプリを実行すると時間を節約できます。さらに、アプリの起動時にのみ実行されるコードをデバッグする場合は、デバッガをアタッチした状態でアプリを起動する必要があります。

デバッガでアプリを実行する手順は次のとおりです。

  1. [Debug] ペインで 930a4556994d2c41.png（Stop ‘Android Debugger'）をクリックし、デバイスまたはエミュレータ上のアプリを閉じます。

Android デバッガを停止します

  1. a4737e06791f5bbf.png（Debug ‘app'）をクリックします。

デバッガをアタッチした状態でアプリを実行します

同じ [Debug] ペインが Android Studio の下部に表示され、コンソールの出力が表示されます。

Debug ペイン

デバッガの起動方法について理解したところで、次はその使用方法について説明します。

5. デバッガを使用する

Debug ペイン

[Debug] ペインの上部に多数のボタンがありますが、こうしたボタンは今のところあまり意味をなさず、ほとんどがグレー表示され、クリックできません。このセクションでは、デバッガでよく使用する機能について説明します。この Codelab では、その他のボタンについても必要に応じて説明します。

デバッガを初めて起動すると、[Debug] ペインに複数のボタンが表示されます。[Debug] ペインの上部には、[Debugger] ボタンと [Console] ボタンが表示されます。

デバッガのコントロールとコンソール

[Console] ボタンをクリックするとアプリの logcat 出力が表示されます。コード内にログ ステートメントがある場合は、そのコード部分が実行されると出力が表示されます。

[Debugger] ボタンをクリックすると別々のペインが 3 つ表示されますが、デバッガを使用していないため今のところ空白です。

  1. Frames
  2. Variables
  3. Overhead

Debugger ペインは 3 つのセクションで構成されています

デバッガの一般的な機能を使用する

ブレークポイントを設定する

デバッガの主な機能として、特定のコード行の実行をブレークポイントで停止できることが挙げられます。

Android Studio でブレークポイントを設定するには、特定のコード行に移動してから、行番号の横のガターをクリックする必要があります。ブレークポイントの設定を解除するには、ガターの既存のブレークポイントをクリックして消去する必要があります。

  • これを試す場合は、imageResource 変数が設定されているところにブレークポイントを設定します。

ブレークポイントを追加、削除します

Resume Program ボタンを使用する

前のセクションでは、imageResource 変数が設定されているところにブレークポイントを設定しました。このブレークポイントにより、命令の実行が一時停止されます。デバッガでコードの実行が一時停止されたとき、実行を続行してアプリの実行を継続する必要が生じることはよくあります。最も直接的な方法は、Resume Program ボタンを使用することです。

プログラムを再開する手順は次のとおりです。

  1. a4737e06791f5bbf.png（Debug ‘app'）をクリックします。アプリを起動すると、次の画像のように表示されます。

fa27673a8e804aaf.png

プログラムを再開する前に、デバッガが実行を一時停止したときに画面に表示される内容について説明します。

  • [Debug] ペインのボタンの多くがクリックできるようになります。
  • [Frames] ペインには、ブレークポイントが設定されている行への参照がハイライト表示されるなど、多くの情報が表示されます。
  • [Variables] ペインには、項目の数が表示されますが、このアプリには変数があまりないため、現時点でこの Codelab の範囲内に関連のある情報はあまりありません。ただし、変数を検査する機能は、実行時にコード内で起きることについての情報が得られるため、デバッガに不可欠な機能です。この Codelab では、変数を検査する方法について後ほど詳しく説明します。

デバイスまたはエミュレータでアプリを見ると、あるコード行でアプリが一時停止しているため、画面は空白になっています。具体的には、実行がブレークポイントで停止し、UI がまだレンダリングされていません。

ブレークポイントが設定されているからといって、アプリがすぐに停止するとは限らないことに注意してください。コード内のどこにブレークポイントを設定したかによって異なります。この例では、アプリの起動時に実行される行にブレークポイントを設定しました。

ブレークポイントが設定された行を実行しようとしたときにのみアプリがブレークポイントで一時停止する、という点が重要です。デバッガを進める方法は複数ありますが、今回は Resume Program ボタンを使用します。

  1. f4e16fbb7cdb8b2f.png（Resume Program）をクリックします。

Resume ボタン

次の画像のように表示されます。

アプリ実行中の Debugger ペイン

情報の大部分が消え、再度、ボタンがクリックできなくなります。また、デバイスまたはエミュレータでは、アプリは通常どおりに表示されます。これは、ブレークポイントでコードが一時停止されず、アプリが通常の実行状態になっているためです。デバッガはアタッチされていますが、ブレークポイントが設定されたコード行を実行しようとするまでは、特に何も起きません。このブレークポイントは以降の例で役立つため、そのままにしておきます。

Step Into ボタンを使用する

デバッガの Step Into ボタンを使用すると、実行時のコードを簡単かつ詳細に確認できます。命令がメソッドや他のコードを呼び出している場合、Step Into ボタンを使用すると、デバッガを起動してブレークポイントを設定する前に、手動で移動することなくコードに入ることができます。

Step Into ボタンを使用する手順は次のとおりです。

  1. DiceRollerApp() 関数が呼び出される MainActivity クラスの onCreate() 関数内で、setContent ラムダ本体にブレークポイントを作成します。

44 行目にブレークポイントを追加

  1. a4737e06791f5bbf.png（Debug ‘app'）をクリックし、デバッガでアプリを再実行します。実行は、DiceRollerApp() 関数が呼び出される行で一時停止します。
  2. Step Into（Step Into）をクリックします。

Step Into ボタン

52 行目がハイライト表示され、[Debug] ペインの [Frames] ペインに、52 行目でコードが一時停止されていることが示されました。

52 行目でアプリが一時停止します

[Frames] ペインを開くと、ハイライト表示された行の次の行の先頭に invoke: が付けられ、その後に行番号が続いていることがわかります（前の画像では 44 行目）。これを「コールスタック」といいます。基本的には、コードの実行を現在の行に導く呼び出しのチェーンが表示されます。この場合は 44 行目に、DiceRollerApp() 関数を呼び出す命令があります。

その関数呼び出しに設定されたブレークポイントでデバッガが停止したとき、Step Into ボタンをクリックすると、デバッガはその関数にステップインし、実行は関数が宣言されている 52 行目に導かれます。ハイライト表示された行は、実行が一時停止された場所を示しています。ハイライト表示された行の次の行に行番号が関連付けられている場合は、実行のパスを示しています。この場合、デバッガは 44 行目の命令によって 52 行目に達したことを示しています。

  1. edb3c56acaffc23e.png（Resume Program）をクリックします。

これで、設定した元のブレークポイントに達します。最初の例で実行を停止したときに見た内容について、理解が深まったかと思います。次の画像は、Resume Program セクションの 6 つ目のステップと同じ画像です。

Resume Program ボタンをクリックして続行します

コールスタックでは、DiceWithButtonAndImage() 関数が 63 行目で一時停止していることがわかります。この関数は、44 行目で呼び出された DiceRollerApp() 関数の 53 行目から呼び出されています。コールスタック機能を使用すると、実行パスを把握できます。アプリ内のさまざまな場所から関数を呼び出すときに非常に便利です。

Step Into ボタンを使用すると、関数自体にブレークポイントを設定しなくても、関数に入って実行を一時停止できます。この場合、DiceRollerApp() 関数の呼び出しにブレークポイントを設定します。Step Into ボタンをクリックすると、DiceRollerApp() 関数で実行が一時停止します。

Dice Roller は、ファイル、クラス、関数が少ないため、かなり小規模なアプリです。規模の大きいアプリを扱う場合、デバッガの Step Into 機能は、コードを移動することなくコードにドリルダウンするため有用です。

Step Over ボタンを使用する

Step Over ボタンを使用すると、実行時にアプリコードをステップ実行できます。実行を次のコード行に移して、デバッガを進めます。

Step Over ボタンを使用する手順は次のとおりです。

  • 311eb654b5f218fd.png（Step Over）をクリックします。

Debug ペインの Step Over ボタン

デバッガが、次に実行する行（53 行目）でコードを一時停止していることがわかります。各行を連続してステップ実行できます。

53 行目でコードが一時停止します

Step Out ボタンを使用する

Step Out ボタンは Step Into ボタンとは逆の動作をします。Step Out ボタンは、コールスタックにドリルダウンするのではなく、コールスタックに移動します。

Step Out ボタンを使用する手順は次のとおりです。

  1. 496d9a62300a4d97.png（Step Out）をクリックします。

プログラムはどの行で一時停止するでしょうか。

Debug ペインの Step Out ボタン

  1. デバッガは DiceRollerApp() 関数からステップアウトして、45 行目の関数実行の次の行に移動しました。ステップアウトは 44 行目に戻りません。この行はすでに実行されています。そのため、ステップアウトすると 45 行目に移動します。

ステップアウトして 45 行目に進みます

Step Out ボタンは、メソッド コールスタックに深く入りすぎた場合に有用なツールです。ステップインしたメソッドごとにコードをすべてステップ実行することなく、コールスタックを上がることができます。

変数を検査する

この Codelab で前に [Variables] ペインについて簡単に説明しました。このペインでは、ペインに表示された変数を検査してアプリの問題をデバッグする方法について詳しく知ることができます。

変数を検査する手順は次のとおりです。

  1. DiceRollerApp() 関数が呼び出されているところのブレークポイントをクリックして削除し、imageResource 変数が設定されているところのブレークポイントは残します。
  2. a4737e06791f5bbf.png（Debug ‘app'）をクリックします。result$delegate 変数が、値が 1 の MutableState になっています。これは、変数が定義されると、mutableStateOf 1 でインスタンス化されるためです。MutableState は、変更可能な状態を result 変数に代入できることを意味します。

ee70fcf0cc18f4d7.png

  1. edb3c56acaffc23e.png（Resume Program）をクリックします。
  2. アプリで [Roll] をクリックします。コードはブレークポイントで再度一時停止します。result$delegate 変数には異なる値が表示される可能性があります。

この画像では、result$delegate 変数の可変状態に値 6 が格納されています。これは、デバッガで実行時に変数をどのように検査できるかを示しています。多機能なアプリでは、変数の値がクラッシュの原因となることがあります。デバッガを使用して変数を検査すると、クラッシュの詳細を把握でき、バグを修正できます。

d77800dd66311294.png

6. まとめ

今回は、Android Studio のデバッガを使用しました。

まとめ

  • アプリにデバッガをアタッチする
  • デバッガをアタッチしたアプリを起動する
  • Debugger ペインについて理解する
  • ブレークポイントを設定する
  • デバッガからプログラムを再開する
  • Step Into ボタンを使用する
  • Step Over ボタンを使用する
  • Step Out ボタンを使用する
  • デバッガで変数を検査する