Flutter日志管理插件logger_io的使用

Flutter日志管理插件logger_io的使用

简介

logger_io 是一个简单的日志记录器，它实现了日志记录器应有的功能：将输入的消息发送到一系列输出。它比其他日志库（如 logger）更快，因为它只在需要时使用堆栈跟踪，而不是每次记录日志都使用。

使用方法

简单用法

以下是一个简单的示例，展示了如何使用 logger_io 记录不同级别的日志：

import 'package:logger_io/logger_io.dart';

void main() {
  // 创建一个Logger实例
  final logger = Logger();

  // 记录不同级别的日志
  logger.d('debug message');  // 调试信息
  logger.i('info message');   // 信息
  logger.s('success message'); // 成功信息
  logger.w('warning message'); // 警告
  logger.e('error message', stackTrace: StackTrace.current); // 错误，包含堆栈跟踪
}

多个输出

你可以为 Logger 配置多个输出，例如控制台输出和自定义的 Crashlytics 输出：

import 'package:logger_io/logger_io.dart';
import 'package:firebase_crashlytics/firebase_crashlytics.dart';

void main() {
  // 创建一个Logger实例，并配置多个输出
  final logger = Logger(
    outputs: [
      ConsoleOutput(),  // 控制台输出
      MyCrashlyticsOutput(FirebaseCrashlytics.instance),  // 自定义的Crashlytics输出
    ],
  );

  // 记录日志
  logger.i('info message');
}

自定义输出

你可以通过实现 Output 类来自定义日志输出。例如，下面是一个自定义的 Crashlytics 输出类：

import 'package:logger_io/logger_io.dart';
import 'package:firebase_crashlytics/firebase_crashlytics.dart';

class MyCrashlyticsOutput implements Output {
  final FirebaseCrashlytics _crashlytics;

  const MyCrashlyticsOutput(this._crashlytics);

  [@override](/user/override)
  void log({
    required Object? message,
    required Level level,
    required StackTrace? stackTrace,
    required String context,
  }) {
    // 根据日志级别决定是否记录错误或普通日志
    if (level.value >= Level.error.value) {
      _crashlytics.recordError(message, stackTrace ?? StackTrace.current);
    } else {
      _crashlytics.log(message.toString());
    }
  }
}

性能优势

logger_io 的性能优于其他日志库，因为它只在需要时使用堆栈跟踪，而不是每次记录日志都使用。以下是性能对比的示例：

// logger_io的日志记录时间（20次调试日志，5次测试）
Durations for logger_io, 20 debug log (5 times): (1 ms, 2 ms, 2 ms, 1 ms, 2 ms)

// 其他日志库的日志记录时间（20次调试日志，5次测试）
Duration for logger, 20 debug log (5 times): (15 ms, 16 ms, 16 ms, 16 ms, 13 ms)

完整示例Demo

以下是一个完整的示例，展示了如何根据环境配置不同的日志输出：

import 'package:logger_io/logger_io.dart';
import 'package:firebase_crashlytics/firebase_crashlytics.dart';

void main() {
  // 创建一个默认的Logger实例
  final logger = Logger();
  logger.d('debug message');
  logger.i('info message');
  logger.s('success message');
  logger.w('warning message');
  logger.e('error message', stackTrace: StackTrace.current);

  // 根据环境配置不同的日志输出
  final env = 'dev';  // 环境变量，可以是 'dev' 或 'prod'
  final envLogger = Logger(
    context: env,  // 设置上下文
    outputs: [
      if (env == 'dev') ConsoleOutput(),  // 如果是开发环境，使用控制台输出
      MyCrashlyticsOutput(FirebaseCrashlytics.instance),  // 使用自定义的Crashlytics输出
    ],
  );

  // 记录信息日志
  envLogger.i('info message in $env environment');
}

// 自定义的Crashlytics输出类
class MyCrashlyticsOutput implements Output {
  final FirebaseCrashlytics _crashlytics;

  const MyCrashlyticsOutput(this._crashlytics);

  [@override](/user/override)
  void log({
    required Object? message,
    required Level level,
    required StackTrace? stackTrace,
    required String context,
  }) {
    // 根据日志级别决定是否记录错误或普通日志
    if (level.value >= Level.error.value) {
      _crashlytics.recordError(message, stackTrace ?? StackTrace.current);
    } else {
      _crashlytics.log(message.toString());
    }
  }
}