使用 Firebase App Distribution iOS SDK 提醒测试人员您的新应用版本 - Codelab

一、概述

欢迎来到在您的 iOS 应用代码实验室中集成 Firebase 应用分发 SDK。在此 Codelab 中，您将 App Distribution SDK 添加到您的应用，以便在新版本可供下载时向您的测试人员显示应用内提醒。您将了解如何使用基本配置和自定义配置让您的测试人员登录以接收更新。然后，您将向 App Distribution 推送新版本并在应用程序中触发新构建警报。

你会学到什么

• 如何使用 App Distribution 将预发布应用分发给现场测试人员
• 如何将 App Distribution iOS SDK 集成到您的应用中
• 当有新的预发布版本准备安装时如何提醒测试人员
• 如何自定义 SDK 以满足您独特的测试需求

你需要什么

• Xcode 12（或更高版本）
• CocoaPods 1.9.1（或更高版本）
• 用于 Ad Hoc 分发的Apple Developer 帐户
• 用于测试的物理 iOS 设备。 （ iOS 模拟器应用适用于大部分代码实验室，但模拟器无法下载版本。）

您将如何使用本教程？

只通读一遍阅读并完成练习

如何评价您构建 iOS 应用程序的体验？

新手中间的精通

2.创建Firebase控制台项目

添加新的 Firebase 项目

1. 登录 Firebase。
2. 在Firebase 控制台中，点击添加项目，然后将您的项目命名为“Firebase Codelab”。

您不需要为此项目启用 Google Analytics。

3. 单击创建项目。

将应用程序添加到 Firebase

按照文档向 Firebase 注册您的应用程序。使用“com.google.firebase.codelab.AppDistribution.<your_name>”作为 iOS Bundle ID。

出现提示时，下载项目的GoogleService-Info.plist文件。稍后您将需要它。

3.获取示例项目

下载代码

首先克隆示例项目。

git clone [e-mail]:googlecodelabs/firebase-appdistribution-ios.git

如果您没有安装 git，您还可以从其 GitHub 页面或单击此链接下载示例项目。

下载依赖项并在 Xcode 中打开项目

1. 在同一目录中打开Podfile

cd firebase-appdistribution-ios/start
Open Podfile

2. 将以下行添加到您的 podfile：

播客文件

pod 'Firebase/AppDistribution'

在项目目录中运行pod update ，并在 Xcode 中打开项目。

pod install --repo-update
xed .

更新 Bundle Identifier 以匹配您的 Firebase 应用

在左侧菜单中，双击AppDistributionExample。然后，找到General选项卡，并更改 bundle identifier 以匹配您的 Firebase 应用程序的 bundle identifier，这可以在project settings中找到。这应该是“com.google.firebase.codelab.AppDistribution.<your_name>”

将 Firebase 添加到您的应用

在文件系统中找到您之前下载的GoogleService-Info.plist文件，并将其拖到 Xcode 项目的根目录中。您也可以随时从项目的设置页面下载此文件。

在您的AppDistributionExample/AppDelegate.swift文件中，在文件顶部导入 Firebase

AppDistributionExample/AppDelegate.swift

import Firebase

并在didFinishLaunchingWithOptions方法中添加一个配置 Firebase 的调用。

AppDistributionExample/AppDelegate.swift

FirebaseApp.configure()

4. 使用 App Distribution SDK 设置应用内新构建提醒

在此步骤中，您会将 Firebase App Distribution SDK 添加到您的应用，并在您的应用的新版本可供安装时向您的测试人员显示应用内提醒。为此，请确保您已为“Firebase Codelab”项目（在 Google Cloud Console 中）启用Firebase App Testers API 。您需要使用相同的帐户登录并从顶部的下拉菜单中选择正确的项目。

配置应用内提醒

App Distribution SDK 提供了两种为测试人员设置应用程序内构建警报的方法：一种是基本警报配置，它带有一个预构建的登录对话框以显示给测试人员，另一种是高级警报配置，它允许您自定义您自己的用户界面 (UI)。

我们将从基本的警报配置开始。您可以使用checkForUpdate向尚未启用警报的测试人员显示预构建的启用警报对话框，然后检查是否有新版本可用。测试人员通过登录有权访问 App Distribution 中的应用程序的帐户来启用警报。调用时，该方法执行以下序列：

1. 检查测试人员是否启用了警报。如果没有，则显示一个预建对话框，提示他们使用他们的 Google 帐户登录 App Distribution。

启用警报是测试设备上的一次性过程，并且在您的应用程序更新期间持续存在。在卸载应用程序或调用signOutTester方法之前，警报在测试设备上保持启用状态。有关详细信息，请参阅方法的参考文档（ Swift或Objective-C ）。

2. 检查新的可用构建以供测试人员安装。返回一个释放对象或一个错误。

您可以在应用中的任何位置包含checkForUpdate 。例如，您可以通过在UIViewController的viewDidAppear中包含checkForUpdate来提示您的测试人员在启动时安装新的可用构建。

在您的AppDistributionViewController.swift文件中，在文件顶部导入 Firebase

AppDistributionViewController.swift

import Firebase

打开AppDistributionExample/AppDistributionViewController.swift ，然后将行复制到viewDidAppear方法中，如下所示：

AppDistributionViewController.swift

 override func viewDidAppear(_ animated: Bool) {
    checkForUpdate()
 }

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

AppDistributionViewController.swift

  private func checkForUpdate() {
    AppDistribution.appDistribution().checkForUpdate(completion: { [self] release, error in
      var uiAlert: UIAlertController

      if error != nil {
        uiAlert = UIAlertController(title: "Error", message: "Error Checking for update! \(error?.localizedDescription ?? "")", preferredStyle: .alert)
      } else if release == nil {
        uiAlert = UIAlertController(title: "Check for Update", message: "No releases found!!", preferredStyle: .alert)
        uiAlert.addAction(UIAlertAction(title: "Ok", style: UIAlertAction.Style.default))
      } else {
        guard let release = release else { return }

        let title = "New Version Available"
        let message = "Version \(release.displayVersion)(\(release.buildVersion)) is available."
        uiAlert = UIAlertController(title: title, message: message, preferredStyle: .alert)

        uiAlert.addAction(UIAlertAction(title: "Update", style: UIAlertAction.Style.default) {
          _ in
          UIApplication.shared.open(release.downloadURL)
        })
        uiAlert.addAction(UIAlertAction(title: "Cancel", style: UIAlertAction.Style.cancel) {
          _ in
        })
      }
      self.present(uiAlert, animated: true, completion: nil)
    })
  }

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

在此步骤中，您将构建您的应用程序并通过使用 Firebase 控制台将构建分发给测试人员来测试您的实施。

构建您的应用

当您准备好将应用程序的预发布版本分发给测试人员时，选择“Any iOS Device (arm64)”作为构建目标，然后选择 Product->Archive。创建存档后，使用开发分发配置文件构建签名分发。

构建完成后，它会在您指定的文件夹中保存一个 IPA 文件和一些日志文件。您可以按照以下步骤将 IPA 文件分发给您的测试人员。

如果您在构建应用程序时遇到问题，请参阅Apple 的代码签名文档以了解故障排除步骤。

将您的应用分发给测试人员

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

1. 打开 Firebase 控制台的App Distribution 页面。出现提示时选择您的 Firebase 项目。
2. 按开始

3. 在发布页面上，从下拉菜单中选择要分发的应用程序。

4. 将应用程序的 IPA 文件拖到控制台以上传它。
5. 上传完成后，指定要接收构建的测试人员组和个人测试人员。 （添加您的电子邮件以接收邀请。）然后，为构建添加发行说明。有关创建测试人员组的更多信息，请参阅管理测试人员。

6. 单击分发以使构建对测试人员可用。

注意：分发构建后，它将在 Firebase 控制台的 App Distribution 仪表板中可用 150 天（五个月）。当构建距离到期还有 30 天时，控制台和测试人员在其测试设备上的构建列表中都会显示到期通知。

未受邀测试应用程序的测试人员会收到开始测试的电子邮件邀请，而现有测试人员会收到新版本已准备好测试的电子邮件通知（有关如何安装测试应用程序的说明，请阅读测试人员设置指南）。您可以在 Firebase 控制台中监控每个测试人员的状态——他们是否接受了邀请以及是否下载了应用程序。

测试人员有 30 天的时间接受邀请，在邀请到期前测试该应用。当邀请还有 5 天到期时，Firebase 控制台中发布的测试人员旁边会显示到期通知。可以通过使用测试人员行上的下拉菜单重新发送邀请来续订邀请。

将自己添加为发布的测试人员

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

由于您提供了电子邮件地址，因此您会收到一封来自 Firebase App Distribution 的电子邮件，邀请您测试该应用程序。你现在是第一个测试者！继续下面的部分以在您的测试设备上设置为测试仪。

注册您的测试设备

您需要先注册您的测试设备才能下载和测试 Ad Hoc 版本。

1. 在您的 iOS 测试设备上，打开从 Firebase App Distribution 发送的电子邮件，然后点击开始链接。确保在 Safari 中打开链接。
2. 在出现的Firebase App Distribution测试器网络应用程序中，使用您的 Google 帐户登录并点击接受邀请。

现在，您将看到受邀参加的发布。

3. 点击注册设备以与 Firebase 共享您的 UDID，以便您稍后可以更新应用程序的配置文件。

4. 按照说明进行操作，然后转到设置以下载配置文件并共享您的 UDID。

注意：安装配置文件还会在您的主屏幕上创建一个指向 App Distribution 的链接。

现在，当您返回 App Distribution 时，该版本现在标记为“已注​​册设备”：

注意：如果您过去已经将此设备添加到您的开发者帐户，它可能已经包含在配置文件中，并且您已经在此处看到“下载”按钮。

测试人员的 UDID 现已与开发人员共享。现在由开发人员为测试人员构建新版本的应用程序。

在控制台查看测试人员信息

回到 Firebase 控制台中的开发人员视图，测试人员将在发布下显示为“已接受”：

如果他们使用的设备尚未包含在配置文件中，您也会收到一封电子邮件作为开发人员。这将通知您需要添加的新 UDID。您还可以选择将所有 UDID 导出为文本文件。

1. 要导出所有 UDID，请打开测试人员和组选项卡。

2. 单击“导出 Apple UDID”。

该文件应包含您的测试设备的 UDID。

Device ID            Device Name                            Device Platform
1234567890     [e-mail] - iPhone SE 2nd Gen        ios

注意：当测试人员接受邀请来测试未使用企业配置文件签名的构建时，他们会被要求获得与您共享其设备标识符的权限。如果他们同意，App Distribution 会从设备收集 UDID 并通过电子邮件将 UDID 通知您。

当您收到其中一封电子邮件时，请使用 UDID 更新您的配置文件，并按照以下步骤将新版本分发给您的测试人员：

1. 将设备添加到您的 Apple 开发人员门户。

• 选项 1：将设备 UDID 导入为 CSV 文件。在 App Distribution 仪表板的 Testers & Groups 选项卡中，选择 All testers，然后单击 Export Apple UDIDs 下载 CSV 文件。接下来，使用“注册多个设备”选项将文件导入您的Apple 开发者帐户。请参阅Apple 文档以了解更多信息。请注意，您的 Apple 开发者帐户每年可能只允许导入有限数量的设备。
• 选项 2：通过电子邮件收集并输入 UDID。在 Apple 开发者门户的“添加设备”页面上，注册您收到的电子邮件中指定的新 UDID。

2. 将已注册的设备添加到您的配置文件中。
3. 下载配置文件并使用它来重建您的应用程序。如果您重建只是为了更新已注册的设备，请不要更新内部版本号或版本。
4. 从 Firebase 控制台或 CLI重新分发您的应用程序。如果您已经分发了具有相同内部版本号和版本的内部版本，则只有新注册设备的用户会收到通知电子邮件。

从测试设备下载版本

现在发布有测试设备的UDID，所以测试设备可以下载并安装应用程序。当测试人员的 UDID 添加到新版本时，App Distribution 会向测试人员发送一封电子邮件。

1. 在测试设备上，使用电子邮件中的链接或设备主屏幕上的图标返回 App Distribution 测试器 Web 应用程序。

当您导航到 UDID Codelab 应用程序时，您可以看到该版本已准备好下载。

2. 如果您使用的是物理设备，请按下载，然后安装并运行该应用程序！
3. 当应用程序启动时，它会要求您启用新构建警报。选择“开启”

4. 然后它会要求您登录。单击“继续”。

5. 使用您的测试员帐户登录。

6. 您将被带回应用程序。下次运行该应用程序时，您无需登录或接受提醒。

注意：发布下载仅适用于物理设备。如果您在模拟器上，下载将无法进行，但您仍然可以通过验证 App Distribution Web 客户端上是否显示“下载”按钮来验证设置是否有效。

向您的测试人员分发更新

1. 将您的内部版本号更新为“2”。

2. 选择“Any iOS Device (arm64)”作为构建目标，然后选择 Product->Archive。生成存档后，使用开发分发配置文件构建签名分发。
3. 构建完成后，它会在您指定的文件夹中保存一个 IPA 文件和一些日志文件。在您的 Firebase 控制台中上传这个新的 IPA，再次将您的电子邮件添加为测试人员并分发。

测试构建警报

1. 如果应用程序处于打开状态，请确保关闭它。重新启动应用程序。
2. 当应用程序重新启动时，您应该会收到“新版本可用”警报。

3. 单击“更新”以接收最新版本。
4. 在下一个屏幕上单击“安装”。

5. 恭喜！您可以使用内置警报更新您的应用程序。

6.自定义测试人员登录

signInTester/signOutTester和isTesterSignedIn方法让您可以更灵活地自定义测试人员的登录体验，因此它可以更好地匹配您的应用程序的外观和感觉。

以下示例检查测试人员是否已登录其 Firebase App Distribution 测试人员帐户，因此您可以选择仅对尚未登录的测试人员显示您的登录 UI。测试人员登录后，您可以随后调用checkForUpdate以检查测试人员是否有权访问新构建。

让我们通过注释掉checkForUpdate()调用来禁用在viewDidAppear中自动检查更新。

AppDistributionViewController.swift

 override func viewDidAppear(_ animated: Bool) {
    // checkForUpdate()
 }

相反，让我们在checkForUpdateButtonClicked( ) 中调用 checkForUpdate( )。

 @objc func checkForUpdateButtonClicked() {
    checkForUpdate()
 }

现在，让我们实现我们的signInOutButtonClicked()方法，如果用户已注销，该方法将登录用户，如果用户已经登录，则将用户注销。

AppDistributionViewController.swift

 @objc func signInOutButtonClicked() {
    if isTesterSignedIn() {
      AppDistribution.appDistribution().signOutTester()

      self.configureCheckForUpdateButton()
      self.configureSignInSignOutButton()
      self.configureSignInStatus()

    } else {
      AppDistribution.appDistribution().signInTester(completion: { error in
        if error == nil {
          self.configureCheckForUpdateButton()
          self.configureSignInSignOutButton()
          self.configureSignInStatus()
        } else {
          let uiAlert = UIAlertController(title: "Custom:Error", message: "Error during tester sign in! \(error?.localizedDescription ?? "")", preferredStyle: .alert)
          uiAlert.addAction(UIAlertAction(title: "Ok", style: UIAlertAction.Style.default) {
            _ in
          })

          self.present(uiAlert, animated: true, completion: nil)
        }
      })
    }
  }

最后让我们实现isTesterSignedI n 方法。

AppDistributionViewController.swift

 private func isTesterSignedIn() -> Bool {
    return AppDistribution.appDistribution().isTesterSignedIn
 }

构建并测试您的实施

7. 恭喜！

您已使用 Firebase App Distribution iOS SDK 将“应用内提醒显示”功能构建到应用中。

我们涵盖的内容

• Firebase 应用分发
• Firebase 应用分发新警报 iOS SDK

下一步

• 使用快车道插件
• 使用 CLI 工具

了解更多

• Firebase.google.com
• Twitter 如何使用新的 iOS SDK

有一个问题？

• Stackoverflow 'firebase-app-distribution '
• Firebase 社区松弛频道#app-distribution

报告问题

• Github 问题