Flutter应用集成插件flutter_appcenter_bundle的使用

概述

flutter_appcenter_bundle 插件集成了 AppCenter 的分析、崩溃报告和分发功能。本文将介绍如何在 Flutter 应用中集成此插件，并提供完整的示例代码。

相关链接

• AppCenter
• AppCenter API 文档

开始前的准备工作

首先，你需要在 AppCenter 注册你的应用并获取相应的 appSecret。

构建配置

由于 AppCenter 分发存在与 Google Play 发布相关的问题，建议为不同的发布渠道设置不同的构建风味(flavor)：

flutter build --flavor googlePlay  # 用于 Google Play
flutter build --flavor appCenter   # 用于 AppCenter

在 android/app/build.gradle 中添加以下配置：

android {
    ...
    
    flavorDimensions "distribute"
    productFlavors {
        appCenter {
            dimension "distribute"
        }

        googlePlay {
            dimension "distribute"
        }
    }

    lintOptions {
        disable 'InvalidPackage'
        checkReleaseBuilds false
    }
}

如果你已经有其他风味设置，可以参考下面的例子合并它们：

android {
    flavorDimensions "dummy", "distribute"
    productFlavors {
        dummyFoo {
            dimension "dummy"
        }
        dummyBar {
            dimension "dummy"
        }
        appCenter {
            dimension "distribute"
        }

        googlePlay {
            dimension "distribute"
        }
    }
}

注意：遇到本地构建问题时，请先尝试运行示例项目进行排查。

使用方法

基本用法

在你的 Dart 文件中导入插件并调用 startAsync 方法启动服务：

import 'package:flutter_appcenter_bundle/flutter_appcenter_bundle.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  
  await AppCenter.startAsync(
    appSecretAndroid: '******', // 替换为你的 Android appSecret
    appSecretIOS: '******',     // 替换为你的 iOS appSecret
    enableAnalytics: true,      // 是否启用分析，默认为true
    enableCrashes: true,        // 是否启用崩溃报告，默认为true
    enableDistribute: false,    // 是否启用分发，默认为false
    usePrivateDistributeTrack: false, // 是否使用私有分发轨道，默认为false
    disableAutomaticCheckForUpdate: false, // 是否禁用自动检查更新，默认为false
  );
  
  runApp(MyApp());
}

// 跟踪事件
AppCenter.trackEventAsync('my event', <String, String>{
  'prop1': 'value1',
  'prop2': 'value2',
});

运行时开启或关闭功能

你可以在运行时动态地开启或关闭某些功能：

await AppCenter.configureAnalyticsAsync(enabled: true);
await AppCenter.configureCrashesAsync(enabled: true);
await AppCenter.configureDistributeAsync(enabled: true);
await AppCenter.configureDistributeDebugAsync(enabled: true); // 仅限 Android
await AppCenter.checkForUpdateAsync(); // 手动检查更新

示例代码

以下是完整的示例代码，展示了如何集成 flutter_appcenter_bundle 并显示一些基本信息：

import 'package:flutter/material.dart';
import 'package:package_info/package_info.dart';
import 'package:flutter_appcenter_bundle/flutter_appcenter_bundle.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await AppCenter.startAsync(
    appSecretAndroid: '49361c2e-b788-4bc2-a33d-838b04b3e06b',
    appSecretIOS: '2da3d93f-6b3f-48f9-920f-2d63ae3cd25a',
    enableDistribute: false,
  );
  await AppCenter.configureDistributeDebugAsync(enabled: false);

  runApp(MyApp());
}

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  @override
  void initState() {
    super.initState();
    AppCenter.trackEventAsync('_MyAppState.initState');
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: Container(
          padding: EdgeInsets.all(20),
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            crossAxisAlignment: CrossAxisAlignment.start,
            children: <Widget>[
              const PackageInfoContent(),
              const SizedBox(height: 8.0),
              FutureBuilder(
                future: AppCenter.isCrashesEnabledAsync(),
                builder: (_, AsyncSnapshot<bool?> snapshot) {
                  if (snapshot.hasData) {
                    final isCrashesEnabled = snapshot.data!;

                    return Text('IsCrashesEnabled: $isCrashesEnabled');
                  }

                  return const CircularProgressIndicator.adaptive();
                },
              ),
              const SizedBox(height: 8.0),
              FutureBuilder(
                future: AppCenter.isAnalyticsEnabledAsync(),
                builder: (_, AsyncSnapshot<bool?> snapshot) {
                  if (snapshot.hasData) {
                    final isAnalyticsEnabled = snapshot.data!;

                    return Text('IsAnalyticsEnabled: $isAnalyticsEnabled');
                  }

                  return const CircularProgressIndicator.adaptive();
                },
              ),
              const SizedBox(height: 8.0),
              FutureBuilder(
                future: AppCenter.isDistributeEnabledAsync(),
                builder: (_, AsyncSnapshot<bool?> snapshot) {
                  if (snapshot.hasData) {
                    final isDistributeEnabled = snapshot.data!;

                    return Text('IsDistributeEnabled: $isDistributeEnabled');
                  }

                  return const CircularProgressIndicator.adaptive();
                },
              ),
            ],
          ),
        ),
      ),
    );
  }
}

class PackageInfoContent extends StatelessWidget {
  const PackageInfoContent();

  @override
  Widget build(BuildContext context) {
    return FutureBuilder(
      future: PackageInfo.fromPlatform(),
      builder: (_, AsyncSnapshot<PackageInfo> snapshot) {
        if (snapshot.hasData) {
          final packageInfo = snapshot.data!;

          return Column(
            crossAxisAlignment: CrossAxisAlignment.start,
            children: [
              Text('App name:\n${packageInfo.appName}'),
              const SizedBox(height: 8.0),
              Text('Package name:\n${packageInfo.packageName}'),
              const SizedBox(height: 8.0),
              Text('Version:\n${packageInfo.version}'),
              const SizedBox(height: 8.0),
              Text('Build:\n${packageInfo.buildNumber}'),
            ],
          );
        }

        return const CircularProgressIndicator.adaptive();
      },
    );
  }
}

故障排除

• iOS: CocoaPods could not find compatible versions for pod "AppCenter"

  删除 Podfile.lock 文件后重新构建，这是升级 iOS 原生依赖时常见的问题。

• Android 构建问题

  • 确保 example 项目能够成功构建。
  • 检查 gradle-wrapper.properties 中的 Gradle 版本。
  • 检查 build.gradle 中的 Kotlin 版本、compileSdkVersion 和 com.android.tools.build:gradle 版本。
  • 参考 issue 设置 lintOptions。

• jcenter 退役

  jcenter 将于 2021 年 5 月 1 日退役，需替换为 mavenCentral()：

repositories {
     google()
     mavenCentral()
     gradlePluginPortal()
}