將 Firebase 新增至您的 Android 專案

先備知識

  • 安裝或更新至 Android Studio 最新版本。

  • 請確認您的專案符合下列規定 (請注意,部分產品可能有更嚴格的規定):

    • 指定 API 級別 19 (KitKat) 以上版本
    • 使用 Android 4.4 以上版本
    • 使用 Jetpack (AndroidX),其必須符合下列版本需求條件:
      • com.android.tools.build:gradle 7.3.0 以上版本
      • compileSdkVersion 28 以上版本
  • 設定實體裝置或使用模擬器執行應用程式。
    請注意,含有依附元件的 Google Play 服務 Firebase SDK 必須安裝 Google Play 服務。

  • 使用 Google 帳戶登入 Firebase

如果您還沒有 Android 專案,只是想試用 Firebase 產品,可以下載我們的快速入門導覽課程範例


您可以使用下列其中一種方式,將 Android 應用程式連結至 Firebase:

  • 方法 1(建議) 請使用 Firebase 控制台設定工作流程。
  • 選項 2:使用 Android Studio Firebase Assistant (可能需要進行額外設定)。



方法 1:使用 Firebase 控制台新增 Firebase

將 Firebase 加入應用程式需要包含 Firebase 控制台和開放式 Android 專案中的工作 (例如從主控台下載 Firebase 設定檔,再移至 Android 專案)。

步驟 1:建立 Firebase 專案

您需要先建立 Firebase 專案,並連結至 Android 應用程式,才能將 Firebase 新增至 Android 應用程式。如要進一步瞭解 Firebase 專案,請參閱「瞭解 Firebase 專案」。

步驟 2:向 Firebase 註冊應用程式

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

  1. 前往 Firebase 主控台

  2. 在專案總覽頁面中間,按一下「Android」圖示 () 或「Add app」,啟動設定工作流程。

  3. 在「Android package name」欄位中,輸入應用程式的套件名稱。

  4. (選用) 輸入其他應用程式資訊:「應用程式暱稱」和「偵錯簽署憑證 SHA-1」

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

步驟 3:新增 Firebase 設定檔

  1. 下載 Firebase Android 設定檔 (google-services.json),然後新增至應用程式:

    1. 點選「Download google-services.json」,取得 Firebase Android 設定檔。

    2. 將設定檔移至應用程式的「module (app-level)」根目錄。

  2. 您需要 Google 服務 Gradle 外掛程式 (google-services),才能讓 Firebase SDK 存取 google-services.json 設定檔中的值。

    1. 根層級 (專案層級) Gradle 檔案 (<project>/build.gradle.kts<project>/build.gradle) 中,將 Google 服務外掛程式新增為依附元件:

      Kotlin

      plugins {
        id("com.android.application") version "7.3.0" apply false
        // ...
      
        // Add the dependency for the Google services Gradle plugin
        id("com.google.gms.google-services") version "4.4.2" apply false
      }
      

      Groovy

      plugins {
        id 'com.android.application' version '7.3.0' apply false
        // ...
      
        // Add the dependency for the Google services Gradle plugin
        id 'com.google.gms.google-services' version '4.4.2' apply false
      }
      
    2. 在您的模組 (應用程式層級) Gradle 檔案 (通常是 <project>/<app-module>/build.gradle.kts<project>/<app-module>/build.gradle) 中,新增 Google 服務外掛程式:

      Kotlin

      plugins {
        id("com.android.application")
      
        // Add the Google services Gradle plugin
        id("com.google.gms.google-services")
        // ...
      }
      

      Groovy

      plugins {
        id 'com.android.application'
      
        // Add the Google services Gradle plugin
        id 'com.google.gms.google-services'
        // ...
      }
      

步驟 4:在應用程式中新增 Firebase SDK

  1. 模組 (應用程式層級) Gradle 檔案 (通常是 <project>/<app-module>/build.gradle.kts<project>/<app-module>/build.gradle) 中,針對您想要在應用程式中使用的 Firebase 產品新增依附元件。建議您使用 Firebase Android BoM 控管程式庫的版本管理。

    Analytics (分析) 已啟用

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation(platform("com.google.firebase:firebase-bom:33.1.2"))
    
      // When using the BoM, you don't specify versions in Firebase library dependencies
    
      // Add the dependency for the Firebase SDK for Google Analytics
      implementation("com.google.firebase:firebase-analytics")
    
      // TODO: Add the dependencies for any other Firebase products you want to use
      // See https://firebase.google.com/docs/android/setup#available-libraries
      // For example, add the dependencies for Firebase Authentication and Cloud Firestore
      implementation("com.google.firebase:firebase-auth")
      implementation("com.google.firebase:firebase-firestore")
    }
    

    透過使用 Firebase Android BoM,您的應用程式一律會使用相容的 Firebase Android 程式庫版本。

    在尋找 Kotlin 專用的程式庫模組嗎?2023 年 10 月 (Firebase BoM 32.5.0) 起,Kotlin 和 Java 開發人員都能使用主要的程式庫模組 (詳情請參閱這項計畫的常見問題)。

    未啟用 Analytics (分析)

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation(platform("com.google.firebase:firebase-bom:33.1.2"))
    
      // When using the BoM, you don't specify versions in Firebase library dependencies
    
      // TODO: Add the dependencies for Firebase products you want to use
      // See https://firebase.google.com/docs/android/setup#available-libraries
      // For example, add the dependencies for Firebase Authentication and Cloud Firestore
      implementation("com.google.firebase:firebase-auth")
      implementation("com.google.firebase:firebase-firestore")
    }
    

    透過使用 Firebase Android BoM,您的應用程式一律會使用相容的 Firebase Android 程式庫版本。

    在尋找 Kotlin 專用的程式庫模組嗎?2023 年 10 月 (Firebase BoM 32.5.0) 起,Kotlin 和 Java 開發人員都能使用主要的程式庫模組 (詳情請參閱這項計畫的常見問題)。

  2. 為要使用的產品新增依附元件後,請將 Android 專案與 Gradle 檔案同步處理。

這樣就可以了!您可以直接跳到查看建議的後續步驟

如果您在設定時遇到問題,請參閱 Android 疑難排解與常見問題



方法 2:使用 Firebase Assistant 新增 Firebase

Firebase Assistant 會向 Firebase 專案註冊您的應用程式,並將必要的 Firebase 檔案、外掛程式和依附元件加入 Android 專案,所有作業都能在 Android Studio 中完成!

  1. 在 Android Studio 中開啟 Android 專案,並確認您使用的是最新版的 Android Studio 和 Firebase Assistant:

    • Windows / Linux:[說明] > [檢查更新]
    • macOS:[Android Studio] > [檢查更新]
  2. 開啟 Firebase Assistant:依序點選「Tools」>「Firebase」。

  3. 在「Assistant」窗格中,選擇要新增至應用程式的 Firebase 產品。展開該部分,然後按一下教學課程連結 (例如「Analytics (分析)」>「記錄 Analytics (分析) 事件」)

    1. 按一下「連結至 Firebase」,將 Android 專案連結至 Firebase。

    2. 按一下按鈕,新增所需的 Firebase 產品 (例如「將 Analytics (分析) 加入應用程式)。

  4. 同步應用程式,確保所有依附元件都有必要的版本。

  5. 在「Assistant」窗格中,按照所選 Firebase 產品的其餘設定操作說明。

  6. 您可透過 Firebase Assistant 新增任意數量的 Firebase 產品!

這樣就可以了!請務必查看建議的後續步驟

如果您在設定時遇到問題,請參閱 Android 疑難排解與常見問題



可用的程式庫

本節列出 Android 支援的 Firebase 產品及其 Gradle 依附元件。進一步瞭解這些 Firebase Android 程式庫:

請注意,使用 Firebase Android BoM 時,在 Gradle 建構設定檔中宣告 Firebase 程式庫依附元件時,您不需要指定個別的程式庫版本。

服務或產品 Gradle 依附元件 最新
版本
要新增數據分析嗎?
Firebase Android BoM
(物料清單)
com.google.firebase:firebase-bom

Firebase BoM 最新版本包含各個 Firebase Android 程式庫的最新版本。如要瞭解哪些程式庫版本會對應至特定 BoM 版本,請參閱該 BoM 版本的版本資訊。

33.1.2
AdMob com.google.android.gms:play-services-ads 23.2.0 版
數據分析 com.google.firebase:firebase-analytics 22.0.2
App Check 自訂供應商 com.google.firebase:firebase-appcheck 18.0.0 版
App Check 偵錯供應商 com.google.firebase:firebase-appcheck-debug 18.0.0 版
App Check Play Integrity 供應商 com.google.firebase:firebase-appcheck-playintegrity 18.0.0 版
應用程式發布 com.google.firebase:firebase-appdistribution 16.0.0-beta13
應用程式發布 API com.google.firebase:firebase-appdistribution-api 16.0.0-beta13
應用程式發布外掛程式 com.google.firebase:firebase-appdistribution-gradle 5.0.0
身分驗證 com.google.firebase:firebase-auth 23.0.0 版
Cloud Firestore com.google.firebase:firebase-firestore 25.0.0 版
Cloud Functions for Firebase 用戶端 SDK com.google.firebase:firebase-functions 21.0.0 版
雲端通訊 com.google.firebase:firebase-messaging 24.0.0 版
Cloud Storage com.google.firebase:firebase-storage 21.0.0 版
Crashlytics com.google.firebase:firebase-crashlytics 19.0.3
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 19.0.3
Crashlytics 外掛程式 com.google.firebase:firebase-crashlytics-gradle 3.0.2 版
動態功能模組支援 com.google.firebase:firebase-dynamic-module-support 16.0.0-beta03
動態連結 com.google.firebase:firebase-dynamic-links 22.1.0 版
應用程式內通訊 com.google.firebase:firebase-inappmessaging 21.0.0 版
(必填)
應用程式內通訊顯示 com.google.firebase:firebase-inappmessaging-display 21.0.0 版
(必填)
Firebase 安裝 com.google.firebase:firebase-installations 18.0.0 版
Firebase ML Model 下載工具 API com.google.firebase:firebase-ml-modeldownloader 25.0.0 版
效能監控 com.google.firebase:firebase-perf 21.0.1
Performance Monitoring 外掛程式 com.google.firebase:perf-plugin 1.4.2 版
即時資料庫 com.google.firebase:firebase-database 21.0.0 版
遠端設定 com.google.firebase:firebase-config 22.0.0 版
適用於 Firebase 的 Vertex AI com.google.firebase:firebase-vertexai 16.0.0-beta03
Google Play 服務外掛程式 com.google.gms:google-services 4.4.2 版
已淘汰的相片庫
App Check SafetyNet 供應商 com.google.firebase:firebase-appcheck-safetynet 16.1.2
應用程式索引 com.google.firebase:firebase-appindexing 20.0.0 版

Firebase KTX 模組

數據分析 com.google.firebase:firebase-analytics-ktx 22.0.2
App Check 自訂供應商 com.google.firebase:firebase-appcheck-ktx 18.0.0 版
應用程式發布 API com.google.firebase:firebase-appdistribution-api-ktx 16.0.0-beta13
身分驗證 com.google.firebase:firebase-auth-ktx 23.0.0 版
Cloud Firestore com.google.firebase:firebase-firestore-ktx 25.0.0 版
Cloud Functions for Firebase 用戶端 SDK com.google.firebase:firebase-functions-ktx 21.0.0 版
雲端通訊 com.google.firebase:firebase-messaging-ktx 24.0.0 版
Cloud Storage com.google.firebase:firebase-storage-ktx 21.0.0 版
Crashlytics com.google.firebase:firebase-crashlytics-ktx 19.0.3
動態連結 com.google.firebase:firebase-dynamic-links-ktx 22.1.0 版
應用程式內通訊 com.google.firebase:firebase-inappmessaging-ktx 21.0.0 版
(必填)
應用程式內通訊顯示 com.google.firebase:firebase-inappmessaging-display-ktx 21.0.0 版
(必填)
Firebase 安裝 com.google.firebase:firebase-installations-ktx 18.0.0 版
Firebase ML Model 下載工具 API com.google.firebase:firebase-ml-modeldownloader-ktx 25.0.0 版
效能監控 com.google.firebase:firebase-perf-ktx 21.0.1
即時資料庫 com.google.firebase:firebase-database-ktx 21.0.0 版
遠端設定 com.google.firebase:firebase-config-ktx 22.0.0 版

Firebase ML Kit 程式庫

Firebase ML 自訂模型 API com.google.firebase:firebase-ml-model-interpreter 22.0.4
Firebase ML Vision API com.google.firebase:firebase-ml-vision 24.1.0 版
Firebase 機器學習:圖片標籤模型 com.google.firebase:firebase-ml-vision-image-label-model 20.0.2 版
Firebase 機器學習:物件偵測和追蹤模型 com.google.firebase:firebase-ml-vision-object-detection-model 19.0.6 版
Firebase 機器學習:臉部偵測模型 com.google.firebase:firebase-ml-vision-face-model 20.0.2 版
Firebase ML:條碼掃描模型 com.google.firebase:firebase-ml-vision-barcode-model 16.1.2
Firebase 機器學習:AutoML Vision Edge API com.google.firebase:firebase-ml-vision-automl 18.0.6 版
Firebase 機器學習:Natural Language API com.google.firebase:firebase-ml-natural-language 22.0.1
Firebase 機器學習:語言識別模型 com.google.firebase:firebase-ml-natural-language-language-id-model 20.0.8
Firebase 機器學習:翻譯模型 com.google.firebase:firebase-ml-natural-language-translate-model 20.0.9 美元
Firebase 機器學習:智慧回覆模型 com.google.firebase:firebase-ml-natural-language-smart-reply-model 20.0.8



後續步驟

在應用程式中新增 Firebase 服務:

瞭解 Firebase: