转到控制台

将 Firebase 添加至您的 iOS 项目

前提条件

  • 安装 Xcode 10.1 或更高版本。

  • 安装 CocoaPods 1.4.0 或更高版本。

  • 在 Xcode 中打开您的项目。

    • 您的项目必须适用于 iOS 8 或更高版本。

    • Swift 项目必须使用 Swift 3.0 或更高版本。

  • 设置用于运行您的应用的一台 iOS 真机设备或 iOS 模拟器。

    • 为了支持云消息传递,您需要:

      • 一台 iOS 真机设备
      • 一个 Apple 开发者帐号所对应的 Apple 推送通知身份验证密钥
      • 在 Xcode 中通过 App > Capabilities 启用推送通知功能。
    • 对于所有其他 Firebase 产品,您可以使用 iOS 真机设备或 iOS 模拟器。

  • 使用您的 Google 帐号登录 Firebase

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

第 1 步:创建 Firebase 项目

您必须先创建一个 Firebase 项目,并将其关联到您的 iOS 应用,然后才能将 Firebase 添加到您的 iOS 应用。访问了解 Firebase 项目以详细了解相关信息。

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

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

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

  1. Firebase 控制台的项目概览页面的中心位置,点击 iOS 图标以启动设置工作流。

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

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

    • 在 XCode 中打开您的应用,然后在顶级 Runner 目录中访问常规标签,找到此软件包 ID。软件包标识符字段的值是 iOS 软件包 ID(例如 com.yourcompany.yourproject)。
  3. (可选)根据设置工作流的提示输入其他应用信息。

  4. 点击注册应用

第 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 框架

请注意,如果您使用的是某个快速入门示例,则示例中已提供 Xcode 项目和 Podfile(包含 pod),不过您还是需要添加 Firebase 配置文件并安装 pod。

您可以将任何受支持的 Firebase 产品添加到 iOS 应用中。我们建议从 Google Analytics for Firebase 开始。

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

    cd your-project-directory
    pod init
  2. 将想要用在应用中的 pod 添加到 Podfile。例如,对于 Analytics:

    pod 'Firebase/Analytics'

    此 pod 会在您的 iOS 应用中添加 Firebase 正常运行所需的必备库以及 Google Analytics for Firebase 功能。

  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];

添加初始化代码后,运行您的应用以便向 Firebase 控制台发送验证信息,证明您已成功安装 Firebase。

可用的 pod

下面列出了各 Firebase 产品可使用的 pod。

产品 Pod
AdMob pod 'Firebase/AdMob'
Analytics pod 'Firebase/Analytics'
身份验证 pod 'Firebase/Auth'
Cloud Firestore pod 'Firebase/Firestore'
Cloud Functions for Firebase 客户端 SDK pod 'Firebase/Functions'
云消息传递 pod 'Firebase/Messaging'
Cloud Storage pod 'Firebase/Storage'
Crashlytics pod 'Fabric'
pod 'Crashlytics'
动态链接 pod 'Firebase/DynamicLinks'
应用内消息 pod 'Firebase/InAppMessaging'
应用内消息显示 pod 'Firebase/InAppMessagingDisplay'
机器学习套件:Vision API pod 'Firebase/MLVision'
机器学习套件:图片标签模型 pod 'Firebase/MLVisionLabelModel'
机器学习套件:条形码扫描模型 pod 'Firebase/MLVisionBarcodeModel'
机器学习套件:文字识别模型 pod 'Firebase/MLVisionTextModel'
机器学习套件:人脸检测模型 pod 'Firebase/MLVisionFaceModel'
机器学习套件:对象检测和跟踪模型 pod 'Firebase/MLVisionObjectDetection'
机器学习套件:Natural Language API pod 'Firebase/MLNaturalLanguage'
机器学习套件:语言识别模型 pod 'Firebase/MLNLLanguageID'
机器学习套件:翻译模型 pod 'Firebase/MLNLTranslate'
机器学习套件:智能回复模型 pod 'Firebase/MLNLSmartReply'
机器学习套件:自定义模型 API pod 'Firebase/MLModelInterpreter'
机器学习套件:AutoML Vision Edge API pod 'Firebase/MLVisionAutoML'
性能监控 pod 'Firebase/Performance'
实时数据库 pod 'Firebase/Database'
远程配置 pod 'Firebase/RemoteConfig'

不使用 CocoaPods 进行集成

如果不想使用 Cocoapods,您仍可通过直接导入框架的方法来利用 Firebase SDK。

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

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

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

后续步骤

了解 Firebase:

为您的应用添加 Firebase 功能: