Flutter日志收集插件logging_collector的使用

Flutter日志收集插件logging_collector的使用

logging_collector 是一个简单的 Flutter 包，用于将日志记录到文件并共享日志。以下是详细的使用步骤。

设置日志目录

首先，我们需要设置日志存储的目录：

import 'package:path_provider/path_provider.dart';

final Directory docsDirectory = await getApplicationDocumentsDirectory();

final logsDirectoryPath = '${docsDirectory.path}/logs';
final logsDirectory = Directory(logsDirectoryPath);
logsDirectory.createSync();

创建 RollingFileAppender

接下来，我们创建一个 RollingFileAppender，它会将日志消息写入指定的日志目录：

import 'package:logging_collector/logging_collector.dart';

final appenders = [
  RollingFileAppender(
    directoryPath: logsDirectoryPath,
    fileMaxSize: 1024 * 1024, // 文件最大大小为1MB
    fileMaxCount: 3, // 最多保留3个文件
  ),
];

使用 RollingFileAppender 进行日志记录

然后，我们需要配置日志记录器以使用 RollingFileAppender：

import 'package:logging/logging.dart';

Logger.root.level = Level.ALL; // 设置日志级别

Logger.root.onRecord.listen(
  (LogRecord record) async {
    String log;
    if (record.error != null) {
      log = '${record.level.name}: ${record.time}: ${record.loggerName}: '
          '${record.message}: ${record.error}\n'
          'stackTrace\n${record.stackTrace}\n';
    } else {
      log = '${record.level.name}: ${record.time}: ${record.loggerName}: '
          '${record.message}\n';
    }

    for (final appender in appenders) {
      await appender.append(log);
    }
  },
);

创建 LoggingCollectorConfig 并运行应用

最后，我们需要创建 LoggingCollectorConfig 并在应用中使用它：

import 'package:logging_collector/logging_collector.dart';

final loggingCollectorConfig = LoggingCollectorConfig(
  logsDirectoryPath,
  _CustomSharingDelegate(logsDirectory),
);

runApp(
  Provider<LoggingCollectorConfig>.value(
    value: loggingCollectorConfig,
    child: const MyApp(),
  ),
);

实现自定义的日志共享逻辑

为了实现日志共享功能，我们需要实现 LogsSharingDelegate 接口：

import 'package:archive/archive_io.dart';
import 'package:share_plus/share_plus.dart';

class _CustomSharingDelegate implements LogsSharingDelegate {
  final Directory _logsDirectory;

  _CustomSharingDelegate(this._logsDirectory);

  [@override](/user/override)
  Future<void> share() async {
    final zipEncoder = ZipFileEncoder();
    final zipPath = '../${_logsDirectory.path}/logs.zip';
    zipEncoder.zipDirectory(
      _logsDirectory,
      filename: zipPath,
    );

    Share.shareXFiles(
      [XFile(zipPath)],
      subject: 'Share',
      text: 'Share logs',
    );
  }
}

完整示例代码

以下是一个完整的示例代码，展示了如何使用 logging_collector 插件：

import 'dart:async';
import 'dart:io';
import 'dart:math';

import 'package:archive/archive_io.dart';
import 'package:flutter/cupertino.dart';
import 'package:flutter/material.dart';
import 'package:logging/logging.dart';
import 'package:logging_collector/logging_collector.dart';
import 'package:path_provider/path_provider.dart';
import 'package:provider/provider.dart';
import 'package:share_plus/share_plus.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 设置日志目录
  final Directory docsDirectory = await getApplicationDocumentsDirectory();
  final logsDirectoryPath = '${docsDirectory.path}/logs';
  final logsDirectory = Directory(logsDirectoryPath);
  logsDirectory.createSync();

  // 创建 RollingFileAppender
  final appenders = [
    RollingFileAppender(
      directoryPath: logsDirectoryPath,
      fileMaxSize: 1024 * 1024, // 文件最大大小为1MB
      fileMaxCount: 3, // 最多保留3个文件
    ),
  ];

  // 配置日志记录器
  Logger.root.level = Level.ALL;

  Logger.root.onRecord.listen(
    (LogRecord record) async {
      String log;
      if (record.error != null) {
        log = '${record.level.name}: ${record.time}: ${record.loggerName}: '
            '${record.message}: ${record.error}\n'
            'stackTrace\n${record.stackTrace}\n';
      } else {
        log = '${record.level.name}: ${record.time}: ${record.loggerName}: '
            '${record.message}\n';
      }

      for (final appender in appenders) {
        await appender.append(log);
      }
    },
  );

  // 创建 LoggingCollectorConfig
  final loggingCollectorConfig = LoggingCollectorConfig(
    logsDirectoryPath,
    _CustomSharingDelegate(logsDirectory),
  );

  runApp(
    Provider<LoggingCollectorConfig>.value(
      value: loggingCollectorConfig,
      child: const MyApp(),
    ),
  );
}

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

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  final _logger = Logger('MyApp');

  [@override](/user/override)
  void initState() {
    super.initState();
    Timer.periodic(
      const Duration(seconds: 2),
      (timer) {
        _logger.fine('message id ${Random().nextDouble()}');
      },
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.green),
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

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

  final String title;

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(title),
      ),
      body: const Placeholder(),
      floatingActionButton: FloatingActionButton(
        onPressed: () {
          Navigator.of(context).push(
            CupertinoPageRoute(
                builder: (context) => LoggingCollectorWidget(context.read())),
          );
        },
        child: const Icon(Icons.add),
      ),
    );
  }
}

class _CustomSharingDelegate implements LogsSharingDelegate {
  final Directory _logsDirectory;

  _CustomSharingDelegate(this._logsDirectory);

  [@override](/user/override)
  Future<void> share() async {
    final zipEncoder = ZipFileEncoder();
    final zipPath = '../${_logsDirectory.path}/logs.zip';
    zipEncoder.zipDirectory(
      _logsDirectory,
      filename: zipPath,
    );

    Share.shareXFiles(
      [XFile(zipPath)],
      subject: 'Share',
      text: 'Share logs',
    );
  }
}