Flutter动态调试与检查插件inspectable的使用

Flutter动态调试与检查插件inspectable的使用

Inspectable 是一个用于检查其子树中所有小部件的组件。

特性

• 检查属于其子树的小部件。
• 为需要检查的小部件着色。

目标

Inspectable 的目标是在不使用 IDE 的情况下，帮助 Flutter 应用程序开发者明确构建当前显示 UI 的具体小部件。

在没有 IDE 的情况下使用它可能非常有用，例如在使用 “release” 模式构建应用或在没有连接到 PC 的真实设备上进行调试时。

使用方法

1. 在 MaterialApp 下放置 Inspectable

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Inspectable(
        child: MyHomePage(),
        colors: {
          Text: Colors.blue,
          Stack: Colors.teal,
          TextButton: Colors.brown,
          Material: Colors.red,
        },
        verbose: true,
      ),
    );
  }
}

可选地，你可以通过 colors 属性为需要检查的小部件着色。

verbose 是一个标志，用于切换是否显示以 _ 开头的私有小部件。

2. 调用 Inspectable.of(context).inspect() 显示小部件树

TextButton(
  onPressed: () {
    Inspectable.of(context).inspect();
  },
  child: Text(
    'INSPECT',
  ),
)

3. 如果只想检查特定小部件下的子树，可以在此处放置另一个 Inspectable

Inspectable(
  child: AnyWidgetForInspect()
)

注意，在这种情况下，你必须使用 AnyWidgetForInspect 下的 context，因为该上下文会查找最近的祖先 Inspectable。

4. 如果想检查 State 的状态（如 StatefulWidget），需要重写 debugFillProperties() 方法。以下示例尝试显示其私有字段 _someIntState 和 _someBoolState。

[@override](/user/override)
void debugFillProperties(DiagnosticPropertiesBuilder properties) {
  super.debugFillProperties(properties);
  properties.add(IntProperty('someIntState', _someIntState, defaultValue: null));
  properties.add(FlagProperty(
    'someBoolState',
    value: _someBoolState,
    defaultValue: null,
    ifTrue: 'flag is true',
    ifFalse: 'flag is false',
  ));
}

如 debugFillProperties 在 Flutter 框架中经常使用，你可以参考 Text 等小部件的代码来了解更多的用法细节。

完整示例代码

以下是完整的示例代码：

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';

import 'package:inspectable/inspectable.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Inspectable Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: Inspectable(
        child: MyHomePage(),
        colors: {
          Text: Colors.blue,
          Stack: Colors.teal,
          TextButton: Colors.brown,
          Material: Colors.red,
        },
      ),
    );
  }
}

class MyHomePage extends StatefulWidget {
  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Inspectable Sample'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
            const SizedBox(height: 60),
            InspectButton(
              key: ValueKey('InspectTestKey'),
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ),
    );
  }

  [@override](/user/override)
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties.add(IntProperty('count', _counter, defaultValue: null));
  }
}

class InspectButton extends StatefulWidget {
  const InspectButton({
    Key? key,
  }) : super(key: key);

  [@override](/user/override)
  _InspectButtonState createState() => _InspectButtonState();
}

class _InspectButtonState extends State<InspectButton> {
  var _someBoolState = false;
  var _someIntState = 10;

  [@override](/user/override)
  Widget build(BuildContext context) {
    return TextButton(
      onPressed: () {
        Inspectable.of(context).inspect();
      },
      child: Text(
        'INSPECT',
        style: TextStyle(fontSize: 24),
      ),
    );
  }

  [@override](/user/override)
  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
    super.debugFillProperties(properties);
    properties
        .add(IntProperty('someIntState', _someIntState, defaultValue: null));
    properties.add(FlagProperty(
      'someBoolState',
      value: _someBoolState,
      defaultValue: null,
      ifTrue: 'flag is true',
      ifFalse: 'flag is false',
    ));
  }
}