在 Apple 平台上讀取和寫入數據

（可選）使用 Firebase Local Emulator Suite 製作原型並進行測試

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

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

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

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

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

獲取 FIRDatabaseReference

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

迅速

注意：此 Firebase 產品不適用於 App Clip 目標。
var ref: DatabaseReference!

ref = Database.database().reference()

目標-C

注意：此 Firebase 產品不適用於 App Clip 目標。
@property (strong, nonatomic) FIRDatabaseReference *ref;

self.ref = [[FIRDatabase database] reference];

寫數據

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

Firebase 數據被寫入Database引用，並通過將異步偵聽器附加到引用來檢索。偵聽器針對數據的初始狀態觸發一次，並在數據更改時再次觸發。

基本寫操作

對於基本的寫入操作，您可以使用setValue將數據保存到指定的引用，替換該路徑中的任何現有數據。您可以使用此方法來：

  • 傳遞對應於可用 JSON 類型的類型，如下所示：
    • NSString
    • NSNumber
    • NSDictionary
    • NSArray

例如，您可以使用setValue添加用戶，如下所示：

迅速

注意：此 Firebase 產品不適用於 App Clip 目標。
self.ref.child("users").child(user.uid).setValue(["username": username])

目標-C

注意：此 Firebase 產品不適用於 App Clip 目標。
[[[self.ref child:@"users"] child:authResult.user.uid]
    setValue:@{@"username": username}];

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

迅速

注意：此 Firebase 產品不適用於 App Clip 目標。
self.ref.child("users/\(user.uid)/username").setValue(username)

目標-C

注意：此 Firebase 產品不適用於 App Clip 目標。
[[[[_ref child:@"users"] child:user.uid] child:@"username"] setValue:username];

讀取數據

通過監聽值事件讀取數據

要讀取路徑上的數據並監聽變化，請使用FIRDatabaseReference的observeEventType:withBlock來觀察FIRDataEventTypeValue事件。

事件類型典型用法
FIRDataEventTypeValue讀取並監聽路徑全部內容的變化。

您可以使用FIRDataEventTypeValue事件讀取給定路徑中的數據，因為它在事件發生時存在。當附加偵聽器時會觸發一次此方法，每次數據（包括任何子項）更改時都會再次觸發。向事件回調傳遞一個snapshot其中包含該位置的所有數據，包括子數據。如果沒有數據，快照將在您調用exists()時返回false ，在您讀取其value屬性時返回nil 。

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

迅速

注意：此 Firebase 產品不適用於 App Clip 目標。
refHandle = postRef.observe(DataEventType.value, with: { snapshot in
  // ...
})

目標-C

注意：此 Firebase 產品不適用於 App Clip 目標。
_refHandle = [_postRef observeEventType:FIRDataEventTypeValue withBlock:^(FIRDataSnapshot * _Nonnull snapshot) {
  NSDictionary *postDict = snapshot.value;
  // ...
}];

偵聽器收到一個FIRDataSnapshot ，其中包含事件發生時數據庫中指定位置的數據，其value屬性為該數據。您可以將值分配給適當的本機類型，例如NSDictionary 。如果該位置不存在數據，則value nil 。

一次讀取數據

使用 getData() 讀取一次

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

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

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

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

迅速

注意：此 Firebase 產品不適用於 App Clip 目標。
ref.child("users/\(uid)/username").getData(completion:  { error, snapshot in
  guard error == nil else {
    print(error!.localizedDescription)
    return;
  }
  let userName = snapshot.value as? String ?? "Unknown";
});

目標-C

注意：此 Firebase 產品不適用於 App Clip 目標。
NSString *userPath = [NSString stringWithFormat:@"users/%@/username", uid];
[[ref child:userPath] getDataWithCompletionBlock:^(NSError * _Nullable error, FIRDataSnapshot * _Nonnull snapshot) {
  if (error) {
    NSLog(@"Received an error %@", error);
    return;
  }
  NSString *userName = snapshot.value;
}];

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

用觀察者讀取一次數據

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

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

迅速

注意：此 Firebase 產品不適用於 App Clip 目標。
let userID = Auth.auth().currentUser?.uid
ref.child("users").child(userID!).observeSingleEvent(of: .value, with: { snapshot in
  // Get user value
  let value = snapshot.value as? NSDictionary
  let username = value?["username"] as? String ?? ""
  let user = User(username: username)

  // ...
}) { error in
  print(error.localizedDescription)
}

目標-C

注意：此 Firebase 產品不適用於 App Clip 目標。
NSString *userID = [FIRAuth auth].currentUser.uid;
[[[_ref child:@"users"] child:userID] observeSingleEventOfType:FIRDataEventTypeValue withBlock:^(FIRDataSnapshot * _Nonnull snapshot) {
  // Get user value
  User *user = [[User alloc] initWithUsername:snapshot.value[@"username"]];

  // ...
} withCancelBlock:^(NSError * _Nonnull error) {
  NSLog(@"%@", error.localizedDescription);
}];

更新或刪除數據

更新特定字段

要在不覆蓋其他子節點的情況下同時寫入節點的特定子節點，請使用updateChildValues方法。

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

迅速

注意：此 Firebase 產品不適用於 App Clip 目標。
guard let key = ref.child("posts").childByAutoId().key else { return }
let post = ["uid": userID,
            "author": username,
            "title": title,
            "body": body]
let childUpdates = ["/posts/\(key)": post,
                    "/user-posts/\(userID)/\(key)/": post]
ref.updateChildValues(childUpdates)

目標-C

注意：此 Firebase 產品不適用於 App Clip 目標。
NSString *key = [[_ref child:@"posts"] childByAutoId].key;
NSDictionary *post = @{@"uid": userID,
                       @"author": username,
                       @"title": title,
                       @"body": body};
NSDictionary *childUpdates = @{[@"/posts/" stringByAppendingString:key]: post,
                               [NSString stringWithFormat:@"/user-posts/%@/%@/", userID, key]: post};
[_ref updateChildValues:childUpdates];

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

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

添加完成塊

如果您想知道您的數據何時提交，您可以添加一個完成塊。 setValue和updateChildValues都採用一個可選的完成塊，當寫入已提交到數據庫時調用該塊。此偵聽器可用於跟踪哪些數據已保存以及哪些數據仍在同步。如果調用不成功，則會向偵聽器傳遞一個錯誤對象，指示失敗發生的原因。

迅速

注意：此 Firebase 產品不適用於 App Clip 目標。
ref.child("users").child(user.uid).setValue(["username": username]) {
  (error:Error?, ref:DatabaseReference) in
  if let error = error {
    print("Data could not be saved: \(error).")
  } else {
    print("Data saved successfully!")
  }
}

目標-C

注意：此 Firebase 產品不適用於 App Clip 目標。
[[[_ref child:@"users"] child:user.uid] setValue:@{@"username": username} withCompletionBlock:^(NSError *error, FIRDatabaseReference *ref) {
  if (error) {
    NSLog(@"Data could not be saved: %@", error);
  } else {
    NSLog(@"Data saved successfully.");
  }
}];

刪除數據

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

您還可以通過將nil指定為另一個寫入操作（例如setValue或updateChildValues的值來刪除。您可以將此技術與updateChildValues結合使用，以在單個 API 調用中刪除多個子項。

分離監聽器

當您離開ViewController時，觀察者不會自動停止同步數據。如果未正確刪除觀察者，它會繼續將數據同步到本地內存。當不再需要觀察者時，通過將關聯的FIRDatabaseHandle傳遞給removeObserverWithHandle方法來將其刪除。

當您將回調塊添加到引用時，將返回FIRDatabaseHandle 。這些句柄可用於刪除回調塊。

如果已將多個偵聽器添加到數據庫引用，則在引發事件時調用每個偵聽器。為了停止在該位置同步數據，您必須通過調用removeAllObservers方法刪除該位置的所有觀察者。

在偵聽器上調用removeObserverWithHandle或removeAllObservers不會自動刪除在其子節點上註冊的偵聽器；您還必須跟踪這些引用或句柄以將其刪除。

將數據保存為事務

當處理可能被並發修改破壞的數據時，例如增量計數器，您可以使用事務操作。你給這個操作兩個參數：一個更新函數和一個可選的完成回調。 update 函數將數據的當前狀態作為參數並返回您想要寫入的新的所需狀態。

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

迅速

注意：此 Firebase 產品不適用於 App Clip 目標。
ref.runTransactionBlock({ (currentData: MutableData) -> TransactionResult in
  if var post = currentData.value as? [String: AnyObject],
    let uid = Auth.auth().currentUser?.uid {
    var stars: [String: Bool]
    stars = post["stars"] as? [String: Bool] ?? [:]
    var starCount = post["starCount"] as? Int ?? 0
    if let _ = stars[uid] {
      // Unstar the post and remove self from stars
      starCount -= 1
      stars.removeValue(forKey: uid)
    } else {
      // Star the post and add self to stars
      starCount += 1
      stars[uid] = true
    }
    post["starCount"] = starCount as AnyObject?
    post["stars"] = stars as AnyObject?

    // Set value and report transaction success
    currentData.value = post

    return TransactionResult.success(withValue: currentData)
  }
  return TransactionResult.success(withValue: currentData)
}) { error, committed, snapshot in
  if let error = error {
    print(error.localizedDescription)
  }
}

目標-C

注意：此 Firebase 產品不適用於 App Clip 目標。
[ref runTransactionBlock:^FIRTransactionResult * _Nonnull(FIRMutableData * _Nonnull currentData) {
  NSMutableDictionary *post = currentData.value;
  if (!post || [post isEqual:[NSNull null]]) {
    return [FIRTransactionResult successWithValue:currentData];
  }

  NSMutableDictionary *stars = post[@"stars"];
  if (!stars) {
    stars = [[NSMutableDictionary alloc] initWithCapacity:1];
  }
  NSString *uid = [FIRAuth auth].currentUser.uid;
  int starCount = [post[@"starCount"] intValue];
  if (stars[uid]) {
    // Unstar the post and remove self from stars
    starCount--;
    [stars removeObjectForKey:uid];
  } else {
    // Star the post and add self to stars
    starCount++;
    stars[uid] = @YES;
  }
  post[@"stars"] = stars;
  post[@"starCount"] = @(starCount);

  // Set value and report transaction success
  currentData.value = post;
  return [FIRTransactionResult successWithValue:currentData];
} andCompletionBlock:^(NSError * _Nullable error,
                       BOOL committed,
                       FIRDataSnapshot * _Nullable snapshot) {
  // Transaction completed
  if (error) {
    NSLog(@"%@", error.localizedDescription);
  }
}];

如果多個用戶同時為同一個帖子加註星標或者客戶的數據過時，使用事務可以防止加星計數不正確。 FIRMutableData類中包含的值最初是客戶端最後已知的路徑值，如果沒有則為nil 。服務器將初始值與其當前值進行比較，如果值匹配則接受交易，否則拒絕交易。如果事務被拒絕，服務器將當前值返回給客戶端，客戶端使用更新後的值再次運行事務。重複此過程，直到交易被接受或嘗試次數過多。

原子服務器端增量

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

迅速

注意：此 Firebase 產品不適用於 App Clip 目標。
let updates = [
  "posts/\(postID)/stars/\(userID)": true,
  "posts/\(postID)/starCount": ServerValue.increment(1),
  "user-posts/\(postID)/stars/\(userID)": true,
  "user-posts/\(postID)/starCount": ServerValue.increment(1)
] as [String : Any]
Database.database().reference().updateChildValues(updates);

目標-C

注意：此 Firebase 產品不適用於 App Clip 目標。
NSDictionary *updates = @{[NSString stringWithFormat: @"posts/%@/stars/%@", postID, userID]: @TRUE,
                        [NSString stringWithFormat: @"posts/%@/starCount", postID]: [FIRServerValue increment:@1],
                        [NSString stringWithFormat: @"user-posts/%@/stars/%@", postID, userID]: @TRUE,
                        [NSString stringWithFormat: @"user-posts/%@/starCount", postID]: [FIRServerValue increment:@1]};
[[[FIRDatabase database] reference] updateChildValues:updates];

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

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

離線處理數據

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

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

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

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

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

下一步