將 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 Google 助理 (可能需要額外設定)。


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

將 Firebase 加入應用程式需要同時包含 Firebase 控制台中的工作，以及 開啟應用程式 (例如下載 Firebase 設定檔 然後移至 Android 專案內)。

步驟 1：建立 Firebase 專案

您需要先建立 Firebase，才能將 Firebase 新增到你的 Android 應用程式 連線至 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 (app-level) 根目錄中

  2. 讓 google-services.json 設定檔中的值可供存取 導入 Firebase SDK，則需要 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.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.2.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.2.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. 為要使用的產品新增依附元件後，請同步處理 含有 Gradle 檔案的 Android 專案。

這樣就可以了！您可以直接跳到查看 後續步驟。

如果您在設定時遇到問題，請造訪 Android 疑難排解和常見問題。


方法 2：使用 Firebase Assistant 新增 Firebase

Firebase Assistant 註冊 來建立應用程式，並加入必要的 Firebase 檔案、外掛程式 和依附元件，全都可以在 Android Studio 中完成！

  1. 在 Android Studio 中開啟 Android 專案，並確認 使用最新版 Android Studio 和 Firebase Assistant：

    • Windows / Linux：[說明] >檢查更新
    • macOS：Android Studio >檢查更新

  2. 開啟 Firebase Assistant：依序點選「Tools」>「Tools」Firebase：

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

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

    2. 按一下按鈕，新增所需的 Firebase 產品 (例如 在應用程式中新增 Analytics)。

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

  5. 在「Assistant」窗格中，按照 所選 Firebase 產品。

  6. 您可以視需要透過 Firebase 新增其他 Firebase 產品，數量不限 Google 助理！

這樣就可以了！請務必查看 後續步驟。

如果您在設定時遇到問題，請造訪 Android 疑難排解和常見問題。


可用的程式庫

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

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

服務或產品 Gradle 依附元件 最新
版本		 要新增Analytics嗎？
Firebase Android BoM
(Bill of Materials)		 com.google.firebase:firebase-bom

最新的 Firebase BoM 版本包含最新版本 逐一介紹每個 Firebase Android 程式庫瞭解哪個資料庫版本 已對應至特定 BoM 版本，請查看版本資訊 該 BoM 版。

 33.2.0 版
AdMob com.google.android.gms:play-services-ads 23.3.0 版
Analytics com.google.firebase:firebase-analytics 22.1.0 版
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
App Distribution com.google.firebase:firebase-appdistribution 16.0.0-beta13
App Distribution API com.google.firebase:firebase-appdistribution-api 16.0.0-beta13
App Distribution 外掛程式 com.google.firebase:firebase-appdistribution-gradle 5.0.0
Authentication com.google.firebase:firebase-auth 23.0.0 版
Cloud Firestore com.google.firebase:firebase-firestore 25.1.0 版
Cloud Functions for Firebase Client SDK com.google.firebase:firebase-functions 21.0.0 版
Cloud Messaging com.google.firebase:firebase-messaging 24.0.1
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
Dynamic Links com.google.firebase:firebase-dynamic-links 22.1.0 版
In-App Messaging com.google.firebase:firebase-inappmessaging 21.0.0 版
(必填)
In-App Messaging 多媒體 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 版
Performance Monitoring com.google.firebase:firebase-perf 21.0.1
Performance Monitoring 外掛程式 com.google.firebase:perf-plugin 1.4.2 版
Realtime Database com.google.firebase:firebase-database 21.0.0 版
Remote Config com.google.firebase:firebase-config 22.0.0 版
Vertex AI in Firebase com.google.firebase:firebase-vertexai 16.0.0-beta04
Google Play 服務外掛程式 com.google.gms:google-services 4.4.2
已淘汰的相片庫
App Check SafetyNet 供應商 com.google.firebase:firebase-appcheck-safetynet 16.1.2
App Indexing com.google.firebase:firebase-appindexing 20.0.0 版

Firebase KTX 模組

Analytics com.google.firebase:firebase-analytics-ktx 22.1.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-beta13
Authentication com.google.firebase:firebase-auth-ktx 23.0.0 版
Cloud Firestore com.google.firebase:firebase-firestore-ktx 25.1.0 版
Cloud Functions for Firebase Client SDK com.google.firebase:firebase-functions-ktx 21.0.0 版
Cloud Messaging com.google.firebase:firebase-messaging-ktx 24.0.1
Cloud Storage com.google.firebase:firebase-storage-ktx 21.0.0 版
Crashlytics com.google.firebase:firebase-crashlytics-ktx 19.0.3
Dynamic Links com.google.firebase:firebase-dynamic-links-ktx 22.1.0 版
In-App Messaging com.google.firebase:firebase-inappmessaging-ktx 21.0.0 版
(必填)
In-App Messaging 多媒體 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 版
Performance Monitoring com.google.firebase:firebase-perf-ktx 21.0.1
Realtime Database com.google.firebase:firebase-database-ktx 21.0.0 版
Remote Config 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 ML：圖片標籤模型 com.google.firebase:firebase-ml-vision-image-label-model 20.0.2 版
Firebase ML：物件偵測與追蹤模型 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 22.0.1
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：