Flutter屏幕调试插件onscreen_ui_debugger的使用

特性

Onscreen Ui Debugger可以在几行简单的代码中创建屏幕上的日志。

开始使用

在 pubspec.yaml 文件中添加该包，并检查以下代码。

使用方法

将以下代码添加到您的 MaterialApp 中。

builder: (context, child) {
    return Stack(
        children: [
            child ?? Container(),
            Overlay(
                initialEntries: [
                    OverlayEntry(
                        builder: (context) => const DebugWidget(),
                    ),
                ],
            ),
        ],
    );
},

在添加上述代码后，您的 MaterialApp 应该如下所示：

MaterialApp(
    title: 'Flutter Demo',
    theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
    ),
    //----------更改开始于此----------
    builder: (context, child) {
        return Stack(
            children: [
                child ?? Container(),
                Overlay(
                    initialEntries: [
                        OverlayEntry(
                            builder: (context) => const DebugWidget(),
                        ),
                    ],
                ),
            ],
        );
    },
    //----------更改结束于此----------
    home: const MyHomePage(title: 'Flutter Demo Home Page'),
)

日志格式

以下是记录日志的格式：

DebugLog debugLog = DebugLog(logTitle: "登录 REST API", dateTime: DateTime.now());
debugLog.logStrings.add(DebugLogString(logTitle: "登录请求", logsDescription: "{mobile:'9496699210'}"));
debugLog.logStrings.add(DebugLogString(logTitle: "响应", logsDescription: '{message:'success'}'));
debugLog.setAsBlue(); // 设置标题颜色为蓝色
DebugUtils.debugLogBloc.addDebugLog(debugLog);

额外信息

如有更多问题，请发送邮件至 nikhilishwar2@gmail.com。我们欢迎更多的贡献者加入此项目。

完整示例代码

import 'package:flutter/material.dart';
import 'package:onscreen_ui_debugger/debug_helper/debug_log_bloc.dart';
import 'package:onscreen_ui_debugger/debug_helper/debug_utilities.dart';
import 'package:onscreen_ui_debugger/debug_helper/debug_widget.dart';

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  // 这个小部件是你的应用的根。
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      builder: (context, child) {
        return Stack(
          children: [
            child ?? Container(),
            Overlay(
              initialEntries: [
                OverlayEntry(
                  builder: (context) => const DebugWidget(),
                ),
              ],
            ),
          ],
        );
      },
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});
  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

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

  void _incrementCounter() {
    setState(() {
      DebugLog debugLog =
          DebugLog(logTitle: "计数器日志", dateTime: DateTime.now());
      debugLog.logStrings.add(DebugLogString(
          logTitle: "递增前", logsDescription: _counter.toString()));
      _counter++;
      debugLog.logStrings.add(DebugLogString(
          logTitle: "递增后", logsDescription: _counter.toString()));
      (_counter % 2 == 0) ? debugLog.setAsSad() : debugLog.setAsBlue();
      DebugUtils.debugLogBloc.addDebugLog(debugLog);
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              '你已经点击了按钮这么多次：',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: '增加',
        child: const Icon(Icons.add),
      ), // 这个逗号使自动格式化更美观。
    );
  }
}