Flutter应用集成插件appcenter_sdk_flutter的使用

App Center SDK for Flutter

appcenter_sdk_flutter 插件支持Flutter应用程序中的 Analytics 和 Crashes 功能。它允许开发者轻松地将App Center服务集成到他们的Flutter项目中，以便收集分析数据和监控崩溃情况。

使用方法

初始化App Center

在开始之前，请确保你已经在Microsoft App Center上创建了你的应用，并获取了唯一的APP_SECRET。接下来，在Flutter项目的入口文件中引入必要的包并初始化App Center：

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

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  // 替换为您的应用程序密钥
  await AppCenter.start(secret: '<APP-SECRET>');
  
  // 捕获Flutter错误并发送给App Center
  FlutterError.onError = (final details) async {
    await AppCenterCrashes.trackException(
      message: details.exception.toString(),
      type: details.exception.runtimeType,
      stackTrace: details.stack,
    );
  };

  runApp(const MyApp());
}

示例代码

下面是一个完整的示例代码，演示如何配置App Center以及触发异常和事件跟踪：

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

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  // 替换为您的应用程序密钥
  await AppCenter.start(secret: '<APP-SECRET>');

  // 捕获Flutter错误并发送给App Center
  FlutterError.onError = (final details) async {
    await AppCenterCrashes.trackException(
      message: details.exception.toString(),
      type: details.exception.runtimeType,
      stackTrace: details.stack,
    );
  };

  runApp(const MyApp());
}

/// MyApp widget.
class MyApp extends StatefulWidget {
  /// Initializes [key].
  const MyApp({super.key});

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

class _MyAppState extends State<MyApp> {
  @override
  Widget build(BuildContext context) => MaterialApp(
        home: Scaffold(
          appBar: AppBar(
            title: const Text('App Center Sdk'),
          ),
          body: Center(
            child: Column(
              children: [
                ElevatedButton(
                  onPressed: () {
                    try {
                      int.parse('not a number'); // 触发异常
                    } catch (e, s) {
                      AppCenterCrashes.trackException(
                        message: e.toString(),
                        type: e.runtimeType,
                        stackTrace: s,
                      );
                    }
                  },
                  child: const Text('TrackException'),
                ),
                ElevatedButton(
                  onPressed: () async =>
                      await AppCenterAnalytics.trackEvent(name: 'eventName'),
                  child: const Text('TrackEvent'),
                ),
                ElevatedButton(
                  onPressed: () async =>
                      await AppCenterCrashes.generateTestCrash(),
                  child: const Text('GenerateTestCrash'),
                ),
              ],
            ),
          ),
        ),
      );
}

AppCenter相关操作

• 启用/禁用App Center：

  await AppCenter.enable();
  await AppCenter.disable();
  final isEnabled = await AppCenter.isEnabled();
  

• 获取安装ID和其他信息：

  final installId = await AppCenter.getInstallId();
  final isRunningInAppCenterTestCloud = await AppCenter.isRunningInAppCenterTestCloud();
  

AppCenter Analytics功能

用于记录自定义事件，帮助理解用户行为：

await AppCenterAnalytics.trackEvent(name: 'A Event', properties: {'property': 'value'}, flags: 1);
await AppCenterAnalytics.pause();
await AppCenterAnalytics.resume();
await AppCenterAnalytics.enableManualSessionTracker();
await AppCenterAnalytics.startSession();

AppCenter Crashes功能

处理应用程序崩溃问题，确保及时发现和修复错误：

await generateTestCrash();
final hasReceivedMemoryWarningInLastSession = AppCenterCrashes.hasReceivedMemoryWarningInLastSession();
final hasCrashedInLastSession = AppCenterCrashes.hasCrashedInLastSession();

// 跟踪异常时，Flutter堆栈跟踪将在App Center中显示。
await AppCenterCrashes.trackException(
  message: 'MessageException',
  type: MessageException.runtimeType,
  stackTrace: StackTrace.fromString('stackTraceString'),
  properties: {'property': 'value'},
);

通过上述步骤，你可以将appcenter_sdk_flutter成功集成到Flutter项目中，利用其强大的功能来提高应用的质量和用户体验。