Flutter日志记录插件sraph_logger的使用

在Flutter应用开发中，记录日志是非常重要的。它可以帮助我们更好地理解程序运行时的状态，并在出现问题时快速定位问题。本文将介绍如何使用sraph_logger插件来记录日志。

初始化

首先，我们需要配置日志记录器以确保它可以处理日志消息。默认情况下，logging包不会对日志消息做任何有用的事情。你需要设置日志级别。

Logger.root.level = Level.ALL; // 默认级别为Level.INFO

然后，你可以监听onRecord流以获取LogRecord事件。LogRecord类包含了日志消息的详细信息，如消息内容、错误信息、日志名称等。

Logger.root.onRecord.listen((LogRecord rec) {
  print('${rec.level.name}: ${rec.time}: ${rec.message}');
});

可用的日志级别包括：

• Level.OFF
• Level.DEBUG
• Level.INFO
• Level.WARNING
• Level.ERROR

记录日志消息

接下来，创建一个具有唯一名称的日志记录器，以便更容易地识别日志消息的来源。

final log = Logger('MyClassName');

以下是一个记录调试消息和错误的例子：

var future = doSomethingAsync().then((result) {
  log.debug('Got the result: $result'); // 记录调试信息
  processResult(result);
}).catchError((e, stackTrace) => log.severe('Oh noes!', e, stackTrace)); // 记录严重错误

当你需要记录更复杂的日志消息时，可以传递一个闭包，该闭包仅在实际记录时才会被评估。

log.debug(() => [1, 2, 3, 4, 5].map((e) => e * 4).join("-")); // 记录复杂表达式的计算结果

可用的日志方法包括：

• log.debug(logged_content);
• log.info(logged_content);
• log.warning(logged_content);
• log.error(logged_content);

完整示例

以下是一个完整的示例，展示了如何使用sraph_logger插件记录日志。

import 'package:sraph_logger/sraph_logger.dart';

final log = Logger('ExampleLogger');

/// Example of configuring a logger to print to stdout.
///
/// This example will print:
///
/// ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
/// │ [💡] [ExampleLogger] [2022-07-20 11:01:13.550015]
/// ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄
/// │ recursion: n = 4
/// └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
/// ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
/// │ [💡] [ExampleLogger] [2022-07-20 11:01:13.560492]
/// ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄
/// │ recursion: n = 3
/// └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
/// Fibonacci(4) is: 3
/// Fibonacci(5) is: 5
/// ┌───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
/// │ Exception: Unexpected negative
/// ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄
/// │ #0      fibonacci (file:///home/nan/github.com/sraphs/flutter_packages/sraph_logger/example/sraph_logger_example.dart:48:100)
/// │ #1      main (file:///home/nan/github.com/sraphs/flutter_packages/sraph_logger/example/sraph_logger_example.dart:43:31)
/// │ #2      _delayEntrypointInvocation.<anonymous closure> (dart:isolate-patch/isolate_patch.dart:297:19)
/// │ #3      _RawReceivePortImpl._handleMessage (dart:isolate-patch/isolate_patch.dart:192:12)
/// ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄
/// │ [⛔] [ExampleLogger] [2022-07-20 11:01:13.561669]
/// ├┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄┄
/// │ Unexpected negative n: -42
/// └───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
/// Fibonacci(-42) is: 1

void main() {
  Logger.root.level = Level.ALL; // 默认级别为Level.ALL

  print('Fibonacci(4) is: ${fibonacci(4)}');

  Logger.root.level = Level.ERROR; // 跳过低于ERROR级别的日志
  print('Fibonacci(5) is: ${fibonacci(5)}');

  print('Fibonacci(-42) is: ${fibonacci(-42)}');
}

int fibonacci(int n) {
  if (n <= 2) {
    if (n < 0) log.error('Unexpected negative n: $n', Exception('Unexpected negative'), StackTrace.current);
    return 1;
  } else {
    log.info('recursion: n = $n');
    return fibonacci(n - 2) + fibonacci(n - 1);
  }
}