OmniLog 是一个 Flutter 日志管理插件，旨在帮助开发者更高效地管理和查看应用程序的日志信息。它提供了丰富的功能，如日志级别控制、日志格式化、日志存储和日志输出等。以下是如何使用 OmniLog 插件的详细步骤：

1. 添加依赖

首先，你需要在 pubspec.yaml 文件中添加 omnilog 依赖：

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

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

2. 初始化 OmniLog

在你的应用程序启动时，初始化 OmniLog。通常可以在 main.dart 文件中进行初始化：

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

void main() {
  // 初始化 OmniLog
  OmniLog.initialize(
    level: LogLevel.debug,  // 设置日志级别
    formatter: DefaultLogFormatter(),  // 使用默认日志格式化器
    output: ConsoleOutput(),  // 输出日志到控制台
  );

  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'OmniLog Example',
      home: HomeScreen(),
    );
  }
}

3. 使用 OmniLog 记录日志

在应用程序的任何地方，你可以使用 OmniLog 来记录日志。OmniLog 提供了不同级别的日志记录方法：

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

class HomeScreen extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    // 记录不同级别的日志
    OmniLog.debug('This is a debug message');
    OmniLog.info('This is an info message');
    OmniLog.warning('This is a warning message');
    OmniLog.error('This is an error message');
    OmniLog.critical('This is a critical message');

    return Scaffold(
      appBar: AppBar(
        title: Text('OmniLog Example'),
      ),
      body: Center(
        child: Text('Check the console for logs'),
      ),
    );
  }
}

4. 自定义日志格式化器

你可以自定义日志格式化器来满足特定的需求。OmniLog 提供了一个 LogFormatter 接口，你可以实现它来创建自定义的日志格式化器：

class CustomLogFormatter implements LogFormatter {
  @override
  String format(LogLevel level, String message, {DateTime? time}) {
    time ??= DateTime.now();
    return '[${time.toIso8601String()}] [$level] $message';
  }
}

然后在初始化 OmniLog 时使用自定义的格式化器：

OmniLog.initialize(
  level: LogLevel.debug,
  formatter: CustomLogFormatter(),
  output: ConsoleOutput(),
);

5. 自定义日志输出

OmniLog 允许你将日志输出到不同的目标，比如控制台、文件或远程服务器。你可以实现 LogOutput 接口来创建自定义的日志输出方式：

class FileOutput implements LogOutput {
  final File file;

  FileOutput(this.file);

  @override
  void output(String formattedLog) {
    file.writeAsStringSync('$formattedLog\n', mode: FileMode.append);
  }
}

然后在初始化 OmniLog 时使用自定义的输出方式：

final file = File('app.log');
OmniLog.initialize(
  level: LogLevel.debug,
  formatter: DefaultLogFormatter(),
  output: FileOutput(file),
);

6. 设置日志级别

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

OmniLog.initialize(
  level: LogLevel.info,
  formatter: DefaultLogFormatter(),
  output: ConsoleOutput(),
);

7. 日志过滤

OmniLog 还支持日志过滤功能，你可以通过设置过滤器来决定哪些日志应该被记录或忽略：

OmniLog.initialize(
  level: LogLevel.debug,
  formatter: DefaultLogFormatter(),
  output: ConsoleOutput(),
  filter: (LogLevel level, String message) {
    return !message.contains('sensitive');  // 忽略包含 "sensitive" 的日志
  },
);

8. 日志上下文

OmniLog 还支持日志上下文，你可以在记录日志时附加额外的上下文信息：

OmniLog.debug('User logged in', context: {'userId': 123});