Flutter日志追踪插件trace_logger的使用

Flutter日志追踪插件trace_logger的使用

trace_logger 是一个简单的 Flutter 日志记录包，它能够记录带有类名的消息，并通过颜色编码输出来简化调试过程。使用它可以在日志中自动捕获调用类的上下文，并且通过不同级别的表情符号（侦探、信息、警告、错误）来区分日志级别。

资源 📚

• 文档
• Pub 包
• GitHub 仓库

安装 💻

1. 在 pubspec.yaml 文件中添加 trace_logger 依赖：

   dependencies:
     trace_logger: ^1.0.2
   

2. 运行以下命令安装包：

   flutter packages get
   

使用

要使用 TraceLogger，首先需要导入包并创建一个 TraceLogger 实例：

import 'package:trace_logger/trace_logger.dart';

final logger = TraceLogger();

带有类追踪的日志记录

TraceLogger 可以自动捕获调用类的名称。下面是一个例子：

class HomeScreen {
  void someMethod() {
    logger.d('Debugging information');
    logger.i('Informational message');
    logger.w('Warning message');
    logger.e('Error message');
  }
}

输出结果如下：

🕵️ [HomeScreen] Debugging information
ℹ️ [HomeScreen] Informational message
⚠️ [HomeScreen] Warning message
❌ [HomeScreen] Error message

日志级别和表情符号

每个日志级别都对应一个表情符号和一种颜色，以便快速识别。

API 参考

• logger.d(message) - 记录调试消息。
• logger.i(message) - 记录信息性消息。
• logger.w(message) - 记录警告消息。
• logger.e(message) - 记录错误消息。

示例代码

以下是完整的示例代码：

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

var logger = TraceLogger();

void main() {
  logger.d('message');
  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,
      ),
      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(() {
      _counter++;
    });
  }

  [@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: [
            const NewWidget(),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    logger.d('build');
    return const Text(
      'You have pushed the button this many times:',
    );
  }
}