在 Android 上讀取及寫入資料

本文將說明讀取及寫入 Firebase 資料的基本概念。

Firebase 資料會寫入 FirebaseDatabase 參照，並透過將非同步事件監聽器附加至參照來擷取。系統會針對資料的初始狀態觸發一次事件監聽器，並在資料變更時再次觸發。

(選用) 使用 Firebase Local Emulator Suite 建立原型並進行測試

在討論應用程式如何讀取和寫入 Realtime Database 之前，我們先介紹一組工具，可用於原型設計和測試 Realtime Database 功能：Firebase Local Emulator Suite。如果您正在嘗試不同的資料模型、最佳化安全性規則，或努力尋找與後端互動最具成本效益的方式，那麼在不部署即時服務的情況下，在本機工作會是個不錯的想法。

Realtime Database 模擬器是 Local Emulator Suite 的一部分，可讓應用程式與模擬的資料庫內容和設定互動，以及模擬的專案資源 (函式、其他資料庫和安全性規則)。

使用 Realtime Database 模擬器只需幾個步驟：

  1. 在應用程式的測試設定中加入一行程式碼，以便連線至模擬器。
  2. 在本機專案目錄的根目錄中，執行 firebase emulators:start。
  3. 照常使用 Realtime Database 平台 SDK，或使用 Realtime Database REST API，從應用程式的原型程式碼發出呼叫。

我們提供涉及 Realtime Database 和 Cloud Functions 的詳細逐步操作說明。此外，建議您查看 Local Emulator Suite 簡介。

取得 DatabaseReference

如要從資料庫讀取或寫入資料，您需要 DatabaseReference 的執行個體：

Kotlin

private lateinit var database: DatabaseReference
// ...
database = Firebase.database.reference

Java

private DatabaseReference mDatabase;
// ...
mDatabase = FirebaseDatabase.getInstance().getReference();

寫入資料

基本寫入作業

如要執行基本寫入作業，可以使用 setValue() 將資料儲存至指定參照，取代該路徑中的任何現有資料。這個方法可用於：

  • 傳遞與可用 JSON 類型對應的類型，如下所示：
    • String
    • Long
    • Double
    • Boolean
    • Map<String, Object>
    • List<Object>
  • 如果定義自訂 Java 物件的類別具有不接受引數的預設建構函式，且具有要指派屬性的公開 getter，則傳遞該物件。

如果您使用 Java 物件，系統會自動以巢狀方式將物件內容對應至子項位置。使用 Java 物件通常也能讓程式碼更易讀、更易於維護。舉例來說，如果您的應用程式具有基本使用者個人資料，User 物件可能如下所示：

Kotlin 

@IgnoreExtraProperties
data class User(val username: String? = null, val email: String? = null) {
    // Null default values create a no-argument default constructor, which is needed
    // for deserialization from a DataSnapshot.
}

Java 

@IgnoreExtraProperties
public class User {

    public String username;
    public String email;

    public User() {
        // Default constructor required for calls to DataSnapshot.getValue(User.class)
    }

    public User(String username, String email) {
        this.username = username;
        this.email = email;
    }

}

您可以使用 setValue() 新增使用者，如下所示：

Kotlin 

fun writeNewUser(userId: String, name: String, email: String) {
    val user = User(name, email)

    database.child("users").child(userId).setValue(user)
}

Java 

public void writeNewUser(String userId, String name, String email) {
    User user = new User(name, email);

    mDatabase.child("users").child(userId).setValue(user);
}

以這種方式使用 setValue() 會覆寫指定位置的資料，包括任何子節點。不過，您還是可以更新子項，而不必重寫整個物件。如要允許使用者更新個人資料，可以按照下列方式更新使用者名稱：

Kotlin 

database.child("users").child(userId).child("username").setValue(name)

Java 

mDatabase.child("users").child(userId).child("username").setValue(name);

讀取資料

使用永久監聽器讀取資料

如要讀取路徑中的資料並監聽變更，請使用 addValueEventListener() 方法，將 ValueEventListener 新增至 DatabaseReference。

監聽器 事件回呼 一般用途
ValueEventListener onDataChange() 讀取及監聽路徑中所有內容的變更。

您可以使用 onDataChange() 方法，讀取指定路徑內容的靜態快照，也就是事件發生時的內容。這個方法會在附加事件監聽器時觸發一次，並在每次資料 (包括子項) 變更時再次觸發。事件回呼會傳遞快照，其中包含該位置的所有資料，包括子項資料。如果沒有資料，則在呼叫 exists() 時，快照會傳回 false，而在呼叫 getValue() 時，快照會傳回 null。

以下範例說明社群網誌應用程式如何從資料庫擷取貼文詳細資料：

Kotlin 

val postListener = object : ValueEventListener {
    override fun onDataChange(dataSnapshot: DataSnapshot) {
        // Get Post object and use the values to update the UI
        val post = dataSnapshot.getValue<Post>()
        // ...
    }

    override fun onCancelled(databaseError: DatabaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException())
    }
}
postReference.addValueEventListener(postListener)

Java 

ValueEventListener postListener = new ValueEventListener() {
    @Override
    public void onDataChange(DataSnapshot dataSnapshot) {
        // Get Post object and use the values to update the UI
        Post post = dataSnapshot.getValue(Post.class);
        // ..
    }

    @Override
    public void onCancelled(DatabaseError databaseError) {
        // Getting Post failed, log a message
        Log.w(TAG, "loadPost:onCancelled", databaseError.toException());
    }
};
mPostReference.addValueEventListener(postListener);

事件監聽器會收到 DataSnapshot，其中包含事件發生時資料庫中指定位置的資料。對快照呼叫 getValue() 會傳回資料的 Java 物件表示法。如果該位置沒有任何資料，呼叫 getValue() 會傳回 null。

在本例中，ValueEventListener 也定義了 onCancelled() 方法，如果取消讀取，就會呼叫該方法。舉例來說，如果用戶端沒有從 Firebase 資料庫位置讀取資料的權限，系統可能會取消讀取作業。這個方法會傳遞 DatabaseError 物件，指出失敗原因。

讀取資料一次

使用 get() 讀取一次

無論應用程式是否連上網路，SDK 都能管理與資料庫伺服器的互動。

一般來說，您應使用上述 ValueEventListener 技術讀取資料，以便接收後端資料更新通知。監聽器技術可減少用量和帳單費用，並經過最佳化，可在使用者上線和離線時提供最佳體驗。

如果只需要資料一次，可以使用 get() 從資料庫取得資料快照。如果 get() 因任何原因無法傳回伺服器值，用戶端會探測本機儲存空間快取，如果仍找不到值，則會傳回錯誤。

不必要地使用 get() 可能會增加頻寬使用量，並導致效能降低，但只要使用上述的即時事件監聽器，即可避免這種情況。

Kotlin 

mDatabase.child("users").child(userId).get().addOnSuccessListener {
    Log.i("firebase", "Got value ${it.value}")
}.addOnFailureListener{
    Log.e("firebase", "Error getting data", it)
}

Java 

mDatabase.child("users").child(userId).get().addOnCompleteListener(new OnCompleteListener<DataSnapshot>() {
    @Override
    public void onComplete(@NonNull Task<DataSnapshot> task) {
        if (!task.isSuccessful()) {
            Log.e("firebase", "Error getting data", task.getException());
        }
        else {
            Log.d("firebase", String.valueOf(task.getResult().getValue()));
        }
    }
});

使用事件監聽器讀取一次

在某些情況下，您可能希望立即傳回本機快取的值，而不是檢查伺服器上的更新值。在這種情況下，您可以使用 addListenerForSingleValueEvent 立即從本機磁碟快取取得資料。

如果資料只需要載入一次，且預期不會經常變更或需要主動監聽，就很適合使用這個方法。舉例來說，前述範例中的網誌應用程式會在使用者開始撰寫新文章時，使用這個方法載入使用者個人資料。

更新或刪除資料

更新特定欄位

如要同時寫入節點的特定子項，而不覆寫其他子節點，請使用 updateChildren() 方法。

呼叫 updateChildren() 時，您可以指定鍵的路徑，更新較低層級的子項值。如果資料儲存在多個位置，以便提高擴充性，您可以使用資料展開更新該資料的所有執行個體。舉例來說，社交網誌應用程式可能會有如下的 Post 類別：

Kotlin 

@IgnoreExtraProperties
data class Post(
    var uid: String? = "",
    var author: String? = "",
    var title: String? = "",
    var body: String? = "",
    var starCount: Int = 0,
    var stars: MutableMap<String, Boolean> = HashMap(),
) {

    @Exclude
    fun toMap(): Map<String, Any?> {
        return mapOf(
            "uid" to uid,
            "author" to author,
            "title" to title,
            "body" to body,
            "starCount" to starCount,
            "stars" to stars,
        )
    }
}

Java 

@IgnoreExtraProperties
public class Post {

    public String uid;
    public String author;
    public String title;
    public String body;
    public int starCount = 0;
    public Map<String, Boolean> stars = new HashMap<>();

    public Post() {
        // Default constructor required for calls to DataSnapshot.getValue(Post.class)
    }

    public Post(String uid, String author, String title, String body) {
        this.uid = uid;
        this.author = author;
        this.title = title;
        this.body = body;
    }

    @Exclude
    public Map<String, Object> toMap() {
        HashMap<String, Object> result = new HashMap<>();
        result.put("uid", uid);
        result.put("author", author);
        result.put("title", title);
        result.put("body", body);
        result.put("starCount", starCount);
        result.put("stars", stars);

        return result;
    }
}

如要建立貼文，並同時更新到近期活動動態消息和貼文使用者的活動動態消息，網誌應用程式會使用類似以下的程式碼：

Kotlin 

private fun writeNewPost(userId: String, username: String, title: String, body: String) {
    // Create new post at /user-posts/$userid/$postid and at
    // /posts/$postid simultaneously
    val key = database.child("posts").push().key
    if (key == null) {
        Log.w(TAG, "Couldn't get push key for posts")
        return
    }

    val post = Post(userId, username, title, body)
    val postValues = post.toMap()

    val childUpdates = hashMapOf<String, Any>(
        "/posts/$key" to postValues,
        "/user-posts/$userId/$key" to postValues,
    )

    database.updateChildren(childUpdates)
}

Java 

private void writeNewPost(String userId, String username, String title, String body) {
    // Create new post at /user-posts/$userid/$postid and at
    // /posts/$postid simultaneously
    String key = mDatabase.child("posts").push().getKey();
    Post post = new Post(userId, username, title, body);
    Map<String, Object> postValues = post.toMap();

    Map<String, Object> childUpdates = new HashMap<>();
    childUpdates.put("/posts/" + key, postValues);
    childUpdates.put("/user-posts/" + userId + "/" + key, postValues);

    mDatabase.updateChildren(childUpdates);
}

本例使用 push() 在節點中建立貼文，其中包含 /posts/$postid 所有使用者的貼文，並同時使用 getKey() 擷取金鑰。接著，您可以使用該鍵在 /user-posts/$userid/$postid 的使用者貼文中建立第二個項目。

使用這些路徑，您只要呼叫一次 updateChildren()，就能同時更新 JSON 樹狀結構中的多個位置，例如本範例在兩個位置建立新貼文。以這種方式同時進行的更新是不可分割的：要不所有更新都成功，要不所有更新都失敗。

新增完成回呼

如要瞭解資料何時提交，可以新增完成事件監聽器。setValue() 和 updateChildren() 都會採用選用的完成事件監聽器，在寫入作業成功提交至資料庫時呼叫。如果呼叫失敗，系統會將錯誤物件傳遞給事件監聽器，指出失敗原因。

Kotlin 

database.child("users").child(userId).setValue(user)
    .addOnSuccessListener {
        // Write was successful!
        // ...
    }
    .addOnFailureListener {
        // Write failed
        // ...
    }

Java 

mDatabase.child("users").child(userId).setValue(user)
        .addOnSuccessListener(new OnSuccessListener<Void>() {
            @Override
            public void onSuccess(Void aVoid) {
                // Write was successful!
                // ...
            }
        })
        .addOnFailureListener(new OnFailureListener() {
            @Override
            public void onFailure(@NonNull Exception e) {
                // Write failed
                // ...
            }
        });

刪除資料

如要刪除資料，最簡單的方法是在資料位置的參照上呼叫 removeValue()。

您也可以指定 null 做為其他寫入作業 (例如 setValue() 或 updateChildren()) 的值，藉此刪除資料。您可以搭配使用這項技術和 updateChildren()，在單一 API 呼叫中刪除多個子項。

卸載事件監聽器

如要移除回呼，請在 Firebase 資料庫參照上呼叫 removeEventListener() 方法。

如果監聽器已多次新增至資料位置，則每個事件都會呼叫該監聽器多次，您必須將其卸載相同次數，才能完全移除。

在父項事件監聽器上呼叫 removeEventListener()，並不會自動移除在其子節點上註冊的事件監聽器；您也必須在任何子項事件監聽器上呼叫 removeEventListener()，才能移除回呼。

將資料儲存為交易

處理可能因並行修改而損毀的資料 (例如遞增計數器) 時，可以使用交易作業。這項作業需要兩個引數：更新函式和選用的完成回呼。更新函式會將資料的目前狀態做為引數，並傳回您要寫入的新預期狀態。如果其他用戶端在您成功寫入新值之前寫入該位置，系統會再次呼叫更新函式，並使用新的目前值，然後重試寫入。

舉例來說，在社交網誌應用程式範例中，您可以允許使用者為貼文加上星號和移除星號，並追蹤貼文獲得的星號數量，如下所示：

Kotlin 

private fun onStarClicked(postRef: DatabaseReference) {
    // ...
    postRef.runTransaction(object : Transaction.Handler {
        override fun doTransaction(mutableData: MutableData): Transaction.Result {
            val p = mutableData.getValue(Post::class.java)
                ?: return Transaction.success(mutableData)

            if (p.stars.containsKey(uid)) {
                // Unstar the post and remove self from stars
                p.starCount = p.starCount - 1
                p.stars.remove(uid)
            } else {
                // Star the post and add self to stars
                p.starCount = p.starCount + 1
                p.stars[uid] = true
            }

            // Set value and report transaction success
            mutableData.value = p
            return Transaction.success(mutableData)
        }

        override fun onComplete(
            databaseError: DatabaseError?,
            committed: Boolean,
            currentData: DataSnapshot?,
        ) {
            // Transaction completed
            Log.d(TAG, "postTransaction:onComplete:" + databaseError!!)
        }
    })
}

Java 

private void onStarClicked(DatabaseReference postRef) {
    postRef.runTransaction(new Transaction.Handler() {
        @NonNull
        @Override
        public Transaction.Result doTransaction(@NonNull MutableData mutableData) {
            Post p = mutableData.getValue(Post.class);
            if (p == null) {
                return Transaction.success(mutableData);
            }

            if (p.stars.containsKey(getUid())) {
                // Unstar the post and remove self from stars
                p.starCount = p.starCount - 1;
                p.stars.remove(getUid());
            } else {
                // Star the post and add self to stars
                p.starCount = p.starCount + 1;
                p.stars.put(getUid(), true);
            }

            // Set value and report transaction success
            mutableData.setValue(p);
            return Transaction.success(mutableData);
        }

        @Override
        public void onComplete(DatabaseError databaseError, boolean committed,
                               DataSnapshot currentData) {
            // Transaction completed
            Log.d(TAG, "postTransaction:onComplete:" + databaseError);
        }
    });
}

如果多位使用者同時為同一則貼文加上星號，或用戶端有過時資料，使用交易可避免星號計數不正確。如果交易遭拒，伺服器會將目前的值傳回用戶端，用戶端則會使用更新後的值再次執行交易。這個程序會重複執行，直到交易獲得接受或嘗試次數過多為止。

伺服器端原子遞增

在上述用途中，我們會將兩個值寫入資料庫：對貼文加上/取消星號的使用者 ID，以及增加的星號數量。如果我們已經知道使用者對貼文加上星號，則可以使用原子遞增作業，而不是交易。

Kotlin 

private fun onStarClicked(uid: String, key: String) {
    val updates: MutableMap<String, Any> = hashMapOf(
        "posts/$key/stars/$uid" to true,
        "posts/$key/starCount" to ServerValue.increment(1),
        "user-posts/$uid/$key/stars/$uid" to true,
        "user-posts/$uid/$key/starCount" to ServerValue.increment(1),
    )
    database.updateChildren(updates)
}

Java 

private void onStarClicked(String uid, String key) {
    Map<String, Object> updates = new HashMap<>();
    updates.put("posts/"+key+"/stars/"+uid, true);
    updates.put("posts/"+key+"/starCount", ServerValue.increment(1));
    updates.put("user-posts/"+uid+"/"+key+"/stars/"+uid, true);
    updates.put("user-posts/"+uid+"/"+key+"/starCount", ServerValue.increment(1));
    mDatabase.updateChildren(updates);
}

這段程式碼不使用交易作業，因此如果發生衝突的更新，系統不會自動重新執行。不過，由於遞增作業是直接在資料庫伺服器上執行，因此不會發生衝突。

如要偵測並拒絕應用程式專屬的衝突 (例如使用者對已加上星號的文章再次加上星號)，請針對該用途編寫自訂安全性規則。

離線處理資料

如果用戶端失去網路連線，應用程式仍會正常運作。

每個連線至 Firebase 資料庫的用戶端，都會維護自己的內部版本，其中包含正在使用監聽器的資料，或標記為與伺服器保持同步的資料。讀取或寫入資料時，系統會先使用這個本機版本的資料。Firebase 用戶端會盡可能將資料與遠端資料庫伺服器和其他用戶端同步。

因此，在與伺服器進行任何互動之前，所有寫入資料庫的作業都會立即觸發本機事件。這表示無論網路延遲或連線狀況如何，應用程式都能保持回應。

恢復連線後，應用程式會收到適當的事件組合，讓用戶端與目前的伺服器狀態保持同步，不必編寫任何自訂程式碼。

如要進一步瞭解離線行為，請參閱「進一步瞭解線上和離線功能」。

後續步驟