Flutter日志记录插件hbologger的使用

hbologger 是一个用于Flutter的应用程序的日志记录插件，它通过责任链模式提供了结构化的日志机制。它能够与Dio（网络请求库）、Riverpod（状态管理库）和Flutter的导航系统无缝集成。

特性

• 责任链模式：日志消息通过一条链进行处理，允许灵活且模块化的日志记录。
• Dio集成：以结构化方式记录HTTP请求、响应和错误。
• Riverpod集成：记录provider生命周期事件，包括创建、更新、销毁和错误。
• 导航器集成：跟踪并记录您的Flutter应用程序中的导航事件。
• 可定制的日志级别：支持DEBUG、INFO和ERROR日志级别。

安装

在你的 pubspec.yaml 文件中添加 hbologger：

dependencies:
  hbologger: ^0.0.1

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

使用指南

日志级别

hbologger 包支持三种日志级别：

• DEBUG：记录调试时通常有用的信息。
• INFO：记录应用程序操作的一般信息。
• ERROR：记录出错时的错误消息，包括堆栈跟踪。

示例代码：

loggerChain.logMessage('这是调试消息', LogLevel.DEBUG);
loggerChain.logMessage('这是信息消息', LogLevel.INFO);
loggerChain.logMessage('这是错误消息', LogLevel.ERROR);

设置责任链

该包提供了多个日志记录器（DebugLogger、InfoLogger、ErrorLogger），它们被串联在一起，根据日志消息的严重程度来处理日志。

示例代码：

import 'package:hbologger/src/loggers/debug_logger.dart';
import 'package:hbologger/src/loggers/info_logger.dart';
import 'package:hbologger/src/loggers/error_logger.dart';
import 'package:hbologger/src/log_level_enum.dart';
import 'package:hbologger/src/logger.dart';

void main() {
  final loggerChain = DebugLogger()
    ..setNextLogger(InfoLogger())
    ..setNextLogger(ErrorLogger());

  // 示例日志消息
  loggerChain.logMessage('这是调试消息', LogLevel.DEBUG);
  loggerChain.logMessage('这是信息消息', LogLevel.INFO);
  loggerChain.logMessage('这是错误消息', LogLevel.ERROR);
}

Dio集成

为了记录HTTP请求、响应和错误，可以使用 HboLoggerInterceptor。

示例代码：

import 'package:dio/dio.dart';
import 'package:hbologger/hbologger_interceptor.dart';

void main() {
  final dio = Dio();

  // 将 HboLoggerInterceptor 添加到 Dio
  dio.interceptors.add(HboLoggerInterceptor());

  // 示例请求
  dio.get('https://jsonplaceholder.typicode.com/posts/1').then((response) {
    print(response.data);
  }).catchError((error) {
    print(error);
  });
}

Riverpod集成

为了记录provider生命周期事件，可以使用 LoggerObserver 和 Riverpod。

示例代码：

import 'package:flutter/material.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:hbologger/logger_observer.dart';

void main() {
  runApp(
    ProviderScope(
      observers: [LoggerObserver()],
      child: MyApp(),
    ),
  );
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Riverpod Logger Example',
      home: MyHomePage(),
    );
  }
}

final exampleProvider = Provider((ref) => "Hello, World!");

class MyHomePage extends ConsumerWidget {
  [@override](/user/override)
  Widget build(BuildContext context, WidgetRef ref) {
    final example = ref.watch(exampleProvider);

    return Scaffold(
      appBar: AppBar(
        title: Text('Riverpod Logger Example'),
      ),
      body: Center(
        child: Text(example),
      ),
    );
  }
}

导航器集成

为了记录Flutter应用中的导航事件，可以使用 LoggingNavigatorObserver。

示例代码：

import 'package:flutter/material.dart';
import 'package:hbologger/logging_navigator_observer.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      navigatorObservers: [LoggingNavigatorObserver()],
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('首页'),
      ),
      body: Center(
        child: Text('导航并观察控制台中的日志。'),
      ),
    );
  }
}