Flutter日志管理插件flutter_logs_firebase_timber的使用

Flutter日志管理插件flutter_logs_firebase_timber的使用

本项目利用了Timber库在Android和iOS平台上高效地记录日志。Timber提供了一个轻量级但功能强大的日志工具，帮助我们轻松管理日志语句。为了增强远程调试能力，我们集成了Firebase，它能够实时捕获并发布这些日志到Firebase控制台。这种设置允许无缝监控和调试应用程序，确保能够及时识别和解决关键问题。通过利用Timber的日志功能和Firebase的强大云基础设施，我们实现了一个可靠且可扩展的远程日志解决方案，有助于更好地维护并在开发周期中进行更快的迭代。

特性

• 高效地跟踪远程和本地日志，确保全面的监控和分析能力。
• 可以直接在Firebase控制台中无缝监控应用日志，提供集成和流畅的用户体验。
• 设计时考虑到了易用性，为所有技术级别的用户提供了直观和易于访问的界面。
• 实时数据库截图：

开始使用

1. 在pubspec.yaml文件中添加插件

flutter_logs_firebase_timber: ^0.0.3

2. 运行命令获取依赖

flutter pub get

Firebase设置

1. 在Firebase控制台创建一个Firebase项目。

2. 在项目概览部分点击Flutter图标注册您的应用。

3. 按照CLI设置说明操作。

A. 为公共读写访问配置Firebase实时数据库规则

1. 选择您的Firebase项目。
2. 导航到实时数据库：
   • 点击左侧菜单中的“构建”，然后选择“实时数据库”。
3. 打开“规则”选项卡：
   • 在实时数据库部分点击“规则”标签。
4. 设置公共读写访问：
   • 将现有规则替换为以下代码以允许公共读写访问。请注意，对于生产应用，设置公共访问通常不推荐，因为它存在安全风险。仅在测试或开发环境中使用此配置。

{
  "rules": {
    ".read": "true",
    ".write": "true"
  }
}

1. 点击“发布”按钮以应用更改。

重要提示

将.read和.write设置为true会使任何人都可以通过数据库URL读取和写入数据，这会带来显著的安全风险。对于生产环境，请实施适当的安全规则以保护您的数据。例如，只允许已认证的用户访问：

{
  "rules": {
    ".read": "auth != null",
    ".write": "auth != null"
  }
}

示例

初始化FlutterLogsFirebaseTimber包。此方法应在应用程序启动期间调用一次。

await RemoteLogger.initialize();

• 为了在runApp()方法被调用之前执行异步操作（如初始化数据库或获取初始配置），确保在main()函数的开头完全初始化Flutter框架与底层平台（如iOS或Android）之间的绑定。

WidgetsFlutterBinding.ensureInitialized();

• 异步初始化RemoteLogger。

void main() async {
  // 确保Flutter框架被初始化
  WidgetsFlutterBinding.ensureInitialized();
  // 仅在调试模式下初始化插件
  if (kDebugMode) {
    await RemoteLogger.initialize();
  }
  runApp(const MyApp());
}

使用方法

这是一个静态方法调用RemoteLogger类的log函数，用于将日志消息发送到Firebase上的日志服务。

RemoteLogger.log(
  logLevel: LogLevel.info,
  tag: "onPressed()",
  message: "This is a log message",
  error: null
)

额外信息

希望您觉得FlutterLogsFirebaseTimber插件有用！

示例代码

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:flutter_logs_firebase_timber/flutter_logs_firebase_timber.dart';
import 'package:flutter_logs_firebase_timber/remote/logs_tree.dart';

void main() async {
  // 确保Flutter框架被初始化
  WidgetsFlutterBinding.ensureInitialized();
  // 仅在调试模式下初始化插件
  if (kDebugMode) {
    await RemoteLogger.initialize();
  }
  runApp(const Example());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter logs firebase timber example',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(),
    );
  }
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      body: Center(
        child: ElevatedButton(
          onPressed: () => {
            // 使用FlutterLogsFirebaseTimber记录一条消息
            RemoteLogger.log(
              logLevel: LogLevel.info,
              tag: "onPressed()",
              message: "This is a log message",
              error: null
            )
          },
          child: const Text('点击我'),
        ),
      ),
    );
  }
}