使用 Firebase App Distribution Android SDK 提醒测试人员有关新应用版本的信息 - Codelab

1. 概览

欢迎学习“在 Android 应用中集成 Firebase App Distribution SDK”这门 Codelab。在本 Codelab 中，您将向应用添加 App Distribution Android SDK，以便在有新的 build 可供下载时向测试人员显示应用内提醒。您将学习如何使用基本配置和自定义配置让测试人员登录以接收更新。然后，您将新版本推送到 App Distribution，并直接在应用中触发新的 build 提醒。

学习内容

• 如何使用 App Distribution 向测试人员分发预发布应用
• 如何将 App Distribution Android SDK 集成到您的应用中
• 如何在有新的预发布 build 可供安装时提醒测试人员
• 如何自定义 SDK 以满足您的测试需求

所需条件

• 最新版 Android Studio。
• 示例代码。
• 一台搭载 Android 4.4+ 和 Google Play 服务 9.8 或更高版本的测试设备，或者搭载 Google Play 服务 9.8 或更高版本的模拟器。
• 如果使用设备，还需要一根连接电缆。

您打算如何使用本教程？

仅通读 阅读并完成练习

您如何评价自己在构建 Android 应用方面的经验水平？

新手 中等 熟练

2. 获取示例代码

通过命令行克隆 GitHub 代码库。

$ git clone https://github.com/FirebaseExtended/codelab-appdistribution-android.git

如果您未安装 git，也可以从其 GitHub 页面或点击此链接下载示例项目。

“codelab-appdistribution-android”包含两个文件夹：

• start - 在此 Codelab 中，您将基于这些起始代码构建应用。
• final - 完成后的示例应用的完整代码。

3. 导入 starter 应用

在 Android Studio 中，从示例代码下载 (File > Open > .../codelab-appdistribution-android/start) 中选择 codelab-appdistribution-android/start 目录 ()。

现在，您应当在 Android Studio 中打开 start 项目。

4. 创建 Firebase 控制台项目

添加新的 Firebase 项目

1. 打开 Firebase 控制台。
2. 选择添加项目，然后将您的项目命名为“Firebase Codelab”。

您无需为此项目启用 Google Analytics。

3. 点击 Create project。

将应用添加到 Firebase

在 Firebase 中注册您的应用。使用“com.google.firebase.appdistributioncodelab”作为软件包名称

将 google-services.json 文件添加到您的应用中

添加软件包名称并选择“Register”（注册），请按以下步骤将 google-services.json 添加到您的应用中：

1. 点击下载 google-services.json 以获取 Firebase Android 配置文件。
2. 将 google-services.json 文件复制到项目的 app 目录中。
3. 文件下载完毕后，您可以跳过控制台中显示的后续步骤（已在 build-android-start 项目中为您完成这些步骤）。

更新应用 ID 以与您的 Firebase 应用保持一致

1. 在左侧菜单（“Project”标签页）中，确保您处于“Android”视图，然后找到“Gradle Scripts”标签页并打开模块（应用级）Gradle 文件（通常是 app/build.gradle.kts）。
2. 更改 applicationId 属性，使其与 Firebase 应用的应用 ID 相匹配。该值应为“com.google.firebase.appdistributioncodelab”

将您的项目与 Gradle 文件同步

为确保您的应用拥有所有依赖项，请在 Android Studio 工具栏中依次选择 File > Sync Project with Gradle Files，将项目与 Gradle 文件同步。

5. 使用 App Distribution Android SDK 设置有关新 build 的应用内提醒

在此步骤中，您将向应用添加 Firebase App Distribution Android SDK，并在有新的应用 build 可供安装时向测试人员显示应用内提醒。为此，请确保您已为“Firebase Codelab”项目启用 Firebase App Testers API（在 Google Cloud 控制台中）。您需要使用同一个账号登录，然后从顶部的下拉菜单中选择正确的项目。

配置应用内提醒

App Distribution Android SDK 提供了两种为测试人员设置应用内构建提醒的方法：

• 基本提醒配置，提供要向测试人员显示的预构建对话框。
• 高级提醒配置，可让您自定义界面 (UI)。

我们先从基本提醒配置开始。您可以使用 updateIfNewReleaseAvailable 向尚未启用提醒的测试人员显示预构建的“启用提醒”对话框，然后检查是否有新的 build。测试人员在 App Distribution 中登录有权访问该应用的账号后，即可启用提醒。调用时，该方法将遵循以下顺序：

1. 检查测试人员是否已启用提醒。如果没有，该方法会显示一个预构建的对话框，提示测试人员使用其 Google 账号登录 App Distribution。

在测试设备上只需启用提醒一次，应用更新后也将有效。在测试设备上，提醒保持启用状态，直到应用被卸载或 signOutTester 方法被调用为止。

2. 检查是否有新推出的 build 可供测试人员安装。
3. 显示一条预构建的提醒，提示测试人员下载最新版本。
4. 在继续更新之前，检查新 build 类型：
5. 如果新 build 是 App Bundle (AAB)，则会将测试人员重定向到 Play 商店以完成更新流程。
6. 如果新 build 是 APK，则该 SDK 会在后台下载新 build，并在下载完成时提示测试人员安装新 build。该 SDK 会使用 NotificationManager. 向用户发送下载进度通知。您可以通过向 updateIfNewReleaseAvailable 任务附加 onProgressUpdate 处理程序来添加自己的进度指示器。

您可以在应用中的任何时间点调用 updateIfNewReleaseAvailable()。例如，您可以在 MainActivity 的 onResume() 方法执行过程中调用 updateIfNewReleaseAvailable()：

打开 MainActivity.kt，然后按如下方式创建 onResume() 方法：

MainActivity.kt

override fun onResume() {
    super.onResume()
    checkForUpdate()
}

现在，让我们实现 checkForUpdate() 方法。

MainActivity.kt

   private fun checkForUpdate() {
        firebaseAppDistribution.updateIfNewReleaseAvailable()
            .addOnProgressListener { updateProgress ->
                // (Optional) Implement custom progress updates in addition to
                // automatic NotificationManager updates.
            }
            .addOnFailureListener { e ->
                if (e is FirebaseAppDistributionException) {
                    // Handle exception.
                }
            }
    }

6. 构建并邀请测试人员下载您的应用

在此步骤中，您将使用 Firebase 控制台将 build 分发给测试人员，以构建应用并测试您的实现。

构建应用

当您准备好将应用的预发布版本分发给测试人员时，请按照常规流程构建 APK。您必须使用调试密钥或应用签名密钥对 APK 进行签名。

将应用分发给测试人员

如需将您的应用分发给测试人员，请使用 Firebase 控制台上传 APK 文件：

1. 打开 Firebase 控制台的 App Distribution 页面。出现提示时，选择您的 Firebase 项目。
2. 在“版本”页面上，从下拉菜单中选择您要分发的应用。

3. 点击开始使用

4. 将应用的 APK 文件拖到控制台中以便上传。
5. 上传完成后，指定要接收此 build 的测试人员群组和各个测试人员。（请添加您的电子邮件地址以接收邀请。）然后，为该 build 添加版本说明。如需详细了解如何创建测试人员群组，请参阅添加和移除测试人员。

6. 点击分发以将 build 提供给测试人员。

注意：在分发 build 后，该 build 将在 150 天内在 Firebase 控制台的“App Distribution”信息中心内提供。当该 build 距离到期还有 30 天的时候，控制台和测试人员测试设备上的 build 列表中都会显示到期通知。

之前未受邀测试应用的测试人员将会收到电子邮件邀请函以开始测试。当有新的 build 可供测试时，活跃测试人员会收到电子邮件通知。如需了解如何安装测试应用，请参阅测试人员设置指南。您可以在 Firebase 控制台中监控每个测试人员的状态，无论他们是否接受了邀请并下载了应用。

现在，您可以在 Firebase 控制台中查看您在应用版本下添加的测试人员。

由于您添加了自己的电子邮件地址，因此会收到 Firebase App Distribution 邀请您测试该应用的电子邮件。您现在是首位测试人员了！按照“接受邀请”中的说明操作，在测试设备上设置为测试人员。

接受邀请

您需要先接受邀请，然后才能下载并测试版本。

1. 在 Android 测试设备上，打开 Firebase App Distribution 发送的电子邮件，然后点按开始使用。
2. 在随即显示的 Firebase App Distribution 测试人员 Web 应用中，使用您的 Google 账号登录，然后点按接受邀请。您现在可以看到受邀测试的版本。

从测试设备下载版本

当您前往 AppDistribution Codelab 应用时，您会看到该版本已可供下载。

1. 点按下载，然后安装并运行应用！
2. 应用启动时，会要求您启用新 build 提醒。点按开启。

3. 使用您的测试人员账号登录。

系统会返回到应用。下次运行应用时，您无需登录或接受提醒

向测试人员分发更新

1. 在模块（应用级）Gradle 文件（通常是 app/build.gradle）中，将 versionName 更新为“1.1”，将 versionCode 更新为 2。
2. 按照常规流程构建您的 APK。您必须使用调试密钥或应用签名密钥为 APK 签名。
3. 在 Firebase 控制台中上传此新 APK，再次将您的电子邮件地址添加为测试人员，然后点击分发。

测试 build 提醒

1. 如果该应用已打开，请确保你已经将其关闭。
2. 重启应用。
3. 应用重启后，您会收到“有新版本可用”提醒。

4. 如需接收最新版本，请点击更新。
5. 如果出现提示，请选择相应选项以启用“从未知来源安装”。
6. 在下一个屏幕上，点击安装（或更新）。

7. 恭喜！您能够使用内置提醒更新应用。

7. 自定义测试人员登录

signInTester/signOutTester 和 isTesterSignedIn 方法可让您更灵活地自定义测试人员的登录体验，以便更好地匹配应用的外观和风格。

以下示例会检查测试人员是否已登录其 Firebase App Distribution 测试人员账号，因此您可以选择仅为尚未登录的测试人员显示登录界面。测试人员登录后，您可以调用 checkForUpdate 以检查测试人员是否可以访问新的构建版本。

我们将注释掉 checkForUpdate() 调用，以便在 onResume 中停用自动检查更新。

MainActivity.kt

override fun onResume() {
        super.onResume()
        //checkForupdate()
    }

而是已在 updatebutton 的 OnClickListener 中添加了 checkForUpdate()。

现在，我们来实现 signIn() 方法，该方法会在用户未登录时登录用户，在用户已登录时退出登录。

MainActivity.kt

    private fun signIn() {
        if (isTesterSignedIn()) {
            firebaseAppDistribution.signOutTester()
            configureUpdateButton()
            configureSigninButton()
        } else {
            firebaseAppDistribution.signInTester()
        }
    }

最后，我们来实现 isTesterSignedIn 方法。

MainActivity.kt

    private fun isTesterSignedIn() : Boolean {
        return firebaseAppDistribution.isTesterSignedIn
    }

构建和测试您的实现

8. 恭喜！

您已经构建了“应用内提醒显示”使用 Firebase App Distribution Android SDK 将应用植入到应用中。

所学内容

• Firebase App Distribution
• Firebase App Distribution 新提醒 Android SDK

后续步骤

• 使用 Fastlane 插件
• 使用 CLI 工具
• 使用 gradle

了解详情

• Firebase.google.com

有疑问？

• Stackoverflow“firebase-app-distribution”
• Firebase 社区 Slack 频道 #app-distribution

报告问题

• GitHub 问题