Catch up on everything announced at Firebase Summit, and learn how Firebase can help you accelerate app development and run your app with confidence. Learn More

將 Firebase 添加到您的 Android 項目

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

先決條件

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

  • 確保您的項目滿足以下要求:

    • 目標 API 級別 19 (KitKat) 或更高級別
    • 使用 Android 4.4 或更高版本
    • 使用Jetpack (AndroidX) ,其中包括滿足以下版本要求:
      • com.android.tools.build:gradle v3.2.1 或更高版本
      • compileSdkVersion 28 或更高版本
  • 設置物理設備或使用模擬器來運行您的應用程序。
    請注意,依賴於 Google Play 服務的 Firebase SDK要求設備或模擬器安裝 Google Play 服務。

  • 使用您的 Google 帳戶登錄 Firebase

如果您還沒有 Android 項目並且只想試用 Firebase 產品,您可以下載我們的快速入門示例之一。


您可以使用以下選項之一將您的 Android 應用程序連接到 Firebase:

  • 選項 1 :(推薦)使用 Firebase 控制台設置工作流程。
  • 選項 2 :使用 Android Studio Firebase 助手(可能需要額外的配置)。



選項 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. 要使google-services.json配置文件中的值可供 Firebase SDK 訪問,您需要Google 服務 Gradle 插件( google-services )。

    1. 在您的根級(項目級) Gradle 文件 ( <project>/build.gradle ) 中,將 Google 服務插件添加為構建腳本依賴項:

      buildscript {
      
          repositories {
            // Make sure that you have the following two repositories
            google()  // Google's Maven repository
            mavenCentral()  // Maven Central repository
          }
      
          dependencies {
            ...
      
            // Add the dependency for the Google services Gradle plugin
            classpath 'com.google.gms:google-services:4.3.14'
          }
      }
      
      allprojects {
        ...
      
        repositories {
          // Make sure that you have the following two repositories
          google()  // Google's Maven repository
          mavenCentral()  // Maven Central repository
        }
      }
      
    2. 在您的模塊(應用程序級別) Gradle 文件(通常是<project>/<app-module>/build.gradle )中,添加 Google 服務插件:

      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 )中,添加您要在應用程序中使用的Firebase 產品的依賴項。我們建議使用Firebase Android BoM來控制庫版本。

    啟用分析

    Java

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation platform('com.google.firebase:firebase-bom:31.1.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'
    }
    

    Kotlin+KTX

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation platform('com.google.firebase:firebase-bom:31.1.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-ktx'
    
      // 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-ktx'
      implementation 'com.google.firebase:firebase-firestore-ktx'
    }
    

    通過使用Firebase Android BoM ,您的應用將始終使用兼容版本的 Firebase Android 庫。

    未啟用分析

    Java

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation platform('com.google.firebase:firebase-bom:31.1.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'
    }
    

    Kotlin+KTX

    dependencies {
      // ...
    
      // Import the Firebase BoM
      implementation platform('com.google.firebase:firebase-bom:31.1.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-ktx'
      implementation 'com.google.firebase:firebase-firestore-ktx'
    }
    

    通過使用Firebase Android BoM ,您的應用將始終使用兼容版本的 Firebase Android 庫。

  2. 添加您要使用的產品的依賴項後,將您的 Android 項目與 Gradle 文件同步。

而已!您可以向前跳到查看建議的後續步驟

不過,如果您在設置時遇到問題,請訪問Android 故障排除和常見問題解答



選項 2 :使用 Firebase 助手添加 Firebase

Firebase 助手將您的應用程序註冊到 Firebase 項目,並將必要的 Firebase 文件、插件和依賴項添加到您的 Android 項目——所有這些都在 Android Studio 中完成!

  1. 在 Android Studio 中打開您的 Android 項目,然後確保您使用的是最新版本的 Android Studio 和 Firebase 助手:

    • Windows / Linux:幫助 > 檢查更新
    • macOS: Android Studio > 檢查更新
  2. 打開 Firebase 助手:工具 > Firebase

  3. 在“助手”窗格中,選擇要添加到您的應用程序的 Firebase 產品。展開其部分,然後單擊教程鏈接(例如, Analytics > Log an Analytics event )。

    1. 單擊連接到 Firebase以將您的 Android 項目連接到 Firebase。

    2. 單擊按鈕添加所需的 Firebase 產品(例如,將分析添加到您的應用程序)。

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

  5. 在“助手”窗格中,按照所選 Firebase 產品的其餘設置說明進行操作。

  6. 通過 Firebase 助手添加任意數量的其他 Firebase 產品!

而已!請務必查看推薦的後續步驟

不過,如果您在設置時遇到問題,請訪問Android 故障排除和常見問題解答



可用庫

本部分列出了 Android 支持的 Firebase 產品及其 Gradle 依賴項。詳細了解這些 Firebase Android 庫:

請注意,使用Firebase Android BoM時,您在build.gradle中聲明 Firebase 庫依賴項時無需指定各個庫版本。

Java

服務或產品搖籃依賴最新的
版本
添加分析?
Firebase Android 物料清單
(材料清單)
com.google.firebase:firebase-bom

最新的 Firebase BoM 版本包含每個 Firebase Android 庫的最新版本。要了解哪些庫版本映射到特定的 BoM 版本,請查看該 BoM 版本的發行說明。

31.1.0
AdMob com.google.android.gms:play-services-ads 21.3.0
分析com.google.firebase:firebase 分析21.2.0
App Check 自定義提供商com.google.firebase:firebase-appcheck 16.1.0
App Check 調試提供程序com.google.firebase:firebase-appcheck-debug 16.1.0
App Check Play 完整性提供商com.google.firebase:firebase-appcheck-playintegrity 16.1.0
App Check SafetyNet 提供商com.google.firebase:firebase-appcheck-safetynet 16.1.0
應用分發com.google.firebase:firebase-appdistribution 16.0.0-beta05
應用程序分發 API com.google.firebase:firebase-appdistribution-api 16.0.0-beta05
應用分發插件com.google.firebase:firebase-appdistribution-gradle 3.1.1
驗證com.google.firebase:firebase-auth 21.1.0
雲端 Firestore com.google.firebase:firebase-firestore 24.4.1
Firebase 客戶端 SDK 的雲函數com.google.firebase:firebase 函數20.2.1
雲消息com.google.firebase:firebase 消息23.1.0
雲儲存com.google.firebase:firebase 存儲20.1.0
崩潰分析com.google.firebase:firebase-crashlytics 18.3.2
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 18.3.2
Crashlytics 插件com.google.firebase:firebase-crashlytics-gradle 2.9.2
動態特性模塊支持com.google.firebase:firebase 動態模塊支持16.0.0-beta03
動態鏈接com.google.firebase:firebase 動態鏈接21.1.0
應用內消息com.google.firebase:firebase-inappmessaging 20.2.0
(必需的)
應用內消息顯示com.google.firebase:firebase-inappmessaging-display 20.2.0
(必需的)
Firebase 安裝com.google.firebase:firebase 安裝17.1.0
Firebase ML 模型下載器 API com.google.firebase:firebase-ml-modeldownloader 24.1.1
性能監控com.google.firebase:firebase-perf 20.3.0
性能監控插件com.google.firebase:性能插件1.4.2
實時數據庫com.google.firebase:firebase 數據庫20.1.0
遠程配置com.google.firebase:firebase 配置21.2.0
Google Play 服務插件com.google.gms:google 服務4.3.14
棄用的庫
應用索引com.google.firebase:firebase-appindexing 20.0.0
Firebase ML 自定義模型 API com.google.firebase:firebase-ml-model-interpreter 22.0.4
Firebase 機器學習視覺 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 邊緣 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-自然語言-智能回复模型20.0.8

Kotlin+KTX

服務或產品搖籃依賴最新的
版本
添加分析?
Firebase Android 物料清單
(材料清單)
com.google.firebase:firebase-bom

最新的 Firebase BoM 版本包含每個 Firebase Android 庫的最新版本。要了解哪些庫版本映射到特定的 BoM 版本,請查看該 BoM 版本的發行說明。

31.1.0
AdMob com.google.android.gms:play-services-ads 21.3.0
分析com.google.firebase:firebase-analytics-ktx 21.2.0
App Check 自定義提供商com.google.firebase:firebase-appcheck-ktx 16.1.0
App Check 調試提供程序com.google.firebase:firebase-appcheck-debug 16.1.0
App Check SafetyNet 提供商com.google.firebase:firebase-appcheck-safetynet 16.1.0
應用程序分發 API com.google.firebase:firebase-appdistribution-api-ktx 16.0.0-beta05
應用分發插件com.google.firebase:firebase-appdistribution-gradle 3.1.1
驗證com.google.firebase:firebase-auth-ktx 21.1.0
雲端 Firestore com.google.firebase:firebase-firestore-ktx 24.4.1
Firebase 客戶端 SDK 的雲函數com.google.firebase:firebase-functions-ktx 20.2.1
雲消息com.google.firebase:firebase-消息-ktx 23.1.0
雲儲存com.google.firebase:firebase-storage-ktx 20.1.0
崩潰分析com.google.firebase:firebase-crashlytics-ktx 18.3.2
Crashlytics NDK com.google.firebase:firebase-crashlytics-ndk 18.3.2
Crashlytics 插件com.google.firebase:firebase-crashlytics-gradle 2.9.2
動態特性模塊支持com.google.firebase:firebase 動態模塊支持16.0.0-beta03
動態鏈接com.google.firebase:firebase-動態鏈接-ktx 21.1.0
應用內消息com.google.firebase:firebase-inappmessaging-ktx 20.2.0
(必需的)
應用內消息顯示com.google.firebase:firebase-inappmessaging-display-ktx 20.2.0
(必需的)
Firebase 安裝com.google.firebase:firebase-安裝-ktx 17.1.0
Firebase ML 模型下載器 API com.google.firebase:firebase-ml-modeldownloader-ktx 24.1.1
性能監控com.google.firebase:firebase-perf-ktx 20.3.0
性能監控插件com.google.firebase:性能插件1.4.2
實時數據庫com.google.firebase:firebase-數據庫-ktx 20.1.0
遠程配置com.google.firebase:firebase-config-ktx 21.2.0
Google Play 服務插件com.google.gms:google 服務4.3.14
棄用的庫
應用索引com.google.firebase:firebase-appindexing 20.0.0
Firebase ML 自定義模型 API com.google.firebase:firebase-ml-model-interpreter 22.0.4
Firebase 機器學習視覺 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 邊緣 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-自然語言-智能回复模型20.0.8



下一步

將 Firebase 服務添加到您的應用:

了解 Firebase: