Flutter デバッグと DevTools
このセクションでは、Flutter のデバッグツールとよく使うデバッグテクニックを紹介します。
Flutter DevTools 概要
Flutter DevTools は、Flutter アプリのデバッグと分析のためのツールセットです。
DevTools を起動する
$ flutter run
アプリを実行すると、ターミナルに DevTools の URL が表示されます。通常はhttp://127.0.0.1:9100
よく使うコマンド
| コマンド | 説明 |
|---|---|
| flutter doctor | 開発環境の構成を確認する |
| flutter analyze | 静的コード解析 |
| flutter test | テストを実行する |
print と debugPrint
例:基本的なデバッグ出力
// 基本的な出力
print('Hello Debug'); // コンソールに出力
// debugPrint は長いテキストの切り詰めを防ぐ
debugPrint('これはとても長いテキストで、切り詰められずに完全に出力できます');
// 条件付き出力
if (debugMode) {
print('デバッグ情報');
}
// オブジェクトを出力(toString が必要)
final user = {'name': '張三', 'age': 25};
print('ユーザー情報: $user'); // 出力: ユーザー情報: {name: 張三, age: 25}
print('Hello Debug'); // コンソールに出力
// debugPrint は長いテキストの切り詰めを防ぐ
debugPrint('これはとても長いテキストで、切り詰められずに完全に出力できます');
// 条件付き出力
if (debugMode) {
print('デバッグ情報');
}
// オブジェクトを出力(toString が必要)
final user = {'name': '張三', 'age': 25};
print('ユーザー情報: $user'); // 出力: ユーザー情報: {name: 張三, age: 25}
アサーション - assert
アサーションは開発中に条件をチェックするために使用され、デバッグモードでのみ有効です。
< h2 class="example">例:アサーションの使用
// 簡単なアサーション
assert(user != null, 'ユーザーは空にできません');
// 関数パラメータの検証
void setAge(int age) {
// 年齢は 0 より大きくなければならない
assert(age > 0, '年齢は 0 より大きくなければなりません');
this.age = age;
}
// UI 構築中のアサーション(開発時のみ)
Widget build(BuildContext context) {
// context が null でないことを確認
assert(context != null);
// 親の Scaffold があることを確認
assert(debugCheckHasMaterial(context));
return Scaffold(...);
}
assert(user != null, 'ユーザーは空にできません');
// 関数パラメータの検証
void setAge(int age) {
// 年齢は 0 より大きくなければならない
assert(age > 0, '年齢は 0 より大きくなければなりません');
this.age = age;
}
// UI 構築中のアサーション(開発時のみ)
Widget build(BuildContext context) {
// context が null でないことを確認
assert(context != null);
// 親の Scaffold があることを確認
assert(debugCheckHasMaterial(context));
return Scaffold(...);
}
ブレークポイントデバッグ
VS Code または Android Studio でブレークポイントを設定してデバッグします。
VS Code デバッグ
- コードの行番号の左側をクリックしてブレークポイントを設定します
- F5 キーまたはデバッグボタンをクリックしてデバッグを開始します
- デバッグツールバーを使用してプログラムの実行を制御します
よく使うブレークポイントコマンド
| 操作 | 説明 |
|---|---|
| Continue / F5 | 次のブレークポイントまで続行する |
| Step Over / F10 | ステップオーバー(関数に入らない) |
| Step Into / F11 | ステップイン(関数に入る) |
| Step Out / Shift+F11 | ステップアウト(現在の関数を終了) |
Flutter Inspector
Flutter Inspector は DevTools の一部であり、Widget ツリーを可視化して検査するために使用されます。
主な機能
- Widget Tree: Widget の階層構造を表示
- Layout Explorer: レイアウト制約を確認
- Performance Overlay: パフォーマンス指標を表示
よくある問題のデバッグ
例:UI が更新されない場合のデバッグ
// 問題:UI が更新されない
// 原因:状態を変更した後に setState を呼び出していない
// エラー例
void _increment() {
_counter++; // 状態は変わったが、UI は更新されません!
}
// 正しい例
void _increment() {
setState(() {
_counter++; // 必ず setState を呼び出す
});
}
// 問題:状態管理が混乱している
// 提案:Provider または他の状態管理ソリューションを使用する
// 原因:状態を変更した後に setState を呼び出していない
// エラー例
void _increment() {
_counter++; // 状態は変わったが、UI は更新されません!
}
// 正しい例
void _increment() {
setState(() {
_counter++; // 必ず setState を呼び出す
});
}
// 問題:状態管理が混乱している
// 提案:Provider または他の状態管理ソリューションを使用する
その他の拡張機能デバッグ時に使うツール:print でログ出力、Inspector で Widget ツリーを検査、Timeline でパフォーマンスを分析。