在Apple平台上讀寫數據

（可選）使用 Firebase 本機模擬器套件進行原型設計和測試

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

即時資料庫模擬器是本機模擬器套件的一部分，它使您的應用程式能夠與模擬資料庫內容和配置以及可選的模擬專案資源（函數、其他資料庫和安全規則）進行互動。

使用即時資料庫模擬器只需幾個步驟：

  1. 將一行程式碼新增至應用程式的測試配置以連接到模擬器。
  2. 從本地專案目錄的根目錄中，運行firebase emulators:start 。
  3. 像往常一樣使用即時資料庫平台 SDK 或使用即時資料庫 REST API 從應用程式的原型程式碼進行呼叫。

提供了涉及即時資料庫和雲端功能的詳細演練。您還應該看看本地仿真器套件的介紹。

取得 FIR 資料庫參考

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

迅速

注意：此 Firebase 產品在 App Clip 目標上不可用。
var ref: DatabaseReference!

ref = Database.database().reference()

Objective-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])

Objective-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)

Objective-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
  // ...
})

Objective-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";
});

Objective-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)
}

Objective-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)

Objective-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!")
  }
}

Objective-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不會自動刪除在其子節點上註冊的監聽器；您還必須追蹤這些引用或句柄以將其刪除。

將資料儲存為交易

當處理可能被並發修改損壞的資料（例如增量計數器）時，您可以使用交易操作。您為此操作提供兩個參數：一個更新函數和一個可選的完成回呼。更新函數將資料的目前狀態作為參數，並傳回您想要寫入的新的所需狀態。

例如，在範例社交部落格應用程式中，您可以允許用戶對貼文加註星標和取消星標，並追蹤貼文收到的星數，如下所示：

迅速

注意：此 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)
  }
}

Objective-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);

Objective-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 用戶端會「盡力」將該資料與遠端資料庫伺服器和其他用戶端同步。

因此，在將任何資料寫入伺服器之前，對資料庫的所有寫入都會立即觸發本機事件。這意味著無論網路延遲或連接如何，您的應用程式都保持回應。

重新建立連線後，您的應用程式會收到適當的事件集，以便用戶端與目前伺服器狀態同步，而無需編寫任何自訂程式碼。

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

下一步