Flutter日志记录插件logger_screen的使用

Logger Screen

Logger Screen 是一个Flutter包，它提供了一个用户友好的UI来显示带有过滤和搜索功能的日志。它与流行的 Logger 包无缝协作。

安装

在你的flutter项目中运行以下命令：

flutter pub add logger_screen

使用方法

1. 导入包：

   import 'package:logger_screen/logger_screen.dart';
   

2. 创建 LoggerScreenPrinter 的实例：

   LoggerScreenPrinter myLoggerPrinter = LoggerScreenPrinter(
     fileName: "logs",
     encryptionKey: "my_secret_key",
     printEmojis: true,
   );
   

3. 使用创建的打印机创建 LoggerScreen 小部件：

   LoggerScreen(
     printer: myLoggerPrinter,
     itemBuilder: (context, log, index) {
       // 自定义单个日志项的外观
       return MyCustomLogItem(log: log);
     },
     numberOfColumns: 2, // 指定网格布局中的列数
     style: Style.platform, // 选择Style.material、Style.cupertino或Style.platform
     title: "My Logs", // 设置屏幕标题
     trailingActions: [
       IconButton(
         icon: Icon(Icons.clear_all),
         onPressed: () {
           // 清除日志操作
           myLoggerPrinter.clear();
         },
       ),
     ],
   )
   

4. 开始写入日志：

   final logger = Logger(printer: myLoggerPrinter);
   logger.t("Trace log message");
   logger.d("Debug log message");
   logger.i("Info log message");
   logger.w("Warning log message");
   logger.e("Error log message");
   

功能特性

• 显示带有可自定义外观的日志。
• 根据级别和内容过滤和搜索日志。
• 清除日志操作。
• 可自定义日志项外观。
• 支持单列和网格布局。
• 提供Material Design、Cupertino和平台特定样式。

示例代码

以下是完整的示例代码，演示了如何在应用中使用 logger_screen 插件：

import 'dart:math';

import 'package:flutter/cupertino.dart';
import 'package:flutter/material.dart';
import 'package:logger/logger.dart';
import 'package:logger_screen/logger_screen.dart';

import 'color_schemes.dart'; // 假设这是你项目的颜色方案文件
import 'logger_screen_wrapper.dart'; // 假设这是你项目的包装器文件

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

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

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  Brightness _brightness =
      WidgetsBinding.instance.platformDispatcher.platformBrightness;

  @override
  void initState() {
    super.initState();
    WidgetsBinding.instance.platformDispatcher.onPlatformBrightnessChanged = () {
      WidgetsBinding.instance.handlePlatformBrightnessChanged();
      setState(() {
        _brightness = WidgetsBinding.instance.platformDispatcher.platformBrightness;
      });
    };
  }

  @override
  Widget build(BuildContext context) {
    final materialLightTheme = ThemeData(useMaterial3: true, colorScheme: lightColorScheme);
    final materialDarkTheme = ThemeData(useMaterial3: true, colorScheme: darkColorScheme);

    const darkDefaultCupertinoTheme = CupertinoThemeData(brightness: Brightness.dark);
    final cupertinoDarkTheme = MaterialBasedCupertinoThemeData(
      materialTheme: materialDarkTheme.copyWith(
        cupertinoOverrideTheme: CupertinoThemeData(
          brightness: Brightness.dark,
          barBackgroundColor: darkDefaultCupertinoTheme.barBackgroundColor,
          textTheme: CupertinoTextThemeData(
            primaryColor: Colors.white,
            navActionTextStyle:
                darkDefaultCupertinoTheme.textTheme.navActionTextStyle.copyWith(color: const Color(0xF0F9F9F9)),
            navLargeTitleTextStyle: darkDefaultCupertinoTheme.textTheme.navLargeTitleTextStyle.copyWith(color: const Color(0xF0F9F9F9)),
          ),
        ),
      ),
    );
    final cupertinoLightTheme = MaterialBasedCupertinoThemeData(materialTheme: materialLightTheme);

    return MaterialApp(
      debugShowCheckedModeBanner: false,
      theme: ThemeData(useMaterial3: true, colorScheme: lightColorScheme),
      darkTheme: ThemeData(useMaterial3: true, colorScheme: darkColorScheme),
      themeMode: ThemeMode.system,
      home: CupertinoApp(
        debugShowCheckedModeBanner: false,
        theme: _brightness == Brightness.light ? cupertinoLightTheme : cupertinoDarkTheme,
        localizationsDelegates: const [
          DefaultMaterialLocalizations.delegate,
          DefaultCupertinoLocalizations.delegate,
          DefaultWidgetsLocalizations.delegate,
        ],
        home: const HomeScreen(),
      ),
    );
  }
}

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

  @override
  State<HomeScreen> createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  final printer = LoggerScreenPrinter(
    fileName: 'logs',
    encryptionKey: 'ThisIsAnExampleEncryptionKey123',
  );
  late Logger logger;
  bool _initialized = false;

  Future<void> _printRandomLogs(Logger logger) async {
    for (var count = 0; count < 10; count++) {
      final randomLevel = Log.usedLevelValues[Random().nextInt(Log.usedLevelValues.length)];
      final randomMessage = 'Random log #$count ${randomLevel.name}';
      logger.log(randomLevel, randomMessage);
      await Future.delayed(const Duration(seconds: 1));
    }
  }

  @override
  void initState() {
    super.initState();
    logger = Logger(printer: printer);
    if (!_initialized) {
      _printRandomLogs(logger);
    }
    _initialized = true;
  }

  @override
  Widget build(BuildContext context) {
    void openWithStyle(ScreenStyle screenStyle) {
      final page = LoggerScreenWrapper(
        screenStyle: screenStyle,
        printer: printer,
      );
      Navigator.push(
        context,
        screenStyle.isCupertino
            ? CupertinoPageRoute(builder: (context) => page)
            : MaterialPageRoute(builder: (context) => page),
      );
    }

    return Scaffold(
      body: SizedBox.expand(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          crossAxisAlignment: CrossAxisAlignment.center,
          children: [
            const Text('Open LoggerScreen with style: '),
            const SizedBox(height: 18),
            ElevatedButton(
              onPressed: () => openWithStyle(ScreenStyle.material),
              child: const Text('Material'),
            ),
            const SizedBox(height: 16),
            ElevatedButton(
              onPressed: () => openWithStyle(ScreenStyle.cupertino),
              child: const Text('Cupertino'),
            ),
            const SizedBox(height: 16),
            ElevatedButton(
              onPressed: () => openWithStyle(ScreenStyle.platform),
              child: const Text('Platform'),
            )
          ],
        ),
      ),
    );
  }
}

贡献

欢迎为这个包做出贡献！如果你发现任何问题或有建议，请在 GitHub 上提交issue或pull request。

许可证

logger_screen 在MIT许可证下可用。更多信息请参阅LICENSE文件。