Google 致力于为黑人社区推动种族平等。查看具体举措

将 Firebase 添加至您的 iOS 项目

前提条件

  • 安装以下内容:

    • Xcode 12.0 或更高版本
    • CocoaPods 1.9.0 或更高版本
  • 确保您的项目满足以下要求:

    • 您的项目必须针对 iOS 10 或更高版本。
  • 设置一台 iOS 实体设备或使用 iOS 模拟器运行您的应用。

如果您还没有 Xcode 项目,只是想试用某一 Firebase 产品,则可以下载一个我们的快速入门示例

第 1 步:创建 Firebase 项目

您必须先创建一个要关联到 iOS 应用的 Firebase 项目,然后才能将 Firebase 添加到您的 iOS 应用。请访问了解 Firebase 项目以了解详情。

第 2 步:在 Firebase 中注册您的应用

有了 Firebase 项目后,您就可以将自己的 iOS 应用添加到其中了。

请访问了解 Firebase 项目以详细了解将应用添加到 Firebase 项目的最佳做法和注意事项,包括如何处理多个构建变体。

  1. 转到 Firebase 控制台

  2. 在项目概览页面的中心位置,点击 iOS 图标 (),启动设置工作流。

    如果您已向 Firebase 项目添加过应用,请点击添加应用以显示平台选项。

  3. iOS 软件包 ID 字段中输入应用的软件包 ID。

  4. (可选)输入其他应用信息:应用别名App Store ID

  5. 点击注册应用

第 3 步:添加 Firebase 配置文件

  1. 点击下载 GoogleService-Info.plist,获取 Firebase iOS 配置文件 (GoogleService-Info.plist)。

  2. 将配置文件移至 Xcode 项目的根目录中。如果出现提示,请选择将配置文件添加到所有目标。

如果您的项目中有多个软件包 ID,则必须将每个软件包 ID 与 Firebase 控制台中的注册应用相关联,使每个应用都有自己的 GoogleService-Info.plist 文件。

第 4 步:将 Firebase SDK 添加到您的应用

我们建议使用 CocoaPods 安装 Firebase 库。但是,如果您不想使用 CocoaPods,可以直接集成 SDK 框架,也可以使用 Swift Package Manager(Beta 版)

您是否使用了某个快速入门示例Xcode 项目和 Podfile(包含 pod)已经存在,但您仍然需要添加 Firebase 配置文件并安装 pod。

  1. 如果您没有 Podfile,请创建一个:

    cd your-project-directory
    pod init
  2. 将想要用在应用中的 Firebase pod 添加到 Podfile。

    您可以将任何受支持的 Firebase 产品添加到 iOS 应用中。

    已启用 Analytics

    platform :ios, ‘10.0’
    # Add the Firebase pod for Google Analytics pod 'Firebase/Analytics'
    # Add the pods for any other Firebase products you want to use in your app # For example, to use Firebase Authentication and Cloud Firestore pod 'Firebase/Auth' pod 'Firebase/Firestore'

    未启用 Analytics

    platform :ios, ‘10.0’
    # Add the pods for the Firebase products you want to use in your app # For example, to use Firebase Authentication and Cloud Firestore pod 'Firebase/Auth' pod 'Firebase/Firestore'
  3. 安装 pod,然后打开 .xcworkspace 文件以便在 Xcode 中查看该项目:

    pod install
    open your-project.xcworkspace

第 5 步:在您的应用中初始化 Firebase

最后一步是向您的应用添加初始化代码。您可能在向应用添加 Firebase 的过程中已经完成此步操作。如果您使用的是快速入门示例项目,则此步骤已完成。

  1. UIApplicationDelegate 中导入 Firebase 模块:

    Swift

    import Firebase

    Objective-C

    @import Firebase;
  2. 配置一个 FirebaseApp 共享实例(通常在应用的 application:didFinishLaunchingWithOptions: 方法中配置):

    Swift

    // Use Firebase library to configure APIs
    FirebaseApp.configure()

    Objective-C

    // Use Firebase library to configure APIs
    [FIRApp configure];
  3. 如果您添加了 Firebase Analytics,则可以运行您的应用,向 Firebase 控制台发送您已成功安装 Firebase 的验证信息。

大功告成!您可以跳至后续步骤了。

可用的 pod

本部分列出了支持 iOS 的 Firebase 产品及其 Pod。详细了解以下 Firebase iOS 库:

服务或产品 Pod 添加 Analytics?
AdMob pod 'Google-Mobile-Ads-SDK'
Analytics pod 'Firebase/Analytics'
App Distribution pod 'Firebase/AppDistribution'
Authentication pod 'Firebase/Auth'
Cloud Firestore pod 'Firebase/Firestore'
Cloud Functions for Firebase 客户端 SDK pod 'Firebase/Functions'
Cloud Messaging pod 'Firebase/Messaging'
Cloud Storage pod 'Firebase/Storage'
Firebase Crashlytics pod 'Firebase/Crashlytics'
Dynamic Links pod 'Firebase/DynamicLinks'
In-App Messaging pod 'Firebase/InAppMessaging'
(需要)
Firebase ML Vision API pod 'Firebase/MLVision'
Firebase ML Custom Model API pod 'Firebase/MLModelInterpreter'
Performance Monitoring pod 'Firebase/Performance'
Realtime Database pod 'Firebase/Database'
Remote Config pod 'Firebase/RemoteConfig'

不使用 CocoaPods 进行集成

如果不想使用 Cocoapods,您仍可通过直接导入框架或使用 Swift Package Manager 来利用 Firebase SDK。

框架

除了支持 iOS 平台外,zip 现在还包含 .xcframework 文件,.xcframework 文件添加了基于社区的 Catalyst 支持。如需了解详情,请参阅 GitHub 上的 Firebase iOS SDK README 文件

  1. 下载框架 SDK zip。该文件约有 200MB,可能需要一些时间才能下载完成。

  2. 解压缩文件,然后查看要包含在应用中的框架的 README

  3. 在目标的构建设置中,将 ObjC 链接器标志添加到 Other Linker Settings 中。

Swift Package Manager

Swift Package Manager 支持目前处于 Beta 版阶段。按照 GitHub 上的文档中的说明操作,并向 GitHub 问题跟踪器提交任何反馈。

后续步骤

了解 Firebase

将 Firebase 服务添加到您的应用