將 Firebase 添加到您的 Android 項目

先決條件

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

  • 確保您的專案符合以下要求：

    • 目標 API 等級 19 (KitKat) 或更高
    • 使用Android 4.4或更高版本
    • 使用Jetpack (AndroidX) ，其中包括滿足以下版本要求：
      • com.android.tools.build:gradle v7.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圖示 ( ) 或新增應用程式以啟動設定工作流程。

  3. 在Android 套件名稱欄位中輸入應用程式的套件名稱。

  4. （可選）輸入其他應用程式資訊：應用程式暱稱和偵錯簽章憑證 SHA-1 。

  5. 點擊註冊應用程式。

第 3 步：新增 Firebase 設定文件

  1. 下載 Firebase Android 設定檔 ( google-services.json ) 並將其新增至您的應用程式：

    1. 點擊下載 google-services.json以取得您的 Firebase Android 設定檔。

    2. 將設定檔移到應用程式的模組（應用程式層級）根目錄中。

  2. 要讓 Firebase SDK 可以存取google-services.json設定檔中的值，您需要Google services 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.0" 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.0' 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來控制函式庫版本控制。

    啟用分析

    dependencies {
  // ...

  // Import the Firebase BoM
  implementation(platform("com.google.firebase:firebase-bom:32.6.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 開發人員都可以依賴主庫模組（有關詳細信息，請參閱有關此計劃的常見問題解答）。

    未啟用分析

    dependencies {
  // ...

  // Import the Firebase BoM
  implementation(platform("com.google.firebase:firebase-bom:32.6.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 助理新增 Firebase

Firebase 助理將您的應用程式註冊到 Firebase 項目，並將必要的 Firebase 檔案、插件和依賴項添加到您的 Android 項目中 - 所有這些都在 Android Studio 中完成！

  1. 在 Android Studio 中開啟您的 Android 項目，然後確保您使用的是最新版本的 Android Studio 和 Firebase Assistant：

    • Windows / Linux：幫助 > 檢查更新
    • macOS： Android Studio > 檢查更新

  2. 開啟 Firebase 助理：工具 > Firebase 。

  3. 在「助手」窗格中，選擇要新增至您的應用程式的 Firebase 產品。展開其部分，然後按一下教學連結（例如，分析 > 記錄分析事件）。

    1. 按一下「連接到 Firebase」以將您的 Android 專案與 Firebase 連線。

    2. 按一下按鈕以新增所需的 Firebase 產品（例如，將 Analytics 新增至您的應用程式）。

  4. 同步您的應用程式以確保所有依賴項都具有必要的版本。

  5. 在「助手」窗格中，請依照所選 Firebase 產品的其餘設定說明進行操作。

  6. 透過 Firebase 助理添加任意數量的其他 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 版本的發行說明。

 32.6.0
AdMob com.google.android.gms:播放服務廣告22.5.0
分析com.google.firebase:firebase-analytics 21.5.0
應用程式檢查自訂提供者com.google.firebase:firebase-appcheck 17.1.1
應用程式檢查調試提供者com.google.firebase:firebase-appcheck-debug 17.1.1
應用程式檢查播放完整性提供者com.google.firebase:firebase-appcheck-playintegrity 17.1.1
應用程式分發com.google.firebase:firebase-appdistribution 16.0.0-beta11
應用程式分發API com.google.firebase:firebase-appdistribution-api 16.0.0-beta11
應用程式分發插件com.google.firebase:firebase-appdistribution-gradle 4.0.1
驗證com.google.firebase:firebase-auth 22.3.0
雲端Firestore com.google.firebase:firebase-firestore 24.9.1
Firebase 用戶端 SDK 的雲端函數com.google.firebase:firebase-functions 20.4.0
雲端訊息傳遞com.google.firebase:firebase-訊息傳遞23.3.1
雲端儲存com.google.firebase:firebase-存儲20.3.0
崩潰解決方案com.google.firebase:firebase-crashlytics 18.6.0
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 18.6.0
Crashlytics 插件com.google.firebase:firebase-crashlytics-gradle 2.9.9
動態功能模組支持com.google.firebase:firebase-動態模組-支持16.0.0-beta03
動態連結com.google.firebase:firebase-動態鏈接21.2.0
應用程式內訊息傳遞com.google.firebase:firebase-inappmessaging 20.4.0
（必需的）
應用程式內訊息顯示com.google.firebase:firebase-inappmessaging-display 20.4.0
（必需的）
Firebase 安裝com.google.firebase:firebase-安裝17.2.0
Firebase ML 模型下載器 API com.google.firebase:firebase-ml-modeldownloader 24.2.1
效能監控com.google.firebase:firebase-perf 20.5.1
效能監控插件com.google.firebase:perf-plugin 1.4.2
即時資料庫com.google.firebase:firebase-資料庫20.3.0
遠端配置com.google.firebase:firebase-config 21.6.0
Google Play 服務插件com.google.gms:Google服務4.4.0
已棄用的函式庫
應用程式檢查 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 21.5.0
應用程式檢查自訂提供者com.google.firebase:firebase-appcheck-ktx 17.1.1
應用程式分發 API com.google.firebase:firebase-appdistribution-api-ktx 16.0.0-beta11
驗證com.google.firebase:firebase-auth-ktx 22.3.0
雲端Firestore com.google.firebase:firebase-firestore-ktx 24.9.1
Firebase 用戶端 SDK 的雲端函數com.google.firebase:firebase-functions-ktx 20.4.0
雲端訊息傳遞com.google.firebase:firebase-messaging-ktx 23.3.1
雲端儲存com.google.firebase:firebase-storage-ktx 20.3.0
崩潰解決方案com.google.firebase:firebase-crashlytics-ktx 18.6.0
動態連結com.google.firebase:firebase-動態連結-ktx 21.2.0
應用程式內訊息傳遞com.google.firebase:firebase-inappmessaging-ktx 20.4.0
（必需的）
應用程式內訊息顯示com.google.firebase:firebase-inappmessaging-display-ktx 20.4.0
（必需的）
Firebase 安裝com.google.firebase:firebase-installations-ktx 17.2.0
Firebase ML 模型下載器 API com.google.firebase:firebase-ml-modeldownloader-ktx 24.2.1
效能監控com.google.firebase:firebase-perf-ktx 20.5.1
即時資料庫com.google.firebase:firebase-database-ktx 20.3.0
遠端配置com.google.firebase:firebase-config-ktx 21.6.0

Firebase ML Kit 函式庫

Firebase ML 自訂模型 API com.google.firebase:firebase-ml-model-interpreter 22.0.4
Firebase ML 視覺 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：自然語言 API com.google.firebase:firebase-ml-自然語言22.0.1
Firebase ML：語言辨識模型com.google.firebase:firebase-ml-自然語言-語言-id-模型20.0.8
Firebase ML：翻譯模型com.google.firebase:firebase-ml-自然語言-翻譯模型20.0.9
Firebase ML：智慧回覆模型com.google.firebase:firebase-ml-natural-language-smart-reply-model 20.0.8


下一步

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

了解 Firebase：