將 Firebase 新增至您的 Apple 專案

事前準備

  • 安裝下列項目:

    • Xcode 15.2 以上版本
  • 請確認您的專案符合下列規定:

    • 您的專案必須指定以下平台版本或更新版本:
      • iOS 13
      • macOS 10.15
      • tvOS 13
      • watchOS 7
  • 設定實體 Apple 裝置,或使用模擬器執行應用程式。

如果您還沒有 Xcode 專案,但想試用 Firebase 產品,可以下載我們的快速入門範例

步驟 1:建立 Firebase 專案

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

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

如要在 Apple 應用程式中使用 Firebase,您必須將應用程式註冊至 Firebase 專案。註冊應用程式通常稱為將應用程式「新增」至專案。

  1. 前往 Firebase 控制台

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

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

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

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

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

步驟 3:新增 Firebase 設定檔

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

  2. 將設定檔移至 Xcode 專案的根目錄。如果系統顯示提示,請選取將設定檔新增至所有目標。

如果專案中有多個套件 ID,您必須在 Firebase 主控台中將每個套件 ID 與已註冊的應用程式建立關聯,讓每個應用程式都能擁有自己的 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 中匯入 FirebaseCore 模組,以及應用程式委派程式使用的任何其他 Firebase 模組。例如,如要使用 Cloud FirestoreAuthentication

    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 結構體。您也必須停用應用程式委派程式 swizzling。詳情請參閱 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 程式庫 Google Analytics.">新增 Analytics?
AdMob pod 'Google-Mobile-Ads-SDK' 不適用
Analytics pod 'FirebaseAnalytics' FirebaseAnalytics
App Check pod 'FirebaseAppCheck' FirebaseAppCheck
App Distribution pod 'FirebaseAppDistribution' FirebaseAppDistribution
Authentication pod 'FirebaseAuth' FirebaseAuth
Cloud Firestore pod 'FirebaseFirestore' FirebaseFirestore
Cloud Functions for Firebase Client SDK pod 'FirebaseFunctions' FirebaseFunctions
Cloud Messaging pod 'FirebaseMessaging' FirebaseMessaging
Cloud Storage pod 'FirebaseStorage' FirebaseStorage
Crashlytics pod 'FirebaseCrashlytics' FirebaseCrashlytics
Dynamic Links pod 'FirebaseDynamicLinks' FirebaseDynamicLinks
In-App Messaging pod 'FirebaseInAppMessaging' FirebaseInAppMessaging
(必要)
Firebase 安裝次數 pod 'FirebaseInstallations' FirebaseInstallations
Firebase ML 自訂模型 API pod 'FirebaseMLModelDownloader' FirebaseMLModelDownloader
Performance Monitoring pod 'FirebasePerformance' FirebasePerformance
Realtime Database pod 'FirebaseDatabase' FirebaseDatabase
Remote Config pod 'FirebaseRemoteConfig' FirebaseRemoteConfig
Vertex AI in Firebase pod 'FirebaseVertexAI' FirebaseVertexAI

不使用 Swift Package Manager 進行整合

如果您不想使用 Swift Package Manager,仍可透過使用 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 服務: