Naar console

将 Firebase 添加到您的 iOS 项目

前提条件

开始之前,需要在您的环境中完成若干设置:

  • Xcode 10.1 或更高版本
  • 一个目标为 iOS 8 或更高版本的 Xcode 项目
  • Swift 项目必须使用 Swift 3.0 或更高版本
  • 您的应用的软件包标识符
  • CocoaPods 1.4.0 或更高版本
  • 针对云消息传递:
    • 一台 iOS 设备
    • 一个 Apple 开发者帐号所对应的 Apple 推送通知身份验证密钥
    • 在 Xcode 中通过 App > Capabilities 启用推送通知功能

如果您还没有 Xcode 项目,只是想试用一下某项 Firebase 功能,可以下载我们的快速入门示例。如果使用快速入门示例,请不要忘记从项目设置中获取软件包标识符,下一步中会用到该标识符。

将 Firebase 添加到您的应用

现在,可以将 Firebase 添加到您的应用。要执行此操作,您需要一个 Firebase 项目和适用于您的应用的 Firebase 配置文件。访问了解 Firebase 项目以详细了解相关信息。

创建项目之后,您就可以向其中添加 iOS 应用了:

  1. 点击将 Firebase 添加到您的 iOS 应用,然后按设置步骤操作。如果您是导入现有 Google 项目,系统可能会自动执行这些操作,您只需下载配置文件即可。

  2. 看到提示时,输入应用的软件包 ID。请务必输入应用在使用的软件包 ID,只有在将应用添加到 Firebase 项目时您才能进行此设置。

  3. 将 Firebase iOS 配置文件添加到您的应用:

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

      您可以随时再次下载 Firebase iOS 配置文件

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

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

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

添加 SDK

如果您是设置一个新项目,则需要安装 SDK。您可能已经在创建 Firebase 项目的过程中完成此步操作。

我们建议使用 CocoaPods 安装相关的库。您可以按照安装说明来安装 CocoaPods。如果愿意,您可以直接集成 SDK 框架,而不使用 CocoaPods

如果您计划下载并运行某个快速入门示例,示例中会提供 Xcode 项目和 Podfile,不过您还是需要安装 Pod 并下载 GoogleService-Info.plist 文件。如果您希望将 Firebase 库集成至自己的某个项目中,则需要为想要使用的库添加 Pod。

  1. 如果还没有 Xcode 项目,请立即创建一个。

  2. 如果还没有 Podfile,请创建一个:

    $ cd your-project directory
    $ pod init
    
  3. 添加您想安装的 Pod。您可以按照以下方法在 Podfile 中纳入一个 Pod:

    pod 'Firebase/Analytics'
    
    

    这会在您的 iOS 应用中添加 Firebase 正常运行所需的必备库以及 Google Analytics for Firebase 功能。下面列出了目前可供使用的一系列 pod 和 subspec。在针对不同功能的设置指南中也对此给出了相应的链接。

  4. 安装 Pod 并打开 .xcworkspace 文件以便在 Xcode 中查看该项目。

    $ pod install
    $ open your-project.xcworkspace
    
  5. Firebase 控制台中下载一个 GoogleService-Info.plist 文件并将其添加到您的应用中。

在您的应用中初始化 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];

可用的 pod

以下这些 pod 分别对应不同的 Firebase 功能。

pod 服务
pod 'Firebase/Analytics' Analytics
pod 'Firebase/AdMob' AdMob
pod 'Firebase/Messaging' 云消息传递
pod 'Firebase/Database' 实时数据库
pod 'Firebase/DynamicLinks' 动态链接
pod 'Fabric'
pod 'Crashlytics'
Crashlytics
pod 'Firebase/RemoteConfig' 远程配置
pod 'Firebase/Auth' 身份验证
pod 'Firebase/Storage' 存储
pod 'Firebase/Performance' 性能监控
pod 'Firebase/Firestore' Cloud Firestore
pod 'Firebase/Functions' Cloud Functions for Firebase 客户端 SDK
pod 'Firebase/MLVision' ML Kit Vision API
pod 'Firebase/MLVisionLabelModel' 机器学习套件图片标签模型
pod 'Firebase/MLVisionBarcodeModel' 机器学习套件条形码扫描模型
pod 'Firebase/MLVisionTextModel' 机器学习套件文字识别模型
pod 'Firebase/MLVisionFaceModel' 机器学习套件人脸检测模型
pod 'Firebase/MLNaturalLanguage' ML Kit Natural Language API
pod 'Firebase/MLNLLanguageID' 机器学习套件语言识别模型
pod 'Firebase/MLNLSmartReply' 机器学习套件智能回复模型
pod 'Firebase/MLModelInterpreter' 机器学习套件自定义模型 API

不使用 CocoaPods 进行集成

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

  1. 下载 framework SDK zip(该文件约有 1GB,可能需要一些时间下载)。
  2. 解压缩并查看 README 文件,以了解要将哪些框架包含在您的项目中。
  3. 在目标的构建设置中,向 Other Linker Settings 中添加 ObjC 链接器标记

后续步骤

了解 Firebase:

为您的应用添加 Firebase 功能: