开始使用 iOS 扩展

重要

Visual Studio App Center 于 2025 年 3 月 31 日停用,但分析和诊断功能除外,这些功能将继续受支持,直到 2026 年 6 月 30 日。 了解详细信息

应用程序扩展仅支持崩溃报告。

若要了解如何将 App Center SDK 添加到容器应用,请参阅 App Center iOS 入门文档。

现在让我们开始在您的应用扩展中设置 App Center iOS SDK,以便使用 App Center 崩溃分析。

1.先决条件

若要使用 App Center SDK,必须满足以下要求:

  • iOS 项目是在 macOS 版本 10.14.4 或更高版本上的 Xcode 13 或更高版本中设置的。
  • 你的目标是在 ios 11.0 或更高版本上运行的设备。
  • 你未使用提供崩溃报告功能的任何其他库。

2.在 App Center 门户中创建应用以获取应用机密

如果已在 App Center 门户中创建了应用,则可以跳过此步骤。

  1. 前往 appcenter.ms
  2. 注册或登录并点击门户右上角的蓝色按钮,显示 “添加新 ”,并从下拉菜单中选择“ 添加新应用 ”。
  3. 输入应用的名称和可选说明。
  4. 选择 iOS 作为 OS, 将 Objective-C/Swift 选为平台。
  5. 点击右下角的按钮,显示 “添加新应用”。

创建应用后,可以在 App Center 门户的“设置”页上获取其应用机密。 在 “设置” 页的右上角,单击 三个垂直点 并选择 Copy app secret 获取应用机密。

注释

使用另一个 iOS 项目中的现有应用机密会产生副作用。 App Center 不支持在同一 App Center 应用程序中按项目进行筛选。 例如,列出特定版本的崩溃将列出此版本这两个项目的所有崩溃,而不区分。 这很令人困惑。

注释

4.0.0 版本中引入了 App Center 的重大变更。 请按照“迁移到 App Center SDK 4.0.0 及更高”部分的指引,将 App Center 从之前的版本迁移。

3.添加 App Center SDK 模块

App Center SDK 可以通过 CocoapodsCarthage 或手动将二进制文件添加到项目中来集成到应用中。

3.1 通过 Cocoapods 集成

  1. 将以下依赖项添加到你的项目 podfile 中,以包括 App Center Crashes 模块。 这会引入以下框架:AppCenterAppCenterCrashes

     pod 'AppCenter/Crashes'
    
  2. 运行 pod install 以安装新定义的 Pod 并打开项目的 .xcworkspace

注释

如果在运行 [!] Unable to find a specification for `AppCenter` 时看到诸如 pod install 的错误,请运行 pod repo update 从 Cocoapods 存储库中获取最新的 Pod,然后运行 pod install

现在,你已将框架集成到应用程序中,接下来可以启动 SDK 并使用 App Center 服务。

3.2 通过 Carthage 集成

下面是有关如何使用 Carthage 版本 0.30 或更高版本在 Xcode 项目中集成 App Center SDK 的步骤,这是一个分散的依赖项管理器,用于生成依赖项并提供二进制框架。

  1. 将以下依赖项添加到应用中 Cartfile 以将 App Center 包含在应用中。 这将导入所有框架。 然后,只能链接这些框架以在应用中使用。

    # Use the following line to get the latest version of App Center
    github "microsoft/appcenter-sdk-apple"
    
    # Use the following line to get the specific version of App Center
    github "microsoft/appcenter-sdk-apple" ~> X.X.X
    
  2. 运行 carthage update。 这会将依赖项提取到 Carthage/Checkouts 文件夹中,然后生成每个框架。

  3. 打开应用程序目标的 “常规 设置”选项卡。将 AppCenter.frameworkAppCenterCrashes.framework 文件从 Carthage/Build/ 文件夹中拖放到 Xcode 的项目导航器中。 启动 SDK 需要 AppCenter.framework 。 如果未将它添加到项目,其他模块将不起作用,并且你的应用不会编译。

  4. 对话框将出现,确保你的应用目标被选中。 然后单击“完成”。

    注释

    如果在生成阶段使用 carthage copy-frameworks ,则不应在 生成阶段 添加 App Center SDK,因为它们作为静态框架提供。

现在,你已将框架集成到应用程序中,接下来可以启动 SDK 并使用 App Center 服务。

3.3 通过 Swift 包管理器集成

  1. 在 Xcode 菜单中,单击“ 文件 > Swift 包 > 添加包依赖项”。
  2. 在出现的对话框中,输入存储库 URL: https://github.com/microsoft/appcenter-sdk-apple.git
  3. “版本”中,选择 “升级到下一个主要版本”,并采用默认选项。
  4. “程序包产品 ”列中选择所需的模块。

现在,你已将框架集成到应用程序中,接下来可以启动 SDK 并使用 App Center 服务。

注释

如果要通过 SwiftPM 集成 App Center,并且想要在应用的扩展目标中使用它,请确保在配置中提供 DISABLE_DIAMOND_PROBLEM_DIAGNOSTIC=YES 。 为了避免 SwiftPM 在将模块链接到多个目标时的限制,这个步骤是必要的。

3.4 通过将二进制文件复制到项目中进行集成

下面介绍了如何在 Xcode 项目中集成已编译的二进制文件,为你的应用扩展设置 App Center 崩溃服务。

注释

App Center SDK 支持使用 XCframework。 如果要将 XCframeworks 集成到项目中,请从发布页下载 AppCenter-SDK-Apple-XCFramework.zip 并将其解压缩。 生成的文件夹内容并不特定于任何平台,而是包含每个模块的XC框架。 这些框架可以像往常一样进行集成,具体如下所示。

  1. 下载以 zip 文件的形式提供的 App Center SDK 框架。

  2. 解压缩文件,你将看到一个名为 AppCenter-SDK-Apple 的文件夹,其中包含每个平台文件夹中每个 App Center 服务的不同框架。 项目中需要调用 AppCenter 的框架,因为它包含在不同模块之间共享的代码。

  3. [可选]为第三方库创建子目录。

    • 最佳做法是,第三方库通常位于一个名为 Vendor 的子目录中。 如果项目未使用库的子目录进行组织,请立即创建 供应商 子目录。
    • 在 Xcode 项目中创建一个名为 Vendor 的组,以模拟磁盘上的文件结构。
  4. 在 Finder 中打开解压缩的 AppCenter-SDK-Apple 文件夹,并将该文件夹复制到项目的文件夹,位于所需位置。 该文件夹包含 App Center SDK 支持的其他平台的子文件夹中的框架,因此可能需要删除不需要的子文件夹。

  5. 将 SDK 框架添加到 Xcode 中的项目:

    • 确保项目导航器可见(⌘+1)。
    • 现在,将 Finder(在上一步的位置)中的 AppCenter.frameworkAppCenterCrashes.framework 拖放到 Xcode 的项目导航器中。 启动 SDK 需要 AppCenter.framework 。 如果未将其添加到项目,则其他模块将不起作用,并且你的应用扩展不会编译。
    • 将出现一个对话框,请确保选中应用扩展的目标。 然后单击“完成”。

现在,你已将框架集成到应用扩展中,接下来可以启动 SDK 并使用 App Center 服务。

4.启动 SDK

您必须选择加入要使用的模块才能使用 App Center。 默认情况下,不会启动任何模块,并且必须在启动 SDK 时显式调用每个模块。

4.1 添加导入语句

在包含应用扩展入口点的文件中插入以下行。 例如,在 Today 扩展名的主 ViewController 文件中。

@import AppCenter;
@import AppCenterCrashes;
import AppCenter
import AppCenterCrashes

4.2 添加 start:withServices: 方法

在应用扩展的入口点中插入以下行。 例如,在今日扩展的主 ViewController 文件的 viewDidLoad 方法中。

[MSACAppCenter start:@"{Your App Secret}" withServices:@[[MSACCrashes class]]];
AppCenter.start(withAppSecret: "{Your App Secret}", services: [Crashes.self])

目前,应用程序扩展仅支持崩溃报告。

4.3 将占位符替换为应用机密

请确保将 {Your App Secret} 文本替换为应用程序扩展的实际值。 可以在 App Center 门户的 “入门 ”页面或 “设置” 页上找到应用机密。

“入门”页包含上述代码示例,其中包含应用机密,可以复制粘贴整个示例。

很好,你已经准备好在门户中可视化由 SDK 自动收集的崩溃数据。

查看 App Center 崩溃 的文档,了解如何自定义应用扩展并使用更高级的功能。