在 iOS 上讀寫數據

(可選)使用 Firebase 本地模擬器套件進行原型設計和測試

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

實時數據庫模擬器是本地模擬器套件的一部分,它使您的應用程序能夠與模擬的數據庫內容和配置以及可選的模擬項目資源(函數、其他數據庫和安全規則)交互。

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

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

詳細涉及到實時數據庫和雲功能演練是可用的。你也應該看看的地方模擬器套件介紹

獲取 FIRDatabaseReference

要讀取或寫入數據從數據庫中,你需要的實例FIRDatabaseReference

迅速

var ref: DatabaseReference!

ref = Database.database().reference()

目標-C

@property (strong, nonatomic) FIRDatabaseReference *ref;

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

寫入數據

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

火力數據被寫入到一個FIRDatabase參考並通過異步聽者附連到參考檢索。偵聽器在數據的初始狀態時觸發一次,並在數據發生變化時再次觸發。

基本寫操作

對於基本的寫操作,您可以使用setValue將數據保存到指定的參考,在該路徑替換現有數據。您可以使用此方法:

  • 傳遞與可用 JSON 類型對應的類型,如下所示:
    • NSString
    • NSNumber
    • NSDictionary
    • NSArray

舉例來說,你可以添加一個用戶setValue如下:

迅速

self.ref.child("users").child(user.uid).setValue(["username": username])

目標-C

[[[self.ref child:@"users"] child:authResult.user.uid]
    setValue:@{@"username": username}];

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

迅速

self.ref.child("users/\(user.uid)/username").setValue(username)

目標-C

[[[[_ref child:@"users"] child:user.uid] child:@"username"] setValue:username];

讀取數據

通過監聽值事件讀取數據

要閱讀在路徑數據和監聽更改,請使用observeEventType:withBlockFIRDatabaseReference觀察FIRDataEventTypeValue事件。

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

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

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

迅速

refHandle = postRef.observe(DataEventType.value, with: { snapshot in
  // ...
})

目標-C

_refHandle = [_postRef observeEventType:FIRDataEventTypeValue withBlock:^(FIRDataSnapshot * _Nonnull snapshot) {
  NSDictionary *postDict = snapshot.value;
  // ...
}];

偵聽器能夠接收一個FIRDataSnapshot包含在在其事件的時間在數據庫中的指定位置的數據value屬性。您可以分配值,以適當的本機類型,如NSDictionary 。如果該位置不存在數據,該valuenil

讀取數據一次

使用 getData() 讀取一次

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

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

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

不必要使用getData()可以提高帶寬的使用而導致的性能損失,這可以通過使用實時收聽如上所示被阻止。

self.ref.child("users/\(user.uid)/username").getData { (error, snapshot) in
    if let error = error {
        print("Error getting data \(error)")
    }
    else if snapshot.exists() {
        print("Got data \(snapshot.value!)")
    }
    else {
        print("No data available")
    }
}

使用觀察者讀取數據一次

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

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

迅速

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

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 ,您可以通過指定的關鍵路徑更新下級子值。如果數據存儲在多個位置,以便更好地擴展,可以更新使用該數據的所有實例數據扇出。例如,一個社交博客應用程序可能想要創建一個帖子並同時將其更新為最近的活動提要和發帖用戶的活動提要。為此,博客應用程序使用如下代碼:

迅速

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

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

使用這些路徑,你可以用一個單一的通話同時進行更新,在JSON樹多個位置updateChildValues ,比如如何這個例子創建在這兩個位置的新職位。以這種方式進行的同步更新是原子的:要么所有更新成功,要么所有更新失敗。

添加完成塊

如果你想知道你的數據何時被提交,你可以添加一個完成塊。雙方setValueupdateChildValues走時寫操作已經提交到數據庫被稱為可選完成塊。此偵聽器可用於跟踪哪些數據已保存以及哪些數據仍在同步。如果調用不成功,則向偵聽器傳遞一個錯誤對象,指示失敗發生的原因。

迅速

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

[[[_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為另一個寫操作,如值setValueupdateChildValues 。您可以使用此技術與updateChildValues在一個單一的API調用來刪除多個孩子。

分離監聽器

觀察家當你離開一個不自動停止同步數據ViewController 。如果觀察者沒有被正確刪除,它會繼續將數據同步到本地內存。當不再需要一個觀察者,通過使相關聯的刪除它FIRDatabaseHandleremoveObserverWithHandle方法。

當您添加的回調塊參照,一個FIRDatabaseHandle返回。這些句柄可用於刪除回調塊。

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

調用removeObserverWithHandleremoveAllObservers上的監聽器不會自動刪除其子結點註冊的偵聽器;您還必須跟踪這些引用或句柄以刪除它們。

將數據保存為交易

當有可能由並發修改,如增量計數器被損壞的數據時,您可以使用一個交易操作。你給這個操作兩個參數:一個更新函數和一個可選的完成回調。 update 函數將數據的當前狀態作為參數,並返回您想要寫入的新的所需狀態。

例如,在示例社交博客應用程序中,您可以允許用戶為帖子加星標和取消星標,並跟踪帖子已收到多少星標,如下所示:

迅速

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

[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,以及增加的星數。如果我們已經知道用戶正在為帖子加註,我們可以使用原子增量操作而不是事務。

迅速

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

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 客戶端然後在“盡力而為”的基礎上將該數據與遠程數據庫服務器和其他客戶端同步。

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

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

我們將討論更多的離線行為,了解更多關於在線和離線功能

下一步