Flutter日志管理插件the_logger的使用

TheLogger 是一个用于Flutter应用的模块化日志库，提供了丰富的功能来管理和记录日志。

特性

• 彩色控制台日志
• 数据库日志记录
• 自定义日志
• 会话管理
• 导出压缩文件中的日志
• 灵活的日志过滤和保留策略
• 隐藏敏感数据的能力
• 控制台日志的自定义颜色方案
• 解析和美化打印日志中的JSON字符串

入门指南

首先，在 pubspec.yaml 文件中添加 the_logger 和 logging 依赖：

dependencies:
  flutter:
    sdk: flutter
  the_logger: ^latest_version
  logging: ^latest_version

然后运行 flutter pub get 来安装这些依赖。

使用方法

初始化 Logger

在您的应用程序中导入包并初始化 TheLogger：

import 'package:the_logger/the_logger.dart';
import 'package:logging/logging.dart';

void main() async {
  await TheLogger.i().init();
  runApp(const MyApp());
}

记录日志

通过创建一个 Logger 实例来记录不同级别的日志：

final _log = Logger('MyHomePage');
_log
  ..finest('some finest log')
  ..info('some info log')
  ..warning('some warning log')
  ..severe('some severe log');

日志保留策略

您可以定义日志保留策略：

await TheLogger.i().init(retainStrategy: {
  Level.ALL: 200,  // 所有记录在200个会话后删除
  Level.INFO: 100,  // INFO级别及以上的记录保留300个会话
  Level.SEVERE: 50,   // SEVERE级别及以上的记录保留350个会话
});

新会话管理

可以通过以下方式手动开始新会话：

TheLogger.i().startSession();

自定义日志输出

可以禁用控制台日志或数据库日志：

await TheLogger.i().init(
  consoleLogger: false,
  dbLogger: false,
);

导出日志到文件

将所有日志写入压缩文件：

final filePath = await TheLogger.i().writeAllLogsToJson();
print('Log file path: $filePath');

示例 Demo

以下是一个完整的示例程序，展示了如何在Flutter应用中使用 TheLogger：

import 'package:flutter/material.dart';
import 'package:logging/logging.dart';
import 'package:the_logger/the_logger.dart';
import 'package:flutter/services.dart';

void main() async {
  await TheLogger.i().init();
  runApp(MyApp());
}

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> with WidgetsBindingObserver {
  late final AppLifecycleListener _listener;

  @override
  void initState() {
    super.initState();
    WidgetsBinding.instance.addObserver(this);
    _listener = AppLifecycleListener(onStateChange: _onStateChanged);
  }

  @override
  void dispose() {
    WidgetsBinding.instance.removeObserver(this);
    _listener.dispose();
    super.dispose();
  }

  void _onStateChanged(AppLifecycleState state) {
    if (state == AppLifecycleState.resumed) {
      TheLogger.i().startSession();
    }
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatelessWidget {
  final _log = Logger('MyHomePage');

  void printLogs() {
    _log
      ..finest('some finest log')
      ..info('some info log')
      ..warning('some warning log')
      ..severe('some severe log');
  }

  void emulateError() {
    try {
      throw Exception('Some error');
    } catch (e, s) {
      _log.severe('Some severe error', e, s);
    }
  }

  void logJson() {
    _log.fine(
      '{"messageKey": "value"}',
      '{"errorKey": "value"}',
    );
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('TheLogger Demo')),
      body: Center(
        child: Column(
          mainAxisSize: MainAxisSize.min,
          children: [
            ElevatedButton(onPressed: printLogs, child: Text('Print Logs')),
            ElevatedButton(onPressed: emulateError, child: Text('Emulate Error')),
            ElevatedButton(onPressed: logJson, child: Text('Log JSON')),
          ],
        ),
      ),
    );
  }
}

以上代码展示了如何集成 TheLogger 到一个简单的Flutter应用中，并提供了一些基本的日志记录功能。您可以根据需要进一步扩展和定制这些功能。