Flutter崩溃报告插件innim_agconnect_crash的使用

简介

innim_agconnect_crash 是一个支持 Null 安全的插件，它是对 agconnect_crash 的分支版本。该插件提供了强大的崩溃报告功能，可以快速检测、定位并解决应用程序的崩溃问题，并实时生成可读性高的崩溃报告。

引入

华为 AppGallery Connect 提供了一个轻量级的解决方案来处理应用崩溃问题。通过此服务，您可以轻松地在不编写任何代码的情况下检测到崩溃并查看详细的崩溃报告。

安装插件

要将 innim_agconnect_crash 插件添加到您的 Flutter 项目中，请按照以下步骤操作：

1. 在项目的 pubspec.yaml 文件中添加依赖：

   dependencies:
     innim_agconnect_crash: ^1.7.0
   

2. 在终端运行以下命令以安装依赖：

   flutter pub get
   

开发指南

使用方法

更多关于如何使用该插件的信息，请参考 AppGallery Connect Crash 使用指南。

参考文档

有关插件的详细 API 参考，请访问 AppGallery Connect 参考文档。

许可证

innim_agconnect_crash 插件遵循以下许可证：

• Apache License, version 2.0

示例代码

以下是一个完整的示例代码，展示了如何使用 innim_agconnect_crash 插件来记录崩溃信息。

/*
 * Copyright 2020. Huawei Technologies Co., Ltd. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import 'dart:async';

import 'package:flutter/material.dart';
import 'package:innim_agconnect_crash/innim_agconnect_crash.dart';

void main() {
  // 将 Flutter 错误捕获器设置为 AGCCrash 实例
  FlutterError.onError = AGCCrash.instance.onFlutterError;

  // 使用 runZonedGuarded 来捕获未处理的异常
  runZonedGuarded<Future<void>>(
    () async {
      runApp(MyApp());
    },
    (Object error, StackTrace stackTrace) {
      // 记录未处理的错误
      AGCCrash.instance.recordError(error, stackTrace);
    },
  );
}

class MyApp extends StatefulWidget {
  [@override](/user/override)
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  // 启用崩溃收集
  _enableCollection() async {
    await AGCCrash.instance.enableCrashCollection(true);
  }

  // 禁用崩溃收集
  _disableCollection() async {
    await AGCCrash.instance.enableCrashCollection(false);
  }

  // 测试非致命崩溃
  _testCrash() async {
    try {
      throw Exception('test exception');
    } catch (e, stack) {
      AGCCrash.instance.recordError(e, stack);
    }
  }

  // 测试致命崩溃
  _testFatalCrash() async {
    try {
      throw Exception('test exception fatal');
    } catch (e, stack) {
      AGCCrash.instance.recordError(e, stack, fatal: true);
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Center(
            child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            MaterialButton(
                onPressed: _enableCollection,
                color: Colors.blue,
                child: Text(
                  '启用崩溃收集',
                  style: TextStyle(color: Colors.white),
                )),
            MaterialButton(
                onPressed: _disableCollection,
                color: Colors.blue,
                child: Text(
                  '禁用崩溃收集',
                  style: TextStyle(color: Colors.white),
                )),
            MaterialButton(
                onPressed: _testCrash,
                color: Colors.blue,
                child: Text(
                  '测试崩溃',
                  style: TextStyle(color: Colors.white),
                )),
            MaterialButton(
                onPressed: _testFatalCrash,
                color: Colors.blue,
                child: Text(
                  '测试致命崩溃',
                  style: TextStyle(color: Colors.white),
                )
            ),
          ],
        )),
      ),
    );
  }
}