Flutter崩溃报告插件groveman_crashlytics的使用

Flutter崩溃报告插件groveman_crashlytics的使用

Groveman Crashlytics

Groveman Crashlytics 是一个用于将日志发送到 Firebase Crashlytics 的插件。它可以帮助开发者在应用崩溃时收集和分析错误信息，从而更快地解决问题。以下是关于如何使用该插件的详细说明。

使用步骤

1. 配置 Firebase Crashlytics

   在使用 groveman_crashlytics 之前，需要先配置 Firebase Crashlytics。请参考 Firebase Crashlytics 文档 进行配置。

2. 添加依赖项

   在 pubspec.yaml 文件中添加以下依赖项：

   dependencies:
     firebase_analytics: 
     groveman: 
     groveman_crashlytics: 
   

3. 导入必要的包

   在你的 Dart 文件中导入 groveman 和 groveman_crashlytics 包：

   import 'package:groveman/groveman.dart';
   import 'package:groveman_crashlytics/groveman_crashlytics.dart';
   

4. 初始化 Crashlytics Tree

   在应用启动时初始化 Crashlytics Tree。通常情况下，只在生产环境中发送日志。你可以通过 kReleaseMode 来判断当前是否为生产环境。

   void main() {  
     // 初始化 DebugTree，用于开发环境的日志输出
     Groveman.plantTree(DebugTree(showColor: true));
     
     // 捕获当前隔离区的错误
     Groveman.captureErrorInZone(() async {
       WidgetsFlutterBinding.ensureInitialized();
       
       // 初始化 Firebase
       await Firebase.initializeApp();
       
       // 如果是生产环境，则种植 CrashlyticsTree
       if (kReleaseMode) {
         Groveman.plantTree(CrashlyticsTree());
       }
       
       // 捕获当前隔离区的错误，默认日志级别为 fatal
       Groveman.captureErrorInCurrentIsolate();
       
       // 启动应用
       runApp(const MyApp());
     });
   }
   

5. 发送不同级别的日志

   groveman_crashlytics 默认会发送 info、warning、error 和 fatal 级别的日志到 Crashlytics。你可以根据需要自定义发送的日志级别。

   // 发送 info 级别的日志
   Groveman.info('这是一个 info 日志');
   
   // 发送 error 级别的日志，并附带异常信息
   Groveman.error('这是一个 error 日志', error: exception);
   
   // 发送 fatal 级别的日志，并附带堆栈跟踪
   Groveman.fatal('这是一个 fatal 日志', error: 'Fatal error', stackTrace: StackTrace.current);
   

6. 自定义日志级别

   如果你只想发送特定级别的日志，可以在创建 CrashlyticsTree 时指定日志级别：

   Groveman.plantTree(
     CrashlyticsTree(logLevels: [
       LogLevel.warning,
       LogLevel.info,
     ]),
   );
   

示例代码

以下是一个完整的示例代码，展示了如何在 Flutter 应用中使用 groveman_crashlytics 插件。

import 'package:firebase_core/firebase_core.dart';
import 'package:flutter/material.dart';
import 'package:groveman/groveman.dart';
import 'package:groveman_crashlytics/groveman_crashlytics.dart';

void main() {
  // 初始化 DebugTree，用于开发环境的日志输出
  Groveman.plantTree(DebugTree(showColor: true));
  
  // 捕获当前隔离区的错误
  Groveman.captureErrorInZone(() async {
    WidgetsFlutterBinding.ensureInitialized();
    
    // 初始化 Firebase
    await Firebase.initializeApp();
    
    // 如果是生产环境，则种植 CrashlyticsTree
    if (kReleaseMode) {
      Groveman.plantTree(CrashlyticsTree());
    }
    
    // 捕获当前隔离区的错误，默认日志级别为 fatal
    Groveman.captureErrorInCurrentIsolate();
    
    // 启动应用
    runApp(const MyApp());
  });
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
      // 发送 info 级别的日志
      Groveman.info('Counter - $_counter');
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: Column(
        mainAxisAlignment: MainAxisAlignment.end,
        children: [
          FloatingActionButton.extended(
            onPressed: () {
              // 发送 fatal 级别的日志，并附带堆栈跟踪
              Groveman.fatal(
                'Fatal',
                error: 'Fatal error',
                stackTrace: StackTrace.current,
              );
            },
            label: const Text('Report fatal error'),
            icon: const Icon(Icons.bug_report),
          ),
          const SizedBox(height: 16),
          FloatingActionButton.extended(
            onPressed: () {
              // 抛出异步错误
              Future.delayed(Duration.zero, () => throw Exception('Async error'));
            },
            label: const Text('Report error'),
            icon: const Icon(Icons.error),
          ),
          const SizedBox(height: 16),
          FloatingActionButton.extended(
            onPressed: _incrementCounter,
            label: const Text('Increment'),
            icon: const Icon(Icons.add),
          ),
        ],
      ),
    );
  }
}