デバッグパネル

デバッグパネルは、アプリを作る人のための、実行中のアプリの上のパネルです。各タブがアプリケーションの一つの側面を表示します。ログ、フレームメーター、すべての値のソースを示す設定、Bean、テーマ、起動のステージです。アクション debug.open で開きます。⌘⇧D (他のプラットフォームでは Ctrl+Shift+D)、またはスマートフォンも含むすべてのプラットフォームで、素早い 4 回のタップと 3 秒間押し続ける 5 回目のタップです。

使う理由

スマートフォンやブラウザーではコンソールが手元になく、問いはしばしば「このビルドはどの値を得たか?」や「どのプロファイルがアクティブか?」です。パネルは、実行中のコンテキストから、デバイスそのものの上で答えます。そしてユーザーが実行するものには何のコストもかかりません。デフォルトでは、ビルドはリリースビルドからそのコードを除外します。

例

デバッグビルドでは何も書く必要はありません。パネルはそこにあり、⌘⇧D で開きます。開き方を変えたり、すべてのビルドに含めたりするには:

# lib/resources/application.yml
spring:
  flutter:
    debug:
      enabled: true          # true: すべてのビルド、false: なし、未設定: デバッグとプロファイルのビルド
    shortcuts:
      debug.open: [primary+shift+d, taps:5+hold:2s]

モジュール

パネルとそのツールはビルドの別々のモジュールで、それぞれが独自のプロパティを持つため、リリースビルドにはどれか一つだけを含めることができます。

モジュール プロパティ Bean アクションとキー
パネル (springBootStarterFlutterDebugAutoConfiguration) spring.flutter.debug.enabled debugPanel debug.open: ⌘⇧D (Ctrl+Shift+D)、または taps:4+hold:3s
フレームメーター (springBootStarterFlutterDebugFrameMeterAutoConfiguration) spring.flutter.debug.frame-meter.enabled debugFrameMeter debug.frame-meter: ⌘⇧X (Ctrl+Shift+X)、または taps:5+hold:2s (素早い 5 回のタップと 2 秒間押し続ける 6 回目のタップ)
モーションのスイッチ (springBootStarterFlutterDebugMotionAutoConfiguration) spring.flutter.debug.motion.enabled debugMotion debug.motion: ⌘⇧M (Ctrl+Shift+M)
タイムライン (springBootStarterFlutterDebugTimelineAutoConfiguration) spring.flutter.debug.timeline.enabled debugTimeline debug.timeline: ⌘⇧L (Ctrl+Shift+L)、または taps:6+hold:2s
オーバーレイ のドラッグ (springBootStarterFlutterDebugDragAutoConfiguration) spring.flutter.debug.drag.enabled (未設定: なし) debugOverlayDrag なし: オーバーレイをドラッグする

ツールのキーは、パネルと同じように設定します。spring.flutter.shortcuts.debug.frame-meter、spring.flutter.shortcuts.debug.motion、spring.flutter.shortcuts.debug.timeline です。

フレームメーターとタイムラインは、アプリの上に小さなウィジェットを表示します。一つの隅のものは デバッグオーバーレイのドック がまとめます。パネルが開いている間はそれらは隠れます。そのタブが同じものを表示するためです。

例えば、パネルなしで、フレームメーターだけを含むリリースビルド:

spring:
  flutter:
    debug:
      enabled: false
      frame-meter:
        enabled: true
      motion:
        enabled: false
    frame-meter:
      position: bottom-right

フレームメーターは spring.flutter.frame-meter.position の隅で始まり、アクション debug.frame-meter がそれを表示したり隠したりします。

モジュールがアプリに含まれる時

これらのプロパティ (spring.flutter.debug.enabled、spring.flutter.debug.frame-meter.enabled、spring.flutter.debug.motion.enabled、spring.flutter.debug.timeline.enabled、spring.flutter.debug.drag.enabled) は、どれもジェネレーターが main.spring.dart を書き出すときに読むため、アプリがどのコードを含むかを決めます。

値 モジュール
未設定 (デフォルト) デバッグビルドとプロファイルビルドだけ。モジュールはリリースモードの条件の背後に書き出されるため、リリースビルドではコンパイル時に取り除かれる
true リリースを含むすべてのビルド
false どのビルドにもない。モジュールは書き出されず、アプリはそのコードを一切持たない

プロファイルのファイルでどれかを false に設定すると、ビルドがその機能を持つ実行中のアプリの、その機能も無効になります。モジュールのビルド条件の仕組みについては、ビルドから除外されるモジュール を参照してください。

タブ

タブ 表示するもの
Logs ロギングシステムのバッファー (logBuffer) のレコード。新しいものが先で、ライブで、レベルとテキストで絞り込める
Frames アプリの上の フレームメーター のオンとオフ、その隅の位置。新しいビルドなしで。debugFrameMeter Bean を使い、ビルドがフレームメーターを除外した場合、タブはこのビルドにないと表示する
Motion アプリのすべてのアニメーションのオン、または端末の「視差効果を減らす」と同じオフ (motion.enabled はビルドに対して設定する)。debugMotion Bean を使い、ビルドがモーションのスイッチを除外した場合、タブはこのビルドにないと表示する
Configuration アクティブなプロファイルと、すべてのプロパティとそれを設定するソース。シークレットを示すキー (password、secret、token、key、credential) の値は、Spring Boot の actuator と同じく ****** と表示される
Beans コンテキストのすべての Bean とその型
Theme アプリ自身のファイルが宣言または選択するテーマ (SpringThemes.ownNames。source ファイルが持ち込む基底テーマは除く) と system。タップで一つを表示する
Start 各 起動のステージ に到達した時刻

独自のタブ

タブは DebugPanelSection Bean で、Bean の順序 (@Order、Ordered) に並びます。

// チェックアウトをテストする人のための、バスケットの中身。
@Component()
@Order(100)
class BasketSection implements DebugPanelSection {
  BasketSection(this.basket);

  final Basket basket;

  @override
  String get title => 'Basket';

  @override
  Widget build(BuildContext context) => Text('${basket.count} books');
}

DebugStyle.of(context)、DebugChip、DebugFilter は、タブにパネルの見た目を与えます。独自のタブはあなたのコードの中にあるため、例えば @Profile(['debug', 'profile']) で、自分でリリースビルドから除外してください。

パネルの状態

debugPanel (DebugPanel、ChangeNotifier) がパネルの状態です。

メンバー 意味
isOpen パネルが表示されているかどうか
toggle() パネルを開く、または閉じる
close() 閉じる

これは debug.open の KeyedShortcutHandler でもあり、デフォルトのキーは primary+shift+d と taps:4+hold:3s です。パネルは FlutterAppCustomizer (debugPanelCustomizer) によってアプリの上に組み込まれます。

他の二つのモジュールは、それぞれ状態の Bean を持ちます。

Bean メンバー 意味
debugFrameMeter (DebugFrameMeter) on フレームメーターをアプリの上に表示するかどうか (Frames タブと debug.frame-meter が設定する)
position フレームメーターの隅の位置
debugMotion (DebugMotion) animations アプリのアニメーションが動くかどうか (Motion タブと debug.motion が設定する)

それぞれが自分のアクションの KeyedShortcutHandler です。

プロパティ

キー 型 デフォルト 意味
spring.flutter.debug.enabled true、false 未設定 ジェネレーターが読む。true: パネルはすべてのビルドに含まれる。false: どれにも含まれない (コードなし)。未設定: デバッグとプロファイルのビルドだけ
spring.flutter.debug.frame-meter.enabled true、false 未設定 ジェネレーターが読む。フレームメーターのモジュールについて同じ
spring.flutter.debug.motion.enabled true、false 未設定 ジェネレーターが読む。モーションのスイッチのモジュールについて同じ
spring.flutter.shortcuts.debug.open キーまたはタップ [primary+shift+d, taps:4+hold:3s] パネルを開くもの (キーボードショートカットとタップ を参照)
spring.flutter.shortcuts.debug.frame-meter キーまたはタップ [primary+shift+x, taps:5+hold:2s] フレームメーターを表示または非表示にするもの
spring.flutter.shortcuts.debug.motion キーまたはタップ primary+shift+m アニメーションをオンまたはオフにするもの
spring.flutter.frame-meter.position 隅 top-right フレームメーターが始まる隅

Spring (Java) との対応

Spring Boot の actuator は、サーバーについて同じ事実 (/actuator/env、/actuator/beans、/actuator/loggers) を HTTP で表示します。パネルはそれらを、デバイスの上の、アプリそのものの中で表示します。

関連項目