將 Firebase 添加到您的 Android 項目

前提條件

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

• 確保您的 Android 應用符合以下條件：

  • 目標爲 API 級別 16 (Jelly Bean) 或更高版本
  • 使用 Gradle 4.1 或更高版本

• 設置可用於運行應用的設備或模擬器。

  • 模擬器必須使用具有 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 項目。

創建 Firebase 項目

第 2 步：在 Firebase 中註冊您的應用

擁有 Firebase 項目後，您就可以向其中添加 Android 應用了。

訪問瞭解 Firebase 項目以詳細瞭解將應用添加到 Firebase 項目的最佳做法和注意事項，包括如何處理多個應用版本。

1. 在 Firebase 控制檯的項目概覽頁面的中心位置，點擊 Android 圖標以啓動設置工作流。

   如果您已向 Firebase 項目添加了應用，請點擊添加應用以顯示平臺選項。

2. 在 Android 軟件包名稱字段中輸入您的應用 ID。

   確保輸入應用實際使用的 ID。在向 Firebase 項目註冊應用後，將無法添加或修改此值。

   • “應用 ID”有時被稱爲“軟件包名稱”。

   • 在您的模塊（應用級）Gradle 文件（通常是 app/build.gradle）中找到此應用 ID（如 ID：com.yourcompany.yourproject）。

3. （可選）根據設置工作流的提示輸入其他應用信息。

   別名是方便內部使用的標識符，只有您能在 Firebase 控制檯中看到。

   注意：Firebase 身份驗證（使用 Google 登錄或電話號碼登錄功能時）和 Firebase 動態鏈接需要 SHA-1 信息。

4. 點擊註冊應用。

第 3 步：添加 Firebase 配置文件

1. 將 Firebase Android 配置文件添加到您的應用：

   1. 點擊下載 google-services.json 以獲取 Firebase Android 配置文件 (google-services.json)。

      • 您可以隨時再次下載 Firebase Android 配置文件。
      • 請確保該配置文件名未附加其他字符，如 (2)。

   2. 接着將配置文件移動到應用的模塊（應用級）目錄中。

   注意：該 Firebase 配置文件包含項目的唯一、非機密標識符。
   訪問瞭解 Firebase 項目以詳細瞭解此配置文件。

2. 要在 Android 應用中啓用 Firebase 產品，請將 Google 服務插件添加到 Gradle 文件中。

   1. 在根級（項目級）Gradle 文件 (build.gradle) 中添加相應規則，以包含 Google 服務插件。此外，請確認您是否擁有 Google 的 Maven 代碼庫。

      buildscript {
      
        repositories {
          // Check that you have the following line (if not, add it):
          google()  // Google's Maven repository
        }
      
        dependencies {
          // ...
      
          // Add the following line:
          classpath 'com.google.gms:google-services:4.2.0'  // Google Services plugin
        }
      }
      
      allprojects {
        // ...
      
        repositories {
          // Check that you have the following line (if not, add it):
          google()  // Google's Maven repository
          // ...
        }
      }
      

       

   2. 在您的模塊（應用級）Gradle 文件（通常是 app/build.gradle）中，在文件末尾添加一行內容。

      apply plugin: 'com.android.application'
      
      android {
        // ...
      }
      
      // Add the following line to the bottom of the file:
      apply plugin: 'com.google.gms.google-services'  // Google Play services Gradle plugin
      

       

第 4 步：將 Firebase SDK 添加到您的應用

您可以將任何受支持的 Firebase 產品添加到 Android 應用中。我們建議您先從添加核心 Firebase SDK (com.google.firebase:firebase-core) 開始，該產品提供有 Google Analytics for Firebase 功能。

1. 在您的模塊（應用級）Gradle 文件（通常是 app/build.gradle）中，添加核心 Firebase SDK 的依賴項：

   dependencies {
    // ...
    implementation 'com.google.firebase:firebase-core:17.0.0'
   
    // Getting a "Could not find" error? Make sure that you've added
    // Google's Maven repository to your root-level build.gradle file
   }
   

    

2. （可選）添加您要使用的其他 Firebase 庫的依賴項。

   一些適用於 Android 的 Firebase SDK 提供了備選 Kotlin 擴展程序庫。

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

4. 運行您的應用，向 Firebase 發送您已成功集成 Firebase 的驗證信息。

   您的設備日誌將顯示說明初始化已完成的 Firebase 驗證信息。如果您是在具有網絡訪問權限的模擬器上運行應用，則 Firebase 控制檯會通知您應用連接已完成。

大功告成！您可以跳至後續步驟了。

選項 2：使用 Firebase Assistant 添加 Firebase

Firebase Assistant 可在 Firebase 項目中註冊您的應用，並將必要的 Firebase 文件和代碼添加到您的 Android 項目中 - 所有這些都在 Android Studio 中完成。

注意：使用 Firebase Assistant 時，請認真按照本指南這部分中所述的步驟檢查所有依賴項和設置是否均已正確配置。

請注意，建議的做法是使用 Firebase 控制檯設置工作流將應用關聯至 Firebase。

1. 在 Android Studio 中打開您的 Android 項目。

2. 依次選擇 Tools > Firebase 以打開 Assistant 窗口。

3. 展開所列 Firebase 產品之一（例如 Analytics），然後點擊所提供的教程鏈接（例如“Log an Analytics event”）。

4. 點擊 Connect to Firebase 以在已有或新的 Firebase 項目中註冊您的應用，並自動向您的 Android 項目添加必要的文件和代碼。

5. 檢查您的插件和庫版本是否最新：

   • 在根級（項目級）Gradle 文件 (build.gradle) 中，檢查您的 Google 服務插件版本是否爲最新版本 (com.google.gms:google-services:4.2.0)。

   • 在您的模塊（應用級）Gradle 文件（通常是 app/build.gradle）中，檢查您的 Firebase Android 庫版本是否爲最新版本。

   注意：如果您使用的是 Android Studio 3.2 版或更早版本，也請確保每個依賴項行僅指定了一個版本號。

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

7. 在 Firebase 控制檯項目設置中配置您的 Analytics 數據共享設置。 
   要使用 Firebase 預測或 Firebase A/B 測試等 Firebase 產品，必須允許與其他 Firebase 產品共享 Analytics 數據。

8. 運行您的應用，向 Firebase 發送您已成功集成 Firebase 的驗證信息。

   您的設備日誌將顯示說明初始化已完成的 Firebase 驗證信息。如果您是在具有網絡訪問權限的模擬器上運行應用，則 Firebase 控制檯會通知您應用連接已完成。

可用的庫

下面列出了各 Firebase 產品可使用的 Android 庫。

一些適用於 Android 的 Firebase SDK 提供了備選 Kotlin 擴展程序庫。

服務或產品	Gradle 依賴項行
Google Play 服務插件	com.google.gms:google-services:4.2.0
AdMob	com.google.firebase:firebase-ads:18.0.0
Analytics	com.google.firebase:firebase-core:17.0.0
App Indexing	com.google.firebase:firebase-appindexing:19.0.0
身份驗證	com.google.firebase:firebase-auth:18.0.0
Cloud Firestore	com.google.firebase:firebase-firestore:20.0.0
Cloud Functions for Firebase 客戶端 SDK	com.google.firebase:firebase-functions:18.0.0
雲消息傳遞	com.google.firebase:firebase-messaging:19.0.0
Cloud Storage	com.google.firebase:firebase-storage:18.0.0
Crashlytics	com.crashlytics.sdk.android:crashlytics:2.10.1
動態鏈接	com.google.firebase:firebase-dynamic-links:18.0.0
應用內消息	com.google.firebase:firebase-inappmessaging:18.0.0
應用內消息顯示	com.google.firebase:firebase-inappmessaging-display:18.0.0
機器學習套件：Vision API	com.google.firebase:firebase-ml-vision:21.0.0
機器學習套件：圖片標籤模型	com.google.firebase:firebase-ml-vision-image-label-model:18.0.0
機器學習套件：人臉檢測模型	com.google.firebase:firebase-ml-vision-face-model:18.0.0
機器學習套件：對象檢測和跟蹤模型	com.google.firebase:firebase-ml-vision-object-detection-model:17.0.0
機器學習套件：Natural Language API	com.google.firebase:firebase-ml-natural-language:20.0.0
機器學習套件：語言識別模型	com.google.firebase:firebase-ml-natural-language-language-id-model:20.0.0
機器學習套件：翻譯模型	com.google.firebase:firebase-ml-natural-language-translate-model:20.0.0
機器學習套件：智能回覆模型	com.google.firebase:firebase-ml-natural-language-smart-reply-model:20.0.0
機器學習套件：自定義模型 API	com.google.firebase:firebase-ml-model-interpreter:20.0.0
機器學習套件：AutoML Vision Edge API	com.google.firebase:firebase-ml-vision-automl:17.0.0
性能監控	com.google.firebase:firebase-perf:18.0.0
實時數據庫	com.google.firebase:firebase-database:18.0.0
遠程配置	com.google.firebase:firebase-config:18.0.0

使用 Firebase 物料清單 (BoM) 進行庫版本控制（實驗性功能）

爲便於進行庫版本管理，請考慮導入 Firebase 物料清單 (BoM)。

使用 Firebase BoM 將 Firebase SDK 添加到您的應用

後續步驟

瞭解 Firebase：

• 訪問瞭解 Firebase 項目以詳細瞭解 Firebase 項目和項目的最佳做法。

• 探索 Firebase 應用示例。

• 藉助 Firebase Android Codelab 獲得實際上手經驗。

• 報名參加週末學 Firebase 課程，加深對 Firebase 的瞭解。

• 準備啓動您的應用：

  • 設置結算提醒。
  • 查看 Firebase 發佈覈對清單。

爲您的應用添加 Firebase 功能：

• 藉助 Analytics 深入分析用戶行爲。

• 使用身份驗證設置用戶身份驗證流程。

• 使用 Cloud Firestore 或實時數據庫存儲數據（如用戶信息）。

• 使用 Cloud Storage 存儲文件，如照片和視頻。

• 使用 Cloud Functions 函數觸發在安全環境中運行的後端代碼。

• 藉助雲消息傳遞功能發送通知。

• 藉助 Crashlytics 確定應用崩潰的時間和原因。