將 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 項目的更多信息。

創建一個 Firebase 項目

1. 在Firebase 控制台中，單擊添加項目。

   • 要將 Firebase 資源添加到現有的Google Cloud 項目，請輸入其項目名稱或從下拉菜單中選擇它。

   • 要創建新項目，請輸入所需的項目名稱。您還可以選擇編輯項目名稱下方顯示的項目 ID。

2. 如果出現提示，請查看並接受Firebase 條款。

3. 單擊繼續。

4. （可選）為您的項目設置 Google Analytics，這使您能夠使用以下任何 Firebase 產品獲得最佳體驗：

   Firebase Crashlytics Firebase 預測

   Firebase 雲消息傳遞 Firebase 應用內消息

   Firebase 遠程配置 Firebase A/B 測試

   選擇現有的Google Analytics 帳戶或創建一個新帳戶。

   如果您創建一個新帳戶，請選擇您的Analytics 報告位置，然後接受您項目的數據共享設置和 Google Analytics 條款。

5. 點擊創建項目（或添加 Firebase ，如果您使用的是現有的 Google Cloud 項目）。

Firebase 會自動為您的 Firebase 項目配置資源。該過程完成後，您將被帶到 Firebase 控制台中您的 Firebase 項目的概覽​​頁面。

第 2 步：向 Firebase 註冊您的應用

要在您的 Android 應用中使用 Firebase，您需要在您的 Firebase 項目中註冊您的應用。註冊您的應用程序通常稱為將您的應用程序“添加”到您的項目中。

1. 轉到Firebase 控制台。

2. 在項目概覽頁面的中心，單擊Android圖標 ( plat_android ) 或添加應用程序以啟動設置工作流程。

3. 在Android 包名稱字段中輸入您應用的包名稱。

   什麼是包名，你在哪裡找到它？

   • 包名稱在設備上和 Google Play 商店中唯一標識您的應用程序。

   • 包名稱通常稱為應用程序 ID 。

   • 在模塊（應用級）Gradle 文件中找到應用的包名稱，通常是app/build.gradle （示例包名稱： com.yourcompany.yourproject ）。

   • 請注意，包名稱值區分大小寫，並且在此 Firebase Android 應用註冊到您的 Firebase 項目後無法更改它。

4. （可選）輸入其他應用信息：應用暱稱和調試簽名證書 SHA-1 。

   Firebase 中如何使用App 暱稱和Debug 簽名證書 SHA-1 ？

   • 應用暱稱：僅在 Firebase 控制台中對您可見的內部便利標識符

   • 調試簽名證書 SHA-1 ：Firebase 身份驗證（使用Google 登錄或電話號碼登錄時）和Firebase 動態鏈接需要SHA-1 哈希。

5. 點擊註冊應用。

第 3 步：添加 Firebase 配置文件

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

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

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

   關於這個配置文件你需要知道什麼？

   • Firebase 配置文件包含項目的唯一但非秘密標識符。要了解有關此配置文件的更多信息，請訪問了解 Firebase 項目。

   • 您可以隨時再次下載Firebase 配置文件。

   • 確保配置文件名沒​​有附加其他字符，例如(2) 。

2. 要在您的應用中啟用 Firebase 產品，請將google-services 插件添加到您的 Gradle 文件中。

   1. 在您的根級（項目級）Gradle 文件 ( build.gradle ) 中，添加規則以包含 Google Services Gradle 插件。檢查您是否也有 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.3.10'  // 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 ）中，應用 Google Services Gradle 插件：

      apply plugin: 'com.android.application'
      // Add the following line:
      apply plugin: 'com.google.gms.google-services'  // Google Services plugin
      
      android {
        // ...
      }
      

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

1. 使用Firebase Android BoM聲明要在應用中使用的Firebase 產品的依賴項。在你的模塊（應用級）Gradle 文件（通常是app/build.gradle ）中聲明它們。

   啟用分析

   爪哇

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:29.0.4')
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // Declare the dependency for the Firebase SDK for Google Analytics
     implementation 'com.google.firebase:firebase-analytics'
   
     // Declare the dependencies for any other desired Firebase products
     // For example, declare the dependencies for Firebase Authentication and Cloud Firestore
     implementation 'com.google.firebase:firebase-auth'
     implementation 'com.google.firebase:firebase-firestore'
   }
   

   科特林+KTX

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:29.0.4')
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // Declare the dependency for the Firebase SDK for Google Analytics
     implementation 'com.google.firebase:firebase-analytics-ktx'
   
     // Declare the dependencies for any other desired Firebase products
     // For example, declare 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 庫。

   未啟用分析

   爪哇

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:29.0.4')
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // Declare the dependencies for the desired Firebase products
     // For example, declare the dependencies for Firebase Authentication and Cloud Firestore
     implementation 'com.google.firebase:firebase-auth'
     implementation 'com.google.firebase:firebase-firestore'
   }
   

   科特林+KTX

   dependencies {
     // ...
   
     // Import the Firebase BoM
     implementation platform('com.google.firebase:firebase-bom:29.0.4')
   
     // When using the BoM, you don't specify versions in Firebase library dependencies
   
     // Declare the dependencies for the desired Firebase products
     // For example, declare 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 插件 (AGP) v4.2 或更早版本的 Gradle 構建需要啟用 Java 8 支持。否則，這些 Android 項目在添加 Firebase SDK 時會出現構建失敗。

   要修復此構建失敗，您可以遵循以下兩個選項之一：

   • 將錯誤消息中列出的compileOptions添加到您的應用程序級build.gradle文件中。
   • 將您的 Android 項目的minSdkVersion增加到 26 或更高。

   在此常見問題解答中了解有關此構建失敗的更多信息。

而已！您可以直接跳過以查看推薦的後續步驟。

但是，如果您在設置時遇到問題，請訪問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 產品。展開其部分，然後單擊教程鏈接（例如，分析 > 記錄分析事件）。

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

      這個工作流程有什麼作用？

      • 此工作流程會使用您應用的包名稱自動創建一個新的 Firebase Android 應用。您可以在現有 Firebase 項目或新項目中創建這個新的 Firebase Android 應用。

        以下是有關設置 Firebase 項目的一些提示：

        • 訪問了解 Firebase 項目，詳細了解將應用添加到 Firebase 項目的最佳做法和注意事項，包括如何處理多個構建變體。

        • 如果您創建一個新項目，我們強烈建議您為您的項目設置 Google Analytics，這使您能夠獲得使用許多 Firebase 產品的最佳體驗。

      • 此工作流程還將您的 Firebase 項目的 Android 配置文件 ( google-services.json ) 添加到您應用的模塊（應用級）目錄中。

   2. 點擊按鈕添加所需的 Firebase 產品（例如，將分析添加到您的應用）。

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

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

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

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

但是，如果您在設置時遇到問題，請訪問Android 故障排除和常見問題解答。

---

可用庫

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

• 參考文檔（ Java | Kotlin+KTX ）

• Firebase Android SDK GitHub 存儲庫

請注意，在使用Firebase Android BoM時，當您在build.gradle中聲明 Firebase 庫依賴項時，不要指定單獨的庫版本。

---

下一步

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

• 通過Analytics深入了解用戶行為。

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

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

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

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

• 使用雲消息發送通知。

• 使用Crashlytics了解您的應用程序何時以及為何崩潰。

了解 Firebase：

• 請訪問了解 Firebase 項目，了解有關 Firebase 項目和項目最佳做法的更多信息。

• 如果您對不熟悉或特定於 Firebase 和 Android 開發的概念有疑問，請訪問了解有關 Android 和 Firebase的更多信息。

• 探索示例 Firebase 應用。

• 獲得Firebase Android Codelab的實踐經驗。

• 在周末課程中通過 Firebase了解更多信息。

• 準備啟動您的應用程序：

  • 在 Google Cloud Console 中為您的項目設置預算提醒。
  • 監控 Firebase 控制台中的使用情況和計費信息中心，以全面了解您的項目在多個 Firebase 服務中的使用情況。
  • 查看Firebase 啟動清單。

• Firebase 和您的 Android 項目遇到問題？訪問Android 故障排除和常見問題解答。