Flutter数据记录与管理插件chronicle的使用

Flutter数据记录与管理插件chronicle的使用

定义

动词: 以事实和详细的方式记录一系列事件。

安装

dart pub install chronicle

使用

要记录带有详细信息的消息和对象，您可以创建一个Chronicle类的实例，并传递要记录的日志消息和对象。默认情况下，日志将打印文件、函数和实例化Chronicle时的行号。您可以通过使用NameDepth枚举来自定义详细程度。

import 'package:chronicle/chronicle.dart';

int add(int a, int b) => a + b;

void main() {
  // 记录一个函数，它将在运行时评估值。
  Chronicle(StackTrace.current, "2+3", [add(2, 3)]);

  // 记录一条消息和一个对象，默认名称深度（深）
  Chronicle(StackTrace.current, "这是日志消息", [1, 2, 3]);

  // 使用自定义名称深度（更深）
  Chronicle(
    StackTrace.current,
    "这是另一条日志消息",
    [
      {'key1': 'value1', 'key2': 'value2'}
    ],
    nameDepth: NameDepth.deeper,
  );

  // 使用自定义名称深度（最深）
  Chronicle(
    StackTrace.current,
    "又一条日志消息",
    [
      {"name": "John Doe", "age": 30}
    ],
    nameDepth: NameDepth.deepest,
  );
}

选项

Chronicle 类接受以下选项：

• StackTrace stackTrace: 从 StackTrace.current 方法获得的堆栈跟踪。
• String message: 您想要打印的日志消息。
• List<Object> object: 与消息一起记录的对象列表。
• bool isError: 如果设置为 true，日志将以红色打印，表示错误。（默认：false）
• NameDepth nameDepth: 指定您希望在日志名称中包含的详细程度。它可以是 NameDepth.deep、NameDepth.deeper 或 NameDepth.deepest。（默认：NameDepth.deep）
• String delimiter: 日志名称中使用的分隔符。（默认：':'）

自定义

您可以通过使用 NameDepth 枚举来自定义日志名称的详细程度。选项如下：

• NameDepth.deep: 包括类名（如果可用）、函数名和行号。
• NameDepth.deeper: 包括文件名、类名（如果可用）、函数名、行号和列号。
• NameDepth.deepest: 包括绝对文件路径、类名（如果可用）、函数名、行号和列号。

示例输出

[my_file.dart:_MyClass:myFunction:42] 这是日志消息: 1, 2, 3
[my_file.dart:_MyClass:myFunction:69] 2+3: 5
[my_file.dart:myFunction:45] 这是另一条日志消息: {key1: value1, key2: value2}
[/full/path/to/my_file.dart:_MyClass:myFunction:48] 又一条日志消息: {name: John Doe, age: 30}

示例代码

import 'package:chronicle/chronicle.dart';
import 'package:flutter/material.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,
      ),
      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++);
    Chronicle(StackTrace.current, '_counter', [_counter]);
  }

  [@override](/user/override)
  Widget build(BuildContext context) => 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),
        ), // 这个尾随逗号使自动格式化更美观
      );
}