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

1. 概览

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

学习内容

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

您需要满足的条件

• Xcode 12（或更高版本）
• CocoaPods 1.9.1（或更高版本）
• 用于临时发布的 Apple 开发者账号
• 一台用于测试的 iOS 实体设备。（iOS 模拟器应用适用于大多数 Codelab，但模拟器无法下载版本。）

您打算如何使用本教程？

仅阅读教程内容 阅读并完成练习

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

新手 中等 熟练

2. 创建 Firebase 控制台项目

添加新的 Firebase 项目

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

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

3. 点击 Create project。

将应用添加到 Firebase

按照相关文档中的说明在 Firebase 中注册您的应用。使用“com.google.firebase.codelab.AppDistribution.<your_name>”作为 iOS 软件包 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 中：

Podfile

pod 'Firebase/AppDistribution'

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

pod install --repo-update
xed .

更新软件包标识符以与您的 Firebase 应用保持一致

在左侧菜单中，双击 AppDistributionExample。然后，找到常规标签页，并将软件包标识符更改为与 Firebase 应用的软件包标识符（可在项目设置中找到）一致。它应该是“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 设置有关新 build 的应用内提醒

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

配置应用内提醒

App Distribution SDK 提供了两种为测试人员设置应用内构建提醒的方法：基本提醒配置（提供向测试人员显示的预建登录对话框）和高级提醒配置（可让您自定义自己的界面 (UI)）。

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

1. 检查测试人员是否已启用提醒。否则，系统会显示一个预构建的对话框，提示他们使用 Google 账号登录 App Distribution。

只需在测试设备上启用提醒一次，即可在应用更新期间持续启用。在测试设备上，提醒保持启用状态，直到应用被卸载或 signOutTester 方法被调用为止。如需了解详情，请参阅该方法的参考文档（Swift 或 Objective-C）。

2. 检查是否有新推出的 build 可供测试人员安装。返回 release 对象或 error。

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

在 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 控制台将 build 分发给测试人员，以构建应用并测试您的实现。

构建应用

当您准备好将应用的预发布版本分发给测试人员时，请选择“任何 iOS 设备 (arm64)”作为 build 目标，然后依次选择“Product”->“Archive”。创建归档文件后，使用“开发”分发配置文件构建已签名分发文件。

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

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

将应用分发给测试人员

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

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

3. 在“版本”页面上，从下拉菜单中选择您要分发的应用。

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

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

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

之前未受邀测试应用的测试人员会收到邀请其开始测试的电子邮件，现有测试人员则会收到新 build 已可供测试的电子邮件通知（如需了解如何安装测试应用，请参阅测试人员设置指南）。您可以在 Firebase 控制台中监控每个测试人员的状态：他们是否接受了邀请以及是否下载了应用。

在邀请到期前，测试人员有 30 天的时间来接受测试应用的邀请。当邀请距离过期还有 5 天的时候，Firebase 控制台会在相应版本的测试人员旁边显示过期通知。您可以使用测试人员行中的下拉菜单重新发送邀请，从而重新发送邀请。

将您自己添加为此版本的测试人员

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

由于您添加了自己的电子邮件地址，因此会收到 Firebase App Distribution 邀请您测试该应用的电子邮件。您现在是首位测试人员了！继续下一部分，在测试设备上设置为测试人员。

注册测试设备

您需要先注册测试设备，才能下载并测试临时版本。

1. 在您的 iOS 测试设备上，打开 Firebase App Distribution 发送的电子邮件，然后点按“开始使用”链接。请务必在 Safari 中打开链接。
2. 在随即显示的 Firebase App Distribution 测试人员 Web 应用中，使用您的 Google 账号登录，然后点按接受邀请。

现在，您会看到受邀加入的版本。

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

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

注意：安装该配置文件后，系统还会在您的主屏幕上创建指向 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

注意：当测试人员接受邀请来测试尚未使用企业配置文件签名的 build 时，系统会询问他们是否同意将其设备的标识符提供给您。如果他们同意，App Distribution 会收集该设备的 UDID，并通过电子邮件通知您该 UDID。

当您收到这样的电子邮件时，请使用该 UDID 更新您的预配配置文件，然后按照以下步骤将新的 build 分发给测试人员：

1. 将设备添加到您的 Apple Developer 门户。

• 方案 1：以 CSV 文件形式导入设备 UDID。在 App Distribution 信息中心的“测试人员和群组”标签页中，选择“所有测试人员”，然后点击“导出 Apple UDID”以下载 CSV 文件。接下来，使用“注册多台设备”选项将该文件导入您的 Apple 开发者账号。如需了解详情，请参阅 Apple 文档。请注意，您的 Apple 开发者账号可能每年只允许您导入一定数量的设备。
• 选项 2：收集 UDID 并通过电子邮件输入。在 Apple Developer 门户的 Add Devices 页面中，注册您收到的电子邮件中指定的新 UDID。

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

从测试设备下载版本

现在，该版本包含测试设备的 UDID，因此测试设备可以下载并安装该应用。当测试人员的 UDID 添加到新版本时，App Distribution 会向他们发送一封电子邮件。

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

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

2. 如果您使用的是实体设备，请按下载，然后安装并运行应用！
3. 当应用启动时，它会要求您启用新的构建提醒。选择“开启”

4. 然后，系统会要求您登录。点击“继续”。

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

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

注意：版本下载功能仅适用于实体设备。如果您使用的是模拟器，下载将无法进行，但您仍然可以通过验证“下载”按钮。

向测试人员分发更新

1. 将您的 build 号更新为“2”。

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

测试 build 提醒

1. 请确保关闭该应用（如果已打开）。重启应用。
2. 当应用重启时，您应该会收到“有新版本可用”的消息提醒。

3. 点击“更新”以获取最新版本。
4. 在下一个屏幕上，点击“安装”。

5. 恭喜！您可以通过内置提醒更新应用。

6. 自定义测试人员登录

signInTester/signOutTester 和 isTesterSignedIn 方法可让您更灵活地自定义测试人员的登录体验，因此可以与应用的外观更相符。

以下示例会检查测试人员是否已登录其 Firebase App Distribution 测试人员账号，因此您可以选择仅向尚未登录的测试人员显示登录界面。测试人员登录后，您可以调用 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)
        }
      })
    }
  }

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

AppDistributionViewController.swift

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

构建和测试您的实现

7. 恭喜！

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

所学内容

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

后续步骤

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

了解详情

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

有疑问？

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

报告问题

• GitHub 问题