將 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 專案

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

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

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

  1. 前往 Firebase 主控台。

  2. 在專案總覽頁面的中央，按一下「Android」圖示 () 或「新增應用程式」，啟動設定工作流程。

  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 (應用程式層級) 根目錄。

  2. 如要讓 Firebase SDK 存取 google-services.json 設定檔中的值，須有 Google 服務 Gradle 外掛程式 (google-services)。

    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.1" 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.1' 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.0.0"))

  // 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.0.0"))

  // 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 依附元件 最新版本
 要新增 Analytics (分析) 嗎？
Firebase Android BoM
(物料清單)		 com.google.firebase:firebase-bom

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

 33.0.0 版
AdMob com.google.android.gms:play-services-ads 23.0.0 版
數據分析 com.google.firebase:firebase-analytics 22.0.0 版
App Check 自訂供應商 com.google.firebase:firebase-appcheck 18.0.0 版
App Check 偵錯服務程式 com.google.firebase:firebase-appcheck-debug 18.0.0 版
應用程式檢查 Play Integrity 供應商 com.google.firebase:firebase-appcheck-playintegrity 18.0.0 版
應用程式發布 com.google.firebase:firebase-appdistribution 16.0.0-beta12
App Distribution API com.google.firebase:firebase-appdistribution-api 16.0.0-beta12
應用程式發布外掛程式 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.0 版
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 19.0.0 版
Crashlytics 外掛程式 com.google.firebase:firebase-crashlytics-gradle 3.0.0
支援動態功能模組 com.google.firebase:firebase-dynamic-module-support 16.0.0-beta03
Dynamic Links com.google.firebase:firebase-dynamic-links 22.0.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 模型下載工具 API com.google.firebase:firebase-ml-modeldownloader 25.0.0 版
監控效能 com.google.firebase:firebase-perf 21.0.0 版
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 版
Google Play 服務外掛程式 com.google.gms:google-services 4.4.1
已淘汰的資料庫
應用程式檢查 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.0 版
App Check 自訂供應商 com.google.firebase:firebase-appcheck-ktx 18.0.0 版
App Distribution API com.google.firebase:firebase-appdistribution-api-ktx 16.0.0-beta12
身分驗證 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.0 版
Dynamic Links com.google.firebase:firebase-dynamic-links-ktx 22.0.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 模型下載工具 API com.google.firebase:firebase-ml-modeldownloader-ktx 25.0.0 版
監控效能 com.google.firebase:firebase-perf-ktx 21.0.0 版
即時資料庫 com.google.firebase:firebase-database-ktx 21.0.0 版
遠端設定 com.google.firebase:firebase-config-ktx 22.0.0 版

Firebase ML Kit 程式庫

Firebase ML Custom Model 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 ML：圖片標籤模型 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 ML：臉部偵測模型 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 ML：AutoML Vision Edge API com.google.firebase:firebase-ml-vision-automl 18.0.6
Firebase ML：Natural Language API com.google.firebase:firebase-ml-natural-language 2,201 萬
Firebase ML：語言識別模型 com.google.firebase:firebase-ml-natural-language-language-id-model 20.0.8 版
Firebase ML：翻譯模型 com.google.firebase:firebase-ml-natural-language-translate-model 20.0.9 美元
Firebase ML：智慧回覆模型 com.google.firebase:firebase-ml-natural-language-smart-reply-model 20.0.8 版


後續步驟

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

瞭解 Firebase：