先决条件
安装以下内容:
- Xcode 13.3.1 或更高版本
确保您的项目满足以下要求:
- 您的项目必须针对这些平台版本或更高版本:
- iOS 11
- macOS 10.13
- 电视操作系统 12
- watchOS 6
- 您的项目必须针对这些平台版本或更高版本:
设置物理 Apple 设备或使用模拟器来运行您的应用程序。
对于 Apple 平台上的云消息传递,先决条件如下:
- 设置物理 Apple 设备。
- 为您的Apple Developer 帐户获取 Apple Push Notification Authentication Key。
- 在App > Capabilities下的 Xcode 中启用推送通知。
- 使用您的 Google 帐户登录 Firebase 。
如果您还没有 Xcode 项目并且只想试用 Firebase 产品,您可以下载我们的快速入门示例之一。
第 1 步:创建一个 Firebase 项目
在将 Firebase 添加到您的 Apple 应用程序之前,您需要创建一个 Firebase 项目以连接到您的应用程序。访问了解 Firebase 项目以了解有关 Firebase 项目的更多信息。
第 2 步:向 Firebase 注册您的应用
要在您的 Apple 应用程序中使用 Firebase,您需要在 Firebase 项目中注册您的应用程序。注册您的应用程序通常称为将您的应用程序“添加”到您的项目中。
转到Firebase 控制台。
在项目概览页面的中央,单击iOS+图标以启动设置工作流程。
如果您已将应用程序添加到 Firebase 项目,请单击添加应用程序以显示平台选项。
在bundle ID字段中输入您应用程序的 bundle ID。
捆绑包 ID唯一标识 Apple 生态系统中的应用程序。
查找您的包 ID:在 Xcode 中打开您的项目,在项目导航器中选择顶级应用程序,然后选择常规选项卡。
Bundle Identifier字段的值是包 ID(例如,
com.yourcompany.yourproject
)。请注意,bundle ID 值区分大小写,在您的 Firebase 项目中注册后,无法更改此 Firebase 应用程序的值。
(可选)输入其他应用信息:应用昵称和App Store ID 。
应用昵称:仅在 Firebase 控制台中对您可见的内部便利标识符
App Store ID :由 Firebase 动态链接用于将用户重定向到您的 App Store 页面,由 Google Analytics 用于将转换事件导入 Google Ads 。如果您的应用还没有 App Store ID,您可以稍后在项目设置中添加 ID。
单击注册应用程序。
第 3 步:添加 Firebase 配置文件
单击下载 GoogleService-Info.plist以获取您的 Firebase Apple 平台配置文件 (
GoogleService-Info.plist
)。Firebase 配置文件包含项目的唯一但非机密标识符。要了解有关此配置文件的更多信息,请访问了解 Firebase 项目。
您可以随时再次下载您的Firebase 配置文件。
确保配置文件名未附加其他字符,例如
(2)
。
将配置文件移动到 Xcode 项目的根目录中。如果出现提示,请选择将配置文件添加到所有目标。
如果您的项目中有多个 bundle ID,则必须将每个 bundle ID 与 Firebase 控制台中注册的应用相关联,以便每个应用都可以拥有自己的GoogleService-Info.plist
文件。
第 4 步:将 Firebase SDK 添加到您的应用
使用 Swift Package Manager 安装和管理 Firebase 依赖项。
- 在 Xcode 中,打开您的应用程序项目,导航至File > Add Packages 。
- 出现提示时,添加 Firebase Apple 平台 SDK 存储库:
- 选择您要使用的 SDK 版本。
选择您要使用的 Firebase 库。
如果在您的 Firebase 项目中启用了 Google Analytics,请确保添加
FirebaseAnalytics
。对于没有 IDFA 收集功能的 Analytics,请改为添加FirebaseAnalyticsWithoutAdId
。
https://github.com/firebase/firebase-ios-sdk
完成后,Xcode 将自动开始在后台解析和下载您的依赖项。
第 5 步:在您的应用中初始化 Firebase
最后一步是将初始化代码添加到您的应用程序中。作为将 Firebase 添加到您的应用程序的一部分,您可能已经完成了此操作。如果您使用的是快速入门示例项目,这已经为您完成了。
- 在您的
UIApplicationDelegate
中导入FirebaseCore
模块,以及您的应用委托使用的任何其他Firebase 模块。例如,要使用 Cloud Firestore 和身份验证:斯威夫特用户界面
import SwiftUI import FirebaseCore import FirebaseFirestore import FirebaseAuth // ...
迅速
import FirebaseCore import FirebaseFirestore import FirebaseAuth // ...
目标-C
@import FirebaseCore; @import FirebaseFirestore; @import FirebaseAuth; // ...
- 在您的应用委托的
application(_:didFinishLaunchingWithOptions:)
方法中配置一个FirebaseApp
共享实例:斯威夫特用户界面
// Use Firebase library to configure APIs FirebaseApp.configure()
迅速
// Use Firebase library to configure APIs FirebaseApp.configure()
目标-C
// Use Firebase library to configure APIs [FIRApp configure];
- 如果您使用的是 SwiftUI,则必须创建一个应用程序委托并通过
UIApplicationDelegateAdaptor
或NSApplicationDelegateAdaptor
将其附加到您的App
结构。您还必须禁用应用委托调配。有关详细信息,请参阅SwiftUI 说明。斯威夫特用户界面
@main struct YourApp: App { // register app delegate for Firebase setup @UIApplicationDelegateAdaptor(AppDelegate.self) var delegate var body: some Scene { WindowGroup { NavigationView { ContentView() } } } }
- 如果您已包含适用于 Google Analytics 的 Firebase SDK,则可以运行您的应用程序以向 Firebase 控制台发送验证,表明您已成功安装 Firebase。
就是这样!您可以跳到下一步。
不过,如果您在设置时遇到问题,请访问Apple 平台故障排除和常见问题解答。
可用库
本部分列出了 Apple 平台支持的 Firebase 产品。详细了解这些 Firebase Apple 平台库:
Firebase Apple 平台 SDK GitHub 存储库
服务或产品 | 豆荚 | SwiftPM 库 | 添加分析? |
---|---|---|---|
AdMob | pod 'Google-Mobile-Ads-SDK' | 不适用 | |
分析 | pod 'FirebaseAnalytics' | FirebaseAnalytics | |
应用检查 | pod 'FirebaseAppCheck' | FirebaseAppCheck | |
应用分发 | pod 'FirebaseAppDistribution' | FirebaseAppDistribution | |
验证 | pod 'FirebaseAuth' | FirebaseAuth | |
云端 Firestore | pod 'FirebaseFirestore' | FirebaseFirestore | |
Firebase 客户端 SDK 的云函数 | pod 'FirebaseFunctions' | FirebaseFunctions | |
云消息 | pod 'FirebaseMessaging' | FirebaseMessaging | |
云储存 | pod 'FirebaseStorage' | FirebaseStorage | |
崩溃分析 | pod 'FirebaseCrashlytics' | FirebaseCrashlytics | |
动态链接 | pod 'FirebaseDynamicLinks' | FirebaseDynamicLinks | |
应用内消息 | pod 'FirebaseInAppMessaging' | FirebaseInAppMessaging | (必需的) |
Firebase 安装 | pod 'FirebaseInstallations' | FirebaseInstallations | |
Firebase ML 自定义模型 API | pod 'FirebaseMLModelDownloader' | FirebaseMLModelDownloader | |
性能监控 | pod 'FirebasePerformance' | FirebasePerformance | |
实时数据库 | pod 'FirebaseDatabase' | FirebaseDatabase | |
远程配置 | pod 'FirebaseRemoteConfig' | FirebaseRemoteConfig |
不使用 Swift 包管理器进行集成
如果您不想使用 Swift Package Manager,您仍然可以通过使用 CocoaPods 或直接导入框架来利用 Firebase SDK。
可可豆
在我们的指南中了解有关 CocoaPods 集成的更多信息。
构架
除了支持 iOS 平台外,该 zip 现在还包含.xcframework
文件。有关详细信息,请参阅GitHub 上的 Firebase Apple 平台 SDK 自述文件。
下载框架 SDK zip 。这是一个约 200MB 的文件,下载可能需要一些时间。
解压缩文件,然后查看您要包含在应用程序中的框架的
README
文件。在目标构建设置的
Other Linker Settings
中-ObjC
链接器标志。
下一步
了解 Firebase:
访问了解 Firebase 项目以了解有关 Firebase 项目和项目最佳实践的更多信息。
亲身体验Firebase iOS Codelab 。
准备启动您的应用程序:
- 在 Google Cloud Console 中为您的项目设置预算提醒。
- 监控 Firebase 控制台中的使用情况和计费仪表板,以全面了解您的项目在多个 Firebase 服务中的使用情况。
- 查看Firebase 启动清单。
在使用 Firebase 和您的 Apple 项目时遇到问题?访问Apple 平台故障排除和常见问题解答。
将 Firebase 服务添加到您的应用:
使用Analytics深入了解用户行为。
使用 Authentication 设置用户身份验证。
使用Cloud Firestore或实时数据库存储用户信息等数据。
使用Cloud Storage 存储照片和视频等文件。
使用Cloud Functions触发在安全环境中运行的后端代码。
使用Cloud Messaging发送通知。
使用Crashlytics了解您的应用崩溃的时间和原因。
先决条件
安装以下内容:
- Xcode 13.3.1 或更高版本
确保您的项目满足以下要求:
- 您的项目必须针对这些平台版本或更高版本:
- iOS 11
- macOS 10.13
- 电视操作系统 12
- watchOS 6
- 您的项目必须针对这些平台版本或更高版本:
设置物理 Apple 设备或使用模拟器来运行您的应用程序。
对于 Apple 平台上的云消息传递,先决条件如下:
- 设置物理 Apple 设备。
- 为您的Apple Developer 帐户获取 Apple Push Notification Authentication Key。
- 在App > Capabilities下的 Xcode 中启用推送通知。
- 使用您的 Google 帐户登录 Firebase 。
如果您还没有 Xcode 项目并且只想试用 Firebase 产品,您可以下载我们的快速入门示例之一。
第 1 步:创建一个 Firebase 项目
在将 Firebase 添加到您的 Apple 应用程序之前,您需要创建一个 Firebase 项目以连接到您的应用程序。访问了解 Firebase 项目以了解有关 Firebase 项目的更多信息。
第 2 步:向 Firebase 注册您的应用
要在您的 Apple 应用程序中使用 Firebase,您需要在 Firebase 项目中注册您的应用程序。注册您的应用程序通常称为将您的应用程序“添加”到您的项目中。
转到Firebase 控制台。
在项目概览页面的中央,单击iOS+图标以启动设置工作流。
如果您已将应用程序添加到 Firebase 项目,请单击添加应用程序以显示平台选项。
在bundle ID字段中输入您应用程序的 bundle ID。
捆绑包 ID唯一标识 Apple 生态系统中的应用程序。
查找您的包 ID:在 Xcode 中打开您的项目,在项目导航器中选择顶级应用程序,然后选择常规选项卡。
Bundle Identifier字段的值是包 ID(例如,
com.yourcompany.yourproject
)。请注意,bundle ID 值区分大小写,在您的 Firebase 项目中注册后,无法更改此 Firebase 应用程序的值。
(可选)输入其他应用信息:应用昵称和App Store ID 。
应用昵称:仅在 Firebase 控制台中对您可见的内部便利标识符
App Store ID :由 Firebase 动态链接用于将用户重定向到您的 App Store 页面,由 Google Analytics 用于将转换事件导入 Google Ads 。如果您的应用还没有 App Store ID,您可以稍后在项目设置中添加 ID。
单击注册应用程序。
第 3 步:添加 Firebase 配置文件
单击下载 GoogleService-Info.plist以获取您的 Firebase Apple 平台配置文件 (
GoogleService-Info.plist
)。Firebase 配置文件包含项目的唯一但非机密标识符。要了解有关此配置文件的更多信息,请访问了解 Firebase 项目。
您可以随时再次下载您的Firebase 配置文件。
确保配置文件名未附加其他字符,例如
(2)
。
将配置文件移动到 Xcode 项目的根目录中。如果出现提示,请选择将配置文件添加到所有目标。
如果您的项目中有多个 bundle ID,则必须将每个 bundle ID 与 Firebase 控制台中注册的应用相关联,以便每个应用都可以拥有自己的GoogleService-Info.plist
文件。
第 4 步:将 Firebase SDK 添加到您的应用
使用 Swift Package Manager 安装和管理 Firebase 依赖项。
- 在 Xcode 中,打开您的应用程序项目,导航至File > Add Packages 。
- 出现提示时,添加 Firebase Apple 平台 SDK 存储库:
- 选择您要使用的 SDK 版本。
选择您要使用的 Firebase 库。
如果在您的 Firebase 项目中启用了 Google Analytics,请确保添加
FirebaseAnalytics
。对于没有 IDFA 收集功能的 Analytics,请改为添加FirebaseAnalyticsWithoutAdId
。
https://github.com/firebase/firebase-ios-sdk
完成后,Xcode 将自动开始在后台解析和下载您的依赖项。
第 5 步:在您的应用中初始化 Firebase
最后一步是将初始化代码添加到您的应用程序中。作为将 Firebase 添加到您的应用程序的一部分,您可能已经完成了此操作。如果您使用的是快速入门示例项目,这已经为您完成了。
- 在您的
UIApplicationDelegate
中导入FirebaseCore
模块,以及您的应用委托使用的任何其他Firebase 模块。例如,要使用 Cloud Firestore 和身份验证:斯威夫特用户界面
import SwiftUI import FirebaseCore import FirebaseFirestore import FirebaseAuth // ...
迅速
import FirebaseCore import FirebaseFirestore import FirebaseAuth // ...
目标-C
@import FirebaseCore; @import FirebaseFirestore; @import FirebaseAuth; // ...
- 在您的应用委托的
application(_:didFinishLaunchingWithOptions:)
方法中配置一个FirebaseApp
共享实例:斯威夫特用户界面
// Use Firebase library to configure APIs FirebaseApp.configure()
迅速
// Use Firebase library to configure APIs FirebaseApp.configure()
目标-C
// Use Firebase library to configure APIs [FIRApp configure];
- 如果您使用的是 SwiftUI,则必须创建一个应用程序委托并通过
UIApplicationDelegateAdaptor
或NSApplicationDelegateAdaptor
将其附加到您的App
结构。您还必须禁用应用委托调配。有关详细信息,请参阅SwiftUI 说明。斯威夫特用户界面
@main struct YourApp: App { // register app delegate for Firebase setup @UIApplicationDelegateAdaptor(AppDelegate.self) var delegate var body: some Scene { WindowGroup { NavigationView { ContentView() } } } }
- 如果您已包含适用于 Google Analytics 的 Firebase SDK,则可以运行您的应用程序以向 Firebase 控制台发送验证,表明您已成功安装 Firebase。
就是这样!您可以跳到下一步。
不过,如果您在设置时遇到问题,请访问Apple 平台故障排除和常见问题解答。
可用库
本部分列出了 Apple 平台支持的 Firebase 产品。详细了解这些 Firebase Apple 平台库:
Firebase Apple 平台 SDK GitHub 存储库
服务或产品 | 豆荚 | SwiftPM 库 | 添加分析? |
---|---|---|---|
AdMob | pod 'Google-Mobile-Ads-SDK' | 不适用 | |
分析 | pod 'FirebaseAnalytics' | FirebaseAnalytics | |
应用检查 | pod 'FirebaseAppCheck' | FirebaseAppCheck | |
应用分发 | pod 'FirebaseAppDistribution' | FirebaseAppDistribution | |
验证 | pod 'FirebaseAuth' | FirebaseAuth | |
云端 Firestore | pod 'FirebaseFirestore' | FirebaseFirestore | |
Firebase 客户端 SDK 的云函数 | pod 'FirebaseFunctions' | FirebaseFunctions | |
云消息 | pod 'FirebaseMessaging' | FirebaseMessaging | |
云储存 | pod 'FirebaseStorage' | FirebaseStorage | |
崩溃分析 | pod 'FirebaseCrashlytics' | FirebaseCrashlytics | |
动态链接 | pod 'FirebaseDynamicLinks' | FirebaseDynamicLinks | |
应用内消息 | pod 'FirebaseInAppMessaging' | FirebaseInAppMessaging | (必需的) |
Firebase 安装 | pod 'FirebaseInstallations' | FirebaseInstallations | |
Firebase ML 自定义模型 API | pod 'FirebaseMLModelDownloader' | FirebaseMLModelDownloader | |
性能监控 | pod 'FirebasePerformance' | FirebasePerformance | |
实时数据库 | pod 'FirebaseDatabase' | FirebaseDatabase | |
远程配置 | pod 'FirebaseRemoteConfig' | FirebaseRemoteConfig |
不使用 Swift 包管理器进行集成
如果您不想使用 Swift Package Manager,您仍然可以通过使用 CocoaPods 或直接导入框架来利用 Firebase SDK。
可可豆
在我们的指南中了解有关 CocoaPods 集成的更多信息。
构架
除了支持 iOS 平台外,该 zip 现在还包含.xcframework
文件。有关详细信息,请参阅GitHub 上的 Firebase Apple 平台 SDK 自述文件。
下载框架 SDK zip 。这是一个约 200MB 的文件,下载可能需要一些时间。
解压缩文件,然后查看您要包含在应用程序中的框架的
README
文件。在目标构建设置的
Other Linker Settings
中-ObjC
链接器标志。
下一步
了解 Firebase:
访问了解 Firebase 项目以了解有关 Firebase 项目和项目最佳实践的更多信息。
亲身体验Firebase iOS Codelab 。
准备启动您的应用程序:
- 在 Google Cloud Console 中为您的项目设置预算提醒。
- 监控 Firebase 控制台中的使用情况和计费仪表板,以全面了解您的项目在多个 Firebase 服务中的使用情况。
- 查看Firebase 启动清单。
在使用 Firebase 和您的 Apple 项目时遇到问题?访问Apple 平台故障排除和常见问题解答。
将 Firebase 服务添加到您的应用:
使用Analytics深入了解用户行为。
使用 Authentication 设置用户身份验证。
使用Cloud Firestore或实时数据库存储用户信息等数据。
使用Cloud Storage 存储照片和视频等文件。
使用Cloud Functions触发在安全环境中运行的后端代码。
使用Cloud Messaging发送通知。
使用Crashlytics了解您的应用崩溃的时间和原因。