Flutter文件日志记录插件simple_file_log

Flutter文件日志记录插件`simple_file_log_flutter`的使用

simple_file_log_flutter 是一个用于 Flutter 应用的日志记录工具，支持将日志保存到文件中。通过该插件，开发者可以方便地记录应用运行时的日志信息，并在需要时查看这些日志。

使用步骤

添加依赖 在 pubspec.yaml 文件中添加以下依赖：
```
dependencies:
  simple_file_log_flutter: ^版本号
```
然后执行以下命令以安装依赖：
```
flutter pub get
```
初始化日志记录器 在应用启动时初始化日志记录器，指定日志保留天数等参数。
使用日志记录器 调用日志记录器的各种方法（如 info, fine, severe）来记录不同级别的日志信息。
清理日志 当不再需要日志时，调用 dispose() 方法释放资源。

示例代码

以下是一个完整的示例代码，展示了如何使用 simple_file_log_flutter 插件记录日志并保存到文件中。

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

void main() async {
  // 初始化日志记录器，设置日志保留天数为2天
  WidgetsFlutterBinding.ensureInitialized();
  (await MyLogFlutter.log.init(days: 2)).info('app start...');

  // 启动应用
  runApp(const MyApp());
}

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

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

class _MyAppState extends State<MyApp> with LogUtil {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('插件示例应用'),
        ),
        body: Center(
          child: TextButton(
            onPressed: () async {
              // 记录一条细粒度日志
              logger.fine('测试日志0:${DateTime.now()}');

              // 释放日志记录器资源
              MyLogFlutter.log.dispose();

              // 记录另一条细粒度日志
              logger.fine('测试日志1:${DateTime.now()}');

              // 重新初始化日志记录器
              (await MyLogFlutter.log.init()).info('应用重启日志...');

              // 记录另一条细粒度日志
              logger.fine('测试日志2:${DateTime.now()}');

              // 模拟异常并记录严重错误日志
              try {
                const tt = '';
                tt.substring(5); // 故意引发异常
              } catch (e, s) {
                logger.severe('错误测试', e, s);
              }
            },
            child: const Text('测试日志'),
          ),
        ),
      ),
    );
  }
}

更多关于Flutter文件日志记录插件simple_file_log_flutter的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

sinazl 1楼•14 天前

更多关于Flutter文件日志记录插件simple_file_log_flutter的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

simple_file_log_flutter 是一个用于在 Flutter 应用中记录日志到文件的插件。它可以帮助开发者将应用的日志信息保存到本地文件中，方便后续的调试和分析。以下是使用 simple_file_log_flutter 的基本步骤：

1. 添加依赖

首先，在 pubspec.yaml 文件中添加 simple_file_log_flutter 插件的依赖：

dependencies:
  flutter:
    sdk: flutter
  simple_file_log_flutter: ^1.0.0  # 请使用最新版本

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

2. 初始化日志记录器

在你的 Flutter 应用中初始化日志记录器。通常可以在 main.dart 文件中进行初始化：

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

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化日志记录器
  await SimpleFileLogFlutter.init(
    logFileName: 'app_log.txt',  // 日志文件名
    maxFileSize: 1024 * 1024,    // 最大文件大小（字节），默认为 1MB
    maxLogFiles: 5,              // 最大日志文件数，默认为 5
  );

  runApp(MyApp());
}

3. 记录日志

在应用中使用 SimpleFileLogFlutter 来记录日志。你可以在任何地方调用 log 方法来记录日志：

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Simple File Log Example'),
        ),
        body: Center(
          child: ElevatedButton(
            onPressed: () {
              // 记录日志
              SimpleFileLogFlutter.log('Button pressed at ${DateTime.now()}');
            },
            child: Text('Press Me'),
          ),
        ),
      ),
    );
  }
}

4. 查看日志文件

日志文件默认会保存在应用的文档目录中。你可以通过以下方式获取日志文件的路径：

String logFilePath = await SimpleFileLogFlutter.getLogFilePath();
print('Log file path: $logFilePath');

你可以使用文件管理器或通过代码读取日志文件的内容。

5. 清理日志

如果需要清理日志文件，可以调用 clearLogs 方法：

await SimpleFileLogFlutter.clearLogs();

6. 配置日志级别

你可以通过设置日志级别来控制哪些日志会被记录。例如，只记录 warning 级别及以上的日志：

await SimpleFileLogFlutter.init(
  logFileName: 'app_log.txt',
  logLevel: LogLevel.warning,  // 设置日志级别
);

7. 自定义日志格式

你可以通过重写 SimpleFileLogFlutter 的 formatLog 方法来自定义日志格式：

await SimpleFileLogFlutter.init(
  logFileName: 'app_log.txt',
  formatLog: (level, message, timestamp) {
    return '[$timestamp] [$level] $message';
  },
);

8. 处理日志文件大小和数量

simple_file_log_flutter 支持自动管理日志文件的大小和数量。当日志文件达到最大大小时，会自动创建一个新的日志文件。当日志文件数量超过最大数量时，最旧的日志文件会被删除。

9. 处理异常

你还可以通过设置 onError 回调来处理日志记录过程中可能发生的异常：

await SimpleFileLogFlutter.init(
  logFileName: 'app_log.txt',
  onError: (error) {
    print('Logging error: $error');
  },
);

10. 关闭日志记录器

在应用退出时，可以关闭日志记录器以释放资源：

await SimpleFileLogFlutter.close();