將 Firebase 新增至 Apple 專案

事前準備

  • 安裝下列項目:

    • Xcode 14.1 以上版本
  • 請確認您的專案符合下列要求:

    • 專案必須指定下列平台版本或更新版本:
      • iOS 11 版
      • macOS 10.13
      • tvOS 12
      • watchOS 6
  • 設定 Apple 實體裝置或使用模擬器執行應用程式。

如果您還沒有 Xcode 專案,只是想試用 Firebase 產品,可以下載其中一個快速入門導覽課程範例

步驟 1:建立 Firebase 專案

您必須先建立要連結至應用程式的 Firebase 專案,才能將 Firebase 新增到 Apple 應用程式。如要進一步瞭解 Firebase 專案,請參閱「瞭解 Firebase 專案」一文。

步驟 2:透過 Firebase 註冊應用程式

如要在 Apple 應用程式中使用 Firebase,您需要透過 Firebase 專案註冊應用程式。註冊應用程式的做法通常稱為「新增」應用程式到專案中。

  1. 前往 Firebase 主控台

  2. 在專案總覽頁面中的中央,按一下「iOS+」圖示,啟動設定工作流程。

    如果您已將應用程式新增至 Firebase 專案,按一下「Add app」(新增應用程式) 即可顯示平台選項。

  3. 在「bundle ID」欄位中輸入應用程式的軟體包 ID。

  4. (選用) 輸入其他應用程式資訊:應用程式暱稱App Store ID

  5. 按一下 [Register app] (註冊應用程式)

步驟 3:新增 Firebase 設定檔

  1. 按一下「Download GoogleService-Info.plist」,取得 Firebase Apple 平台設定檔 (GoogleService-Info.plist)。

  2. 將設定檔移至 Xcode 專案的根目錄。如果出現提示訊息,請選擇將設定檔新增至所有目標。

如果專案中有多個軟體包 ID,您必須將每個軟體包 ID 與 Firebase 控制台中註冊的應用程式建立關聯,以便每個應用程式都有自己的 GoogleService-Info.plist 檔案。

步驟 4:在應用程式中加入 Firebase SDK

使用 Swift Package Manager 安裝及管理 Firebase 依附元件。

  1. 在 Xcode 中,開啟應用程式專案,然後依序點選「File」>「Add Packages」
  2. 出現提示時,新增 Firebase Apple 平台 SDK 存放區:
  3.   https://github.com/firebase/firebase-ios-sdk
  4. 選取要使用的 SDK 版本。
  5. 選擇要使用的 Firebase 程式庫。

    如果您已在 Firebase 專案中啟用 Google Analytics (分析),請務必加入 FirebaseAnalytics。若是沒有廣告識別碼收集功能的 Analytics (分析),請改為新增 FirebaseAnalyticsWithoutAdId

完成後,Xcode 就會自動開始在背景中解析並下載依附元件。

步驟 5:在應用程式中初始化 Firebase

最後一個步驟是將初始化程式碼加入應用程式。您可能已在將 Firebase 新增至應用程式的過程中完成這個步驟。如果您使用的是快速入門導覽課程範例專案,則系統已為您完成這項作業。

  1. UIApplicationDelegate 以及應用程式委派使用的任何其他 Firebase 模組中匯入 FirebaseCore 模組。舉例來說,如要使用 Cloud Firestore 和驗證功能:

    SwiftUI

    import SwiftUI
    import FirebaseCore
    import FirebaseFirestore
    import FirebaseAuth
    // ...
          

    Swift

    import FirebaseCore
    import FirebaseFirestore
    import FirebaseAuth
    // ...
          

    Objective-C

    @import FirebaseCore;
    @import FirebaseFirestore;
    @import FirebaseAuth;
    // ...
          
  2. 在應用程式委派的 application(_:didFinishLaunchingWithOptions:) 方法中設定 FirebaseApp 共用執行個體:

    SwiftUI

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

    Swift

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

    Objective-C

    // Use Firebase library to configure APIs
    [FIRApp configure];
  3. 如果您使用的是 SwiftUI,則必須建立應用程式委派項目,並透過 UIApplicationDelegateAdaptorNSApplicationDelegateAdaptor 將其附加至 App 結構體。您必須一併停用應用程式委派清除功能。詳情請參閱 SwiftUI 操作說明

    SwiftUI

    @main
    struct YourApp: App {
      // register app delegate for Firebase setup
      @UIApplicationDelegateAdaptor(AppDelegate.self) var delegate
    
      var body: some Scene {
        WindowGroup {
          NavigationView {
            ContentView()
          }
        }
      }
    }
          
  4. 如果您已加入 Google Analytics (分析) 專用 Firebase SDK,您可以執行應用程式,將驗證傳送至 Firebase 控制台,您已成功安裝 Firebase。

這樣就可以了!您可以直接跳到後續步驟

如果無法順利設定,請參閱 Apple 平台疑難排解與常見問題

可用的程式庫

本節列出 Apple 平台支援的 Firebase 產品。進一步瞭解這些 Firebase Apple 平台程式庫:

服務或產品 Pod SwiftPM 程式庫 要新增 Analytics (分析) 嗎?
AdMob pod 'Google-Mobile-Ads-SDK' 不適用
數據分析 pod 'FirebaseAnalytics' FirebaseAnalytics
應用程式檢查 pod 'FirebaseAppCheck' FirebaseAppCheck
應用程式發布 pod 'FirebaseAppDistribution' FirebaseAppDistribution
身分驗證 pod 'FirebaseAuth' FirebaseAuth
Cloud Firestore pod 'FirebaseFirestore' FirebaseFirestore
Cloud Functions for Firebase 用戶端 SDK pod 'FirebaseFunctions' FirebaseFunctions
雲端通訊 pod 'FirebaseMessaging' FirebaseMessaging
Cloud Storage pod 'FirebaseStorage' FirebaseStorage
Crashlytics pod 'FirebaseCrashlytics' FirebaseCrashlytics
Dynamic Links pod 'FirebaseDynamicLinks' FirebaseDynamicLinks
應用程式內通訊 pod 'FirebaseInAppMessaging' FirebaseInAppMessaging
(必要)
Firebase 安裝 pod 'FirebaseInstallations' FirebaseInstallations
Firebase ML Custom Model API pod 'FirebaseMLModelDownloader' FirebaseMLModelDownloader
監控效能 pod 'FirebasePerformance' FirebasePerformance
即時資料庫 pod 'FirebaseDatabase' FirebaseDatabase
遠端設定 pod 'FirebaseRemoteConfig' FirebaseRemoteConfig
Vertex AI for Firebase 不適用 FirebaseVertexAI-Preview

在不使用 Swift Package Manager 的情況下整合

如果不想使用 Swift 套件管理員,您仍可使用 CocoaPods 或直接匯入架構來利用 Firebase SDK。

CocoaPods

如要進一步瞭解 CocoaPods 整合,請參閱我們的指南

架構

除了支援 iOS 平台以外,ZIP 檔案現在包含 .xcframework 檔案。詳情請參閱 GitHub 上的 Firebase Apple 平台 SDK README

  1. 下載架構 SDK ZIP 檔案。這個檔案約為 200 MB,可能需要一段時間才能下載完成。

  2. 解壓縮檔案,然後整合要加入應用程式的架構。

    您可以在下列任一位置找到整合操作說明:

    如要瞭解架構版本或依附元件,請參閱下載的 ZIP 發行版中的 METADATA.md 檔案。

  3. 在目標建構設定中的 Other Linker Settings 中加入 -ObjC 連結器旗標

後續步驟

瞭解 Firebase:

將 Firebase 服務新增至應用程式: