Flutter日志管理插件nd_logs的使用

nd_logs 是一个为 Flutter/Dart 应用程序构建的日志解决方案，完全用 Dart 编写。

注意：目前该插件仅在 Android 和 iOS 平台上进行了测试。基本的 Web 支持也已添加。但是，由于 Web 应用无法像原生应用一样访问文件系统，因此 Web 平台的日志记录是会话级别的，并且只有在调用导出方法时才会保存到下载目录。

开始使用

首先，确保在应用程序启动时初始化 WidgetsFlutterBinding 并调用 NDLogs.setupLogger() 方法：

WidgetsFlutterBinding.ensureInitialized();
await NDLogs.setupLogger();

接下来，可以通过简单的调用向日志中添加记录：

NDLogs.logThis("My first log!");

要导出日志文件，可以使用以下代码：

final logFilePath = await NDLogs.exportLogFile();

如果需要清除日志，可以调用以下方法：

await NDLogs.clearLogs();

完整示例代码

以下是完整的示例代码，展示了如何使用 nd_logs 插件记录日志并导出日志文件。

import 'dart:async';
import 'dart:developer';
import 'dart:io';

import 'package:flutter/material.dart';
import 'package:nd_logs/base/log_types.dart';
import 'package:nd_logs/nd_logs.dart';

void main() async {
  // 初始化 Flutter 绑定并设置日志记录器
  WidgetsFlutterBinding.ensureInitialized();
  await NDLogs.setupLogger(recordHTML: true);

  // 使用 runZonedGuarded 捕获未处理异常并记录错误
  runZonedGuarded(
    () => runApp(const MyApp()),
    (error, stack) async {
      await NDLogs.logErrorWithStacktrace(
        error,
        stack,
        paramsTracking: {
          "name": "Andi",
          "counter": "Unable to comply",
        },
      );
    },
  );
}

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++;
      // 记录日志并附加参数
      NDLogs.logThis(
        "Counter value = $_counter",
        paramsTracking: {
          "name": "Andi",
          "counter": _counter.toString(),
        },
      );
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
        actions: [
          // 导出日志按钮
          IconButton(
            icon: const Icon(Icons.import_export),
            onPressed: () => _exportLogs(),
          ),
        ],
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text('You have pushed the button this many times:'),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }

  Future<void> _exportLogs() async {
    // 记录导出日志的操作
    await NDLogs.logThis(
      "Exporting Logs",
      logType: LogType.warning,
    );

    // 导出日志文件路径
    final path = await NDLogs.exportLogFile();

    // 打印日志文件路径
    debugPrint("File found at $path");

    // 读取并打印日志文件内容
    final content = await File(path).readAsString();
    log(content);

    // 清除所有日志
    await NDLogs.clearLogs();
  }
}