讀取和寫入數據

（可選）使用 Firebase Emulator Suite 進行原型設計和測試

在討論您的應用如何讀取和寫入實時數據庫之前，讓我們介紹一組可用於原型和測試實時數據庫功能的工具：Firebase Emulator Suite。如果您正在嘗試不同的數據模型，優化您的安全規則，或努力尋找與後端交互的最具成本效益的方式，那麼無需部署實時服務即可在本地工作可能是一個好主意。

Realtime Database 模擬器是 Emulator Suite 的一部分，它使您的應用程序能夠與您的模擬數據庫內容和配置以及可選的模擬項目資源（函數、其他數據庫和安全規則）進行交互。emulator_suite_short

使用實時數據庫模擬器只需幾個步驟：

1. 在應用程序的測試配置中添加一行代碼以連接到模擬器。
2. 從本地項目目錄的根目錄運行firebase emulators:start 。
3. 像往常一樣使用實時數據庫平台 SDK 或使用實時數據庫 REST API 從應用程序的原型代碼進行調用。

提供了涉及實時數據庫和雲函數的詳細演練。您還應該看看Emulator Suite 介紹。

獲取數據庫引用

要從數據庫讀取或寫入數據，您需要一個DatabaseReference實例：

DatabaseReference ref = FirebaseDatabase.instance.ref();

寫入數據

本文檔涵蓋了讀取和寫入 Firebase 數據的基礎知識。

Firebase 數據被寫入DatabaseReference並通過等待或偵聽引用發出的事件來檢索。事件會在數據的初始狀態下發出一次，並且在數據更改時再次發出。

基本寫操作

對於基本的寫入操作，您可以使用set()將數據保存到指定的引用，替換該路徑中的任何現有數據。您可以設置對以下類型的引用： String 、 boolean 、 int 、 double 、 Map 、 List 。

例如，您可以使用set()添加用戶，如下所示：

DatabaseReference ref = FirebaseDatabase.instance.ref("users/123");

await ref.set({
  "name": "John",
  "age": 18,
  "address": {
    "line1": "100 Mountain View"
  }
});

以這種方式使用set()會覆蓋指定位置的數據，包括任何子節點。但是，您仍然可以在不重寫整個對象的情況下更新子對象。如果您想允許用戶更新他們的個人資料，您可以按如下方式更新用戶名：

DatabaseReference ref = FirebaseDatabase.instance.ref("users/123");

// Only update the name, leave the age and address!
await ref.update({
  "age": 19,
});

update()方法接受節點的子路徑，允許您一次更新數據庫上的多個節點：

DatabaseReference ref = FirebaseDatabase.instance.ref("users");

await ref.update({
  "123/age": 19,
  "123/address/line1": "1 Mountain View",
});

讀取數據

通過監聽值事件讀取數據

要讀取路徑中的數據並偵聽更改，請使用DatabaseReference的onValue屬性來偵聽DatabaseEvent 。

您可以使用DatabaseEvent在給定路徑讀取數據，因為它在事件發生時存在。此事件在附加偵聽器時觸發一次，並且在每次數據（包括任何子項）發生更改時再次觸發。該事件有一個snapshot屬性，其中包含該位置的所有數據，包括子數據。如果沒有數據，則快照的exists屬性為false ，其value屬性為 null。

以下示例演示了一個社交博客應用程序從數據庫中檢索帖子的詳細信息：

DatabaseReference starCountRef =
        FirebaseDatabase.instance.ref('posts/$postId/starCount');
starCountRef.onValue.listen((DatabaseEvent event) {
    final data = event.snapshot.value;
    updateStarCount(data);
});

偵聽器在其value屬性中接收到包含事件發生時數據庫中指定位置的數據的DataSnapshot 。

讀取數據一次

使用 get() 讀取一次

SDK 旨在管理與數據庫服務器的交互，無論您的應用程序是在線還是離線。

通常，您應該使用上述值事件技術來讀取數據，以便從後端獲取數據更新的通知。這些技術可減少您的使用量和計費，並經過優化以在您的用戶在線和離線時為他們提供最佳體驗。

如果您只需要一次數據，您可以使用get()從數據庫中獲取數據的快照。如果由於任何原因get()無法返回服務器值，客戶端將探測本地存儲緩存，如果仍未找到該值，則返回錯誤。

以下示例演示了從數據庫中一次檢索用戶面向公眾的用戶名：

final ref = FirebaseDatabase.instance.ref();
final snapshot = await ref.child('users/$userId').get();
if (snapshot.exists) {
    print(snapshot.value);
} else {
    print('No data available.');
}

不必要地使用get()會增加帶寬的使用並導致性能損失，這可以通過使用實時偵聽器來防止，如上所示。

使用 once() 讀取數據一次

在某些情況下，您可能希望立即返回本地緩存中的值，而不是檢查服務器上的更新值。在這些情況下，您可以使用once()立即從本地磁盤緩存中獲取數據。

這對於只需要加載一次並且預計不會頻繁更改或需要主動偵聽的數據很有用。例如，前面示例中的博客應用程序在用戶開始撰寫新帖子時使用此方法加載用戶的個人資料：

final event = await ref.once(DatabaseEventType.value);
final username = event.snapshot.value?.username ?? 'Anonymous';

更新或刪除數據

更新特定字段

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

調用update()時，您可以通過指定鍵的路徑來更新較低級別的子值。如果數據存儲在多個位置以更好地擴展，您可以使用data fan-out更新該數據的所有實例。例如，社交博客應用程序可能想要創建帖子並同時將其更新為最近的活動提要和發布用戶的活動提要。為此，博客應用程序使用如下代碼：

void writeNewPost(String uid, String username, String picture, String title,
        String body) async {
    // A post entry.
    final postData = {
        'author': username,
        'uid': uid,
        'body': body,
        'title': title,
        'starCount': 0,
        'authorPic': picture,
    };

    // Get a key for a new Post.
    final newPostKey =
        FirebaseDatabase.instance.ref().child('posts').push().key;

    // Write the new post's data simultaneously in the posts list and the
    // user's post list.
    final Map<String, Map> updates = {};
    updates['/posts/$newPostKey'] = postData;
    updates['/user-posts/$uid/$newPostKey'] = postData;

    return FirebaseDatabase.instance.ref().update(updates);
}

此示例使用push()在包含/posts/$postid的所有用戶的帖子的節點中創建一個帖子，並同時使用 key 檢索key 。然後可以使用該密鑰在/user-posts/$userid/$postid的用戶帖子中創建第二個條目。

使用這些路徑，您可以通過一次調用update()來同時更新 JSON 樹中的多個位置，例如此示例如何在兩個位置創建新帖子。以這種方式進行的同時更新是原子的：要么所有更新都成功，要么所有更新都失敗。

添加完成回調

如果您想知道您的數據何時提交，您可以註冊完成回調。 set()和update()都返回Future ，您可以在其上附加成功和錯誤回調，當寫入已提交到數據庫以及調用不成功時調用這些回調。

FirebaseDatabase.instance
    .ref('users/$userId/email')
    .set(emailAddress)
    .then((_) {
        // Data saved successfully!
    })
    .catchError((error) {
        // The write failed...
    });

刪除數據

刪除數據的最簡單方法是在對該數據位置的引用上調用remove() 。

您還可以通過將 null 指定為另一個寫入操作的值來刪除，例如set()或update() 。您可以將此技術與update()一起使用，以在單個 API 調用中刪除多個子項。

將數據保存為事務

當處理可能被並發修改破壞的數據時，例如增量計數器，您可以通過將事務處理程序傳遞給runTransaction()來使用事務。事務處理程序將數據的當前狀態作為參數並返回您想要寫入的新的期望狀態。如果另一個客戶端在您的新值成功寫入之前寫入該位置，則使用新的當前值再次調用您的更新函數，並重試寫入。

例如，在示例社交博客應用程序中，您可以允許用戶為帖子加註星標和取消加註星標，並跟踪帖子獲得的星數，如下所示：

void toggleStar(String uid) async {
  DatabaseReference postRef =
      FirebaseDatabase.instance.ref("posts/foo-bar-123");

  TransactionResult result = await postRef.runTransaction((Object? post) {
    // Ensure a post at the ref exists.
    if (post == null) {
      return Transaction.abort();
    }

    Map<String, dynamic> _post = Map<String, dynamic>.from(post as Map);
    if (_post["stars"] is Map && _post["stars"][uid] != null) {
      _post["starCount"] = (_post["starCount"] ?? 1) - 1;
      _post["stars"][uid] = null;
    } else {
      _post["starCount"] = (_post["starCount"] ?? 0) + 1;
      if (!_post.containsKey("stars")) {
        _post["stars"] = {};
      }
      _post["stars"][uid] = true;
    }

    // Return the new data.
    return Transaction.success(_post);
  });
}

默認情況下，每次事務更新函數運行時都會引發事件，因此您多次運行該函數，您可能會看到中間狀態。您可以將applyLocally設置為false以抑制這些中間狀態，而是等到事務完成後再引發事件：

await ref.runTransaction((Object? post) {
  // ...
}, applyLocally: false);

事務的結果是一個TransactionResult ，其中包含諸如事務是否已提交以及新快照等信息：

DatabaseReference ref = FirebaseDatabase.instance.ref("posts/123");

TransactionResult result = await ref.runTransaction((Object? post) {
  // ...
});

print('Committed? ${result.committed}'); // true / false
print('Snapshot? ${result.snapshot}'); // DataSnapshot

取消交易

如果您想安全地取消事務，請調用Transaction.abort()以拋出AbortTransactionException ：

TransactionResult result = await ref.runTransaction((Object? user) {
  if (user !== null) {
    return Transaction.abort();
  }

  // ...
});

print(result.committed); // false

原子服務器端增量

在上面的用例中，我們將兩個值寫入數據庫：為帖子加星/取消星標的用戶的 ID，以及增加的星數。如果我們已經知道用戶正在為帖子加註星標，我們可以使用原子增量操作而不是事務。

void addStar(uid, key) async {
  Map<String, Object?> updates = {};
  updates["posts/$key/stars/$uid"] = true;
  updates["posts/$key/starCount"] = ServerValue.increment(1);
  updates["user-posts/$key/stars/$uid"] = true;
  updates["user-posts/$key/starCount"] = ServerValue.increment(1);
  return FirebaseDatabase.instance.ref().update(updates);
}

此代碼不使用事務操作，因此如果存在衝突更新，它不會自動重新運行。但是，由於增量操作直接發生在數據庫服務器上，因此不會發生衝突。

如果您想檢測和拒絕特定於應用程序的衝突，例如用戶為他們之前已加註星標的帖子加註星標，您應該為該用例編寫自定義安全規則。

離線處理數據

如果客戶端失去其網絡連接，您的應用程序將繼續正常運行。

每個連接到 Firebase 數據庫的客戶端都維護自己的任何活動數據的內部版本。數據寫入時，首先寫入到這個本地版本。然後，Firebase 客戶端會在“盡力而為”的基礎上將該數據與遠程數據庫服務器和其他客戶端同步。

因此，在任何數據寫入服務器之前，對數據庫的所有寫入都會立即觸發本地事件。這意味著無論網絡延遲或連接如何，您的應用都會保持響應。

重新建立連接後，您的應用程序會收到一組適當的事件，以便客戶端與當前服務器狀態同步，而無需編寫任何自定義代碼。

我們將在了解有關在線和離線功能的更多信息中詳細討論離線行為。

下一步

• 使用數據列表
• 了解如何構建數據
• 了解有關在線和離線功能的更多信息