iOS 入门

App Center SDK 使用模块化体系结构，因此你可以使用任何或所有服务。

可以在 App Center SDK 收集的数据、 常规数据保护条例和 常见问题解答 页中找到有关 App Center 收集的数据的信息。 此外， 常见问题解答 包含需要为 App Store 隐私配置提供的答案。

让我们开始设置您的应用，以集成 App Center iOS SDK，从而使用 App Center Analytics 和 App Center 崩溃功能。 若要将 App Center Distribute 添加到应用，请查看 App Center Distribute 的文档。

1.先决条件

若要使用 App Center SDK，必须满足以下要求：

• iOS 项目是在 macOS 版本 10.14.4 或更高版本上的 Xcode 13 或更高版本中设置的。
• 你的目标是在 ios 11.0 或更高版本上运行的设备。
• 你未使用提供崩溃报告功能的任何其他库（仅适用于 App Center 崩溃）。
• 如果使用 CocoaPods 集成 App Center，则需要 CocoaPods 1.10 或更高版本。

App Center SDK 分析和崩溃报告可以通过 XCFramework 或 SwiftPM 兼容于 Mac Catalyst。

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

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

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

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

3.添加 App Center SDK 模块

可以通过 Cocoapods、 Carthage、 Swift 包管理器或手动将二进制文件添加到项目中，将适用于 iOS 的 App Center SDK 添加到应用。

3.1 通过 Cocoapods 集成

1. 将以下依赖项添加到你的 podfile 中，以将 App Center Analytics 和 App Center 崩溃报告功能添加到应用中。 此操作将导入以下框架：AppCenter、AppCenterAnalytics和AppCenterCrashes。 相反，可以在应用中指定所需的服务。 每个服务都有自己的子项，它们都依赖于 AppCenter。 它将自动导入。

    # Use the following line to use App Center Analytics and Crashes.x
    pod 'AppCenter'
   
    # Use the following lines if you want to specify which service you want to use.
    pod 'AppCenter/Analytics'
    pod 'AppCenter/Crashes'
    pod 'AppCenter/Distribute'
   

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

现在，你已将框架集成到应用程序中，接下来可以启动 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.framework、 AppCenterAnalytics.framework 和 AppCenterCrashes.framework 文件从 Carthage/Build/iOS 文件夹拖放到 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 服务。

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

下面介绍了如何在 Xcode 项目中集成已编译的二进制文件，为 iOS 应用设置 App Center Analytics 和 App Center 崩溃。

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）。
   • 现在，将 AppCenter.framework、 AppCenterAnalytics.framework 和 AppCenterCrashes.framework 从 Finder（在上一步的位置）拖放到 Xcode 的项目导航器中。 启动 SDK 需要 AppCenter.framework 。 如果未将它添加到项目，其他模块将不起作用，并且你的应用不会编译。
   • 对话框将出现，确保你的应用目标被选中。 然后单击“完成”。

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

4.启动 SDK

若要使用 App Center，请选择加入要使用的模块。 默认情况下，不会启动任何模块，并且必须在启动 SDK 时调用每个模块。

根据所使用的生命周期，下面的说明略有不同。 从 Xcode 12 开始，可以选择以下两个生命周期之一：“Swift UI 应用”（默认情况下在 Xcode 12 中选择）和“UI 工具包 AppDelegate”。 如果要为扩展进行开发，请参阅 扩展入门页。

4.1 添加导入语句

打开项目的 AppDelegate 文件（适用于 UI Kit AppDelegate 生命周期）或 <ProjectName>App.swift 文件（适用于 Swift UI 应用生命周期），并添加以下导入语句：

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

import AppCenter
import AppCenterAnalytics
import AppCenterCrashes

4.2 添加 start:withServices: 方法

UI 工具包 AppDelegate

将初始化代码添加到 didFinishLaunchingWithOptions 委托方法中：

[MSACAppCenter start:@"{Your App Secret}" withServices:@[[MSACAnalytics class], [MSACCrashes class]]];

AppCenter.start(withAppSecret: "{Your App Secret}", services: [Analytics.self, Crashes.self])

Swift UI 应用生命周期

若要确保 App Center SDK 使用 Swift UI 正常工作，请在加载 UI 后对其进行初始化。 实现此目的的最简单方法是使用 UIApplicationDelegate：

class AppDelegate: NSObject, UIApplicationDelegate {
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
          AppCenter.start(withAppSecret: "{Your App Secret}", services:[
            Crashes.self, Analytics.self, Distribute.self])
        return true
    }
}

然后，在以下环境中UIApplicationDelegateAdaptor使用struct：

@main
struct YourAppName: App {

  @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

如果有 Catalyst 应用程序，可以同时传递 iOS 和 macOS 的应用机密：

AppCenter.start(withAppSecret:"ios={Your iOS App Secret};macos={Your macOS App Secret}", services: [Analytics.self, Crashes.self])

如果需要单独启动 App Center 服务，应：

1. 配置或启动应用密钥。
2. 如果可以多次调用代码，请检查是否已配置 App Center。
3. 在不使用应用机密的情况下启动所需的服务。

[MSACAppCenter configureWithAppSecret:@"{Your App Secret}"];
if ([MSACAppCenter isConfigured]) {
   [MSACAppCenter startService:[MSACAnalytics class]];
   [MSACAppCenter startService:[MSACCrashes class]];
}

AppCenter.configure(withAppSecret: "{Your App Secret}")
if AppCenter.isConfigured {
    AppCenter.startService(Analytics.self)
    AppCenter.startService(Crashes.self)
}

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

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

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

上述示例展示了如何使用 start:withServices 方法（Swift 中为 start(withAppSecret:services:)），并包含 App Center Analytics 和 App Center 崩溃。

如果不想使用这两个服务之一，请从上述方法调用中删除相应的参数。

除非在 start 方法中显式指定每个模块作为参数，否则不能使用该 App Center 服务。 此外， start:withServices （start(withAppSecret:services:) for Swift）API 只能在应用的生命周期中使用一次– 所有其他调用都会将警告记录到控制台，并且只有第一次调用中包含的模块可用。

例如 - 如果要加入 App Center Analytics，应按如下所示修改 start:withServices （start(withAppSecret:services:) for Swift） API 调用：

[MSACAppCenter start:@"{Your App Secret}" withServices:@[[MSACAnalytics class]]];

AppCenter.start(withAppSecret: "{Your App Secret}", services: [Analytics.self])

很好，你已经准备好在门户上可视化由 SDK 自动收集的分析和崩溃数据。

查看 App Center Analytics 文档 和 App Center 崩溃文档 ，了解如何自定义和使用这两个服务的更高级功能。

若要了解如何开始使用应用内更新，请阅读 App Center Distribute 的文档。