Flutter日志过滤插件lack_off_debug_logs的使用

Flutter日志过滤插件lack_off_debug_logs的使用

简介

lack_off_debug_logs 是一个用于简化异常捕获和显示日志的 Flutter 插件。它支持 Android、iOS 和鸿蒙平台，并提供了简单易用的 API 来帮助开发者调试应用。

使用步骤

1. 初始化插件

在应用启动时调用 LackOff.initialize 方法，传入应用的根部件（如 MaterialApp 或 CupertinoApp）。

void main() {
  LackOff.initialize(const MyApp());
}

2. 添加 Dio 请求拦截器

为了捕获 Dio 请求的日志，可以添加一个 PrettyDioLogger 拦截器。

import 'package:dio/dio.dart';
import 'package:pretty_dio_logger/pretty_dio_logger.dart';

final dio = Dio();

void setupDioInterceptor() {
  dio.interceptors.add(
    PrettyDioLogger(
      request: true,       // 打印请求日志
      requestHeader: true, // 打印请求头
      responseBody: true,  // 打印响应体
      responseHeader: true, // 打印响应头
    ),
  );
}

3. 显示日志按钮

调用 LackOff.showLackOffButton 方法来显示一个按钮，用户可以通过点击该按钮查看日志。

ElevatedButton(
  onPressed: () {
    LackOff.showLackOffButton(context);
  },
  child: const Text('显示日志按钮'),
),

4. 手动新增日志

如果需要手动添加自定义日志，可以使用 LackOff.addLog 方法。

LackOff.addLog(LackOffBean(
  logType: '自定义类型',
  logTitle: '自定义标题',
  logDetail: '这是自定义日志详情',
  date: DateTime.now().toString(),
));

示例代码

以下是一个完整的示例代码，展示了如何使用 lack_off_debug_logs 插件。

示例代码文件：example/lib/main.dart

import 'dart:async';

import 'package:example/dio_utils.dart'; // 假设你有一个 Dio 工具类
import 'package:flutter/material.dart';
import 'package:lack_off_debug_logs/lack_off.dart';

void main() {
  LackOff.initialize(const MyApp()); // 初始化插件
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'LackOff Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'LackOff 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;

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            ElevatedButton(
              onPressed: () {
                LackOff.showLackOffButton(context); // 显示日志按钮
              },
              child: const Text('显示日志按钮'),
            ),
            ElevatedButton(
              onPressed: () {
                throw Exception('Flutter 运行时异常'); // 模拟运行时错误
              },
              child: const Text('触发 Flutter 错误'),
            ),
            ElevatedButton(
              onPressed: () {
                // 模拟一个定时器异常
                Timer(const Duration(seconds: 2), () {
                  throw Exception('这是一个意外错误！');
                });
              },
              child: const Text('触发 Dart 异常'),
            ),
            ElevatedButton(
              onPressed: () {
                DioUtil.instance.get(); // 调用 Dio 请求
              },
              child: const Text('显示 Dio 日志'),
            ),
          ],
        ),
      ),
    );
  }

  Future<void> fetchData() async {
    // 模拟网络请求延迟
    await Future.delayed(Duration(seconds: 1));

    // 抛出一个异常，例如网络请求失败
    throw Exception('网络请求失败！');
  }
}