Flutter日志管理插件dotup_flutter_logger的使用

在Flutter应用开发过程中，有效地管理和查看日志对于调试和监控应用程序的状态至关重要。dotup_flutter_logger 是一个专门为此目的设计的插件，它允许开发者以结构化的方式记录日志，并且提供了可视化界面来查看这些日志。

安装

首先，你需要在项目的 pubspec.yaml 文件中添加 dotup_flutter_logger 依赖：

dependencies:
  dotup_flutter_logger: ^x.x.x  # 请替换为最新版本号

然后运行 flutter pub get 来安装该插件。

使用示例

初始化和配置

在你的应用启动时，需要初始化并配置日志管理器。以下是一个简单的示例：

import 'package:dotup_dart_logger/dotup_dart_logger.dart';
import 'package:dotup_flutter_logger/dotup_flutter_logger.dart';
import 'package:flutter/material.dart';
import 'package:provider/provider.dart';

late final ILogWriter sqfLiteLogWriter;

final logger = Logger('Logger demo');

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  
  // 添加控制台日志记录器
  LoggerManager.addLogWriter(ConsoleLogWriter(LogLevel.All, formater: PrettyFormater(showColors: true)));

  runApp(const LoggerDemoProvider());
}

主应用

创建主应用类 LoggerDemoApp，并在其中设置主题和主页：

class LoggerDemoApp extends StatelessWidget {
  const LoggerDemoApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    logger.console('LoggerDemoApp build');
    return Consumer<ThemeProvider>(
      builder: (context, themeProvider, child) {
        return MaterialApp(
          debugShowCheckedModeBanner: false,
          title: 'dotup.de Logger Demo',
          theme: themeProvider.lightTheme,
          darkTheme: themeProvider.darkTheme,
          themeMode: themeProvider.themeMode,
          home: const LoggerDemoScaffold(),
        );
      },
    );
  }
}

日志管理提供者

创建 LoggerDemoProvider 类来提供主题切换功能：

class LoggerDemoProvider extends StatelessWidget {
  const LoggerDemoProvider({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    logger.console('LoggerDemoProvider build');
    return MultiProvider(
      providers: [
        ChangeNotifierProvider(
          create: (context) {
            final themeProvider = ThemeProvider.defaultThemes();
            themeProvider.switchTheme(false);
            return themeProvider;
          },
        )
      ],
      child: const LoggerDemoApp(),
    );
  }
}

日志显示界面

创建 LoggerDemoScaffold 类来展示日志列表界面：

class LoggerDemoScaffold extends StatefulWidget {
  const LoggerDemoScaffold({super.key});

  [@override](/user/override)
  State<LoggerDemoScaffold> createState() => _LoggerDemoScaffoldState();
}

class _LoggerDemoScaffoldState extends State<LoggerDemoScaffold> {
  late LoggerListController controller;
  late LoggerListSettings settings;

  [@override](/user/override)
  void initState() {
    super.initState();
    controller = LoggerListController(stackSize: 50);
    settings = LoggerListSettings.standard();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return LoggerScaffold(
      appBar: AppBar(
        title: const Text('dotup Logger'),
        actions: [
          IconButton(
            icon: const Icon(Icons.add),
            tooltip: '添加条目',
            onPressed: _createDemoEntry,
          ),
          IconButton(
            icon: const Icon(Icons.settings),
            tooltip: '设置',
            onPressed: () async {
              logger.info('设置打开');
              final newSettings = await Navigator.of(context).push<LoggerListSettings>(
                MaterialPageRoute(
                  builder: (context) => LoggerListSettingsPage(settings: settings),
                ),
              );

              if (newSettings != null) {
                controller.setFilter(newSettings.logLevelStates);
                controller.stackSize = newSettings.pageSize;
                settings = newSettings;
                logger.info('新设置已应用');
              }
            },
          ),
        ],
      ),
      title: 'dotup Logger',
    );
  }

  void _createDemoEntry() {
    var random = Random(DateTime.now().microsecondsSinceEpoch);
    var next = 1 << random.nextInt(LogLevel.values.length);
    var nextLevel = LogLevel.fromValue(next);

    switch (nextLevel) {
      case LogLevel.Debug:
        logger.debug("这是一条调试信息。如果准备上线，请禁用调试信息！",
            source: 'SOURCE1');
        break;

      case LogLevel.Error:
        logger.error(MyError("我们遇到了问题！"));
        break;

      case LogLevel.Exception:
        logger.exception(MyException('这种情况可能会发生..'));
        break;

      case LogLevel.Info:
        logger.info("我想你已经知道这条信息了。");
        break;

      case LogLevel.Warn:
        logger.warn("哦哦，它正在工作。可能你应该看看你的源代码为什么这种错误频繁出现？");
        break;

      default:
        logger.warn('nextLevel == ${nextLevel.name}');
    }
  }
}

class MyError extends Error {
  final String message;
  MyError(this.message);

  [@override](/user/override)
  String toString() {
    return message;
  }
}

class MyException implements Exception {
  final String? message;

  MyException([this.message]);

  [@override](/user/override)
  String toString() {
    if (message == null) return '异常';
    return '异常: $message';
  }
}