在 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
ReadAndWriteSnippets.kt

Java

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

寫入資料

基本寫入作業

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

  • 請按照下列方式，將對應的可用 JSON 類型傳遞給型別：
    • String
    • Long
    • Double
    • Boolean
    • Map<String, Object>
    • List<Object>
  • 如果定義自訂 Java 物件的類別具有不帶引數的預設建構函式，且具有要指派屬性的公開 getter，請傳遞自訂 Java 物件。

如果您使用 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.
}
User.kt

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;
    }

}
User.java

如要新增使用者，請按照下列步驟操作：setValue()

Kotlin 

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

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

Java 

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

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

以這種方式使用 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)
ReadAndWriteSnippets.kt

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);
ReadAndWriteSnippets.java

事件發生時，監聽器會收到 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,
        )
    }
}
Post.kt

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;
    }
}
Post.java

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

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)
}
ReadAndWriteSnippets.kt

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);
}
ReadAndWriteSnippets.java

這個範例會使用 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
        // ...
    }
ReadAndWriteSnippets.kt

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
                // ...
            }
        });
ReadAndWriteSnippets.java

刪除資料

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

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

卸離監聽器

如要移除回呼，請針對 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!!)
        }
    })
}
ReadAndWriteSnippets.kt

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);
        }
    });
}
ReadAndWriteSnippets.java

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

不可分割的伺服器端遞增

在上述用途中，我們會將兩個值寫入資料庫：為貼文加上/取消加星號的使用者 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)
}
ReadAndWriteSnippets.kt

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);
}
ReadAndWriteSnippets.java

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

如要偵測及拒絕應用程式專屬的衝突，例如使用者為先前已加星號的貼文加上星號，請為該用途編寫自訂安全規則。

離線處理資料

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

每個連線至 Firebase 資料庫的用戶端，都會維護自己的內部版本，當中包含正在使用接聽程式的任何資料，或是標示為要與伺服器保持同步的資料。讀取或寫入資料時，系統會優先使用這個本機版本的資料。Firebase 用戶端隨後會盡力將資料與遠端資料庫伺服器和其他用戶端同步處理。

因此，所有寫入資料庫的作業都會立即觸發本機事件，而不會與伺服器互動。因此無論網路延遲或連線狀況如何，應用程式都會回應。

重新建立連線後，應用程式會收到適當的事件集，讓用戶端與目前的伺服器狀態同步，不必撰寫任何自訂程式碼。

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

後續步驟