將應用程式連結至 Firebase

如果您尚未將 Firebase 新增至 Android 專案，請新增 Firebase。

建立資料庫

1. 前往 Firebase 控制台的 Realtime Database 專區。系統會提示您選取現有的 Firebase 專案。按照資料庫建立工作流程操作。

2. 為 Firebase Security Rules 選取起始模式：

   測試模式

   適合開始使用行動和網路用戶端程式庫，但允許任何人讀取及覆寫您的資料。測試完成後，請務必詳閱「瞭解 Firebase 即時資料庫規則」一節。

   注意： 如果您在測試模式下建立資料庫，且在試用期內未對預設的公開可讀和公開可寫 Rules 進行任何變更，系統會透過電子郵件通知您，然後資料庫規則會拒絕所有要求。請注意 Firebase 主控台設定流程中的到期日。

   如要開始使用網路、Apple 或 Android SDK，請選取 testmode。

   鎖定模式

   拒絕行動和網路用戶端的所有讀寫要求。已驗證的應用程式伺服器仍可存取資料庫。

3. 選擇資料庫的位置。

   視資料庫的位置而定，新資料庫的網址會採用下列任一形式：

   • DATABASE_NAME.firebaseio.com (適用於 us-central1 中的資料庫)

   • DATABASE_NAME.REGION.firebasedatabase.app (適用於所有其他位置的資料庫)

4. 點選「完成」。

啟用 Realtime Database 時，也會在 Cloud API Manager 中啟用 API。

在應用程式中加入 Realtime Database SDK

在模組 (應用程式層級) Gradle 檔案 (通常為 <project>/<app-module>/build.gradle.kts 或 <project>/<app-module>/build.gradle) 中，加入 Android 的 Realtime Database 程式庫依附元件。建議您使用 Firebase Android BoM 來控制程式庫版本。

dependencies {
    // Import the BoM for the Firebase platform
    implementation(platform("com.google.firebase:firebase-bom:33.7.0"))

    // Add the dependency for the Realtime Database library
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-database")
}

只要使用 Firebase Android BoM，應用程式就會一律使用相容的 Firebase Android 程式庫版本。

(替代做法)  不使用 BoM 新增 Firebase 程式庫依附元件

如果您選擇不使用 Firebase BoM，則必須在依附元件行中指定每個 Firebase 程式庫版本。

請注意，如果您在應用程式中使用多個 Firebase 程式庫，強烈建議您使用 BoM 來管理程式庫版本，確保所有版本皆相容。

dependencies {
    // Add the dependency for the Realtime Database library
    // When NOT using the BoM, you must specify versions in Firebase library dependencies
    implementation("com.google.firebase:firebase-database:21.0.0")
}

想尋找 Kotlin 專屬的程式庫模組嗎？自 2023 年 10 月 (Firebase BoM 32.5.0)起，Kotlin 和 Java 開發人員都可以依附主要程式庫模組 (詳情請參閱這項計畫的常見問題)。

設定「Realtime Database Security Rules」

Realtime Database 提供宣告式規則語言，可讓您定義資料的結構、索引方式，以及資料可讀取及寫入的時機。

注意： 根據預設，資料庫的讀取和寫入存取權會受到限制，因此只有經過驗證的使用者才能讀取或寫入資料。如要開始使用，無須設定 Authentication，您可以設定公開存取規則。這樣一來，任何人 (包括未使用應用程式的使用者) 都能存取資料庫，因此請務必在設定驗證機制時再次限制資料庫。

寫入資料庫

使用 getInstance() 擷取資料庫的例項，並參照要寫入的位置。

重要事項：如要取得 us-central1 預設資料庫以外的資料庫參照，您必須將資料庫網址傳遞至 getInstance() (或 Kotlin 的 database())。如果是 us-central1 預設資料庫，您可以不帶參數呼叫 getInstance() (或 database)。

您可以在 Firebase 控制台的 Realtime Database 專區中找到 Realtime Database 網址。視資料庫的位置而定，資料庫網址會採用下列任一格式：

• https://DATABASE_NAME.firebaseio.com (適用於 us-central1 中的資料庫)
• https://DATABASE_NAME.REGION.firebasedatabase.app (適用於所有其他位置的資料庫)

Kotlin

// Write a message to the database
val database = Firebase.database
val myRef = database.getReference("message")

myRef.setValue("Hello, World!")
MainActivity.kt

Java

// Write a message to the database
FirebaseDatabase database = FirebaseDatabase.getInstance();
DatabaseReference myRef = database.getReference("message");

myRef.setValue("Hello, World!");
MainActivity.java

您可以透過這種方式將一系列資料類型儲存至資料庫，包括 Java 物件。儲存物件時，任何 getter 的回應都會儲存為此位置的子項。

讀取資料庫

如要讓應用程式資料即時更新，請在剛建立的參照中新增 ValueEventListener。

這個類別中的 onDataChange() 方法會在連結監聽器時觸發一次，並且在資料 (包括子項) 變更時再次觸發。

Kotlin

// Read from the database
myRef.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(dataSnapshot: DataSnapshot) {
        // This method is called once with the initial value and again
        // whenever data at this location is updated.
        val value = dataSnapshot.getValue<String>()
        Log.d(TAG, "Value is: $value")
    }

    override fun onCancelled(error: DatabaseError) {
        // Failed to read value
        Log.w(TAG, "Failed to read value.", error.toException())
    }
})
MainActivity.kt

Java

// Read from the database
myRef.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot dataSnapshot) {
        // This method is called once with the initial value and again
        // whenever data at this location is updated.
        String value = dataSnapshot.getValue(String.class);
        Log.d(TAG, "Value is: " + value);
    }

    @Override
    public void onCancelled(@NonNull DatabaseError error) {
        // Failed to read value
        Log.w(TAG, "Failed to read value.", error.toException());
    }
});
MainActivity.java

選用步驟：設定 ProGuard

在應用程式中使用 Firebase Realtime Database 和 ProGuard 時，您需要考量如何在模糊處理後序列化和反序列化模型物件。如果您使用 DataSnapshot.getValue(Class) 或 DatabaseReference.setValue(Object) 讀取及寫入資料，就必須在 proguard-rules.pro 檔案中新增規則：

    # Add this global rule
    -keepattributes Signature

    # This rule will properly ProGuard all the model classes in
    # the package com.yourcompany.models.
    # Modify this rule to fit the structure of your app.
    -keepclassmembers class com.yourcompany.models.** {
      *;
    }

如有 ProGuard 相關問題或需要協助，請前往 Guardsquare 社群論壇尋求專家協助。

準備發布

建議您在推出應用程式前，先完成推出檢查清單，確保應用程式已準備就緒！

請務必啟用 App Check，確保只有您的應用程式可以存取資料庫。

後續步驟

• 瞭解如何為 Realtime Database 結構化資料
• 跨多個資料庫執行個體擴充資料。
• 讀取及寫入資料。
• 在 Firebase 控制台查看資料庫。