在 Apple 平台上讀取及寫入資料

(選用) 使用 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 DatabaseCloud Functions 的詳細說明。建議您也參閱 Local Emulator Suite 簡介

取得 FIRDatabaseReference

如要從資料庫讀取或寫入資料,您需要 FIRDatabaseReference 的例項:

Swift

注意:這項 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 新增使用者,如下所示:

Swift

注意:這項 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 會覆寫指定位置的資料,包括任何子節點。不過,您還是可以更新子項,而無須重寫整個物件。如果您想允許使用者更新個人資料,可以按照下列方式更新使用者名稱:

Swift

注意:這項 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];

讀取資料

監聽值事件讀取資料

如要讀取路徑中的資料並監聽變更,請使用 FIRDatabaseReferenceobserveEventType:withBlock 來觀察 FIRDataEventTypeValue 事件。

事件類型 一般用量
FIRDataEventTypeValue 讀取及監聽對路徑完整內容的變更。

您可以使用 FIRDataEventTypeValue 事件讀取指定路徑中的資料,因為該資料會在事件發生時存在。這個方法會在連結監聽器時觸發一次,並且在資料 (包括任何子項) 變更時再次觸發。事件回呼會傳遞 snapshot,其中包含該位置的所有資料,包括子資料。如果沒有資料,則當您呼叫 exists()nil 時,系統會在您讀取其 value 屬性時,為快照傳回 false

以下範例示範社交網站的應用程式如何從資料庫擷取貼文詳細資料:

Swift

注意:這項 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;
  // ...
}];

事件監聽器會在 value 屬性中接收 FIRDataSnapshot,其中包含資料庫中事件發生時指定位置的資料。您可以將值指派給適當的原生類型,例如 NSDictionary。如果位置沒有任何資料,value 就是 nil

讀取一次資料

使用 getData() 讀取一次

無論應用程式處於線上或離線狀態,SDK 都能用來管理與資料庫伺服器的互動。

一般來說,您應使用上述的值事件技術來讀取資料,以便從後端取得資料更新的通知。這些技巧可減少使用量和帳單費用,並且經過最佳化處理,可在線上和離線狀態下為使用者提供最佳體驗。

如果您只需要資料一次,可以使用 getData() 取得資料庫中的資料快照。如果 getData() 因任何原因無法傳回伺服器值,用戶端會探查本機儲存空間快取,如果仍找不到該值,就會傳回錯誤。

以下範例說明如何從資料庫中擷取使用者的公開使用者名稱:

Swift

注意:這項 Firebase 產品不適用於 App Clip 目標。
do {
  let snapshot = try await ref.child("users/\(uid)/username").getData()
  let userName = snapshot.value as? String ?? "Unknown"
} catch {
  print(error)
}

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 立即從本機磁碟快取取得資料。

這類資料只需要載入一次,且不會經常變更或需要主動聆聽,因此非常實用。舉例來說,上述範例中的網誌應用程式會使用這個方法,在使用者開始撰寫新文章時載入個人資料:

Swift

注意:這項 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 時,您可以指定索引鍵的路徑,藉此更新較低層級的子項值。如果資料儲存在多個位置,可讓資料更容易擴充,您可以使用資料扇出更新該資料的所有例項。舉例來說,社群網站應用程式可能會建立一則貼文,並同時將其更新至最近活動動態和發布者活動動態。為此,網誌應用程式使用以下程式碼:

Swift

注意:這項 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 樹狀結構中的多個位置,例如這個範例如何在兩個位置建立新貼文。以這種方式進行的同步更新是不可分割的:所有更新成功或所有更新都會失敗。

新增完成方塊

如要瞭解資料何時已提交,您可以新增完成區塊。setValueupdateChildValues 都是選用的完成區塊,系統會在將寫入作業提交至資料庫時呼叫該區塊。這個事件監聽器可用於追蹤已儲存的資料,以及仍在同步處理的資料。如果呼叫失敗,系統會將錯誤物件傳遞至事件監聽器,指出發生失敗的原因。

Swift

注意:這項 Firebase 產品不適用於 App Clip 目標。
do {
  try await ref.child("users").child(user.uid).setValue(["username": username])
  print("Data saved successfully!")
} catch {
  print("Data could not be saved: \(error).")
}

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 指定為其他寫入作業 (例如 setValueupdateChildValues) 的值,藉此刪除資料。您可以搭配使用這項技巧和 updateChildValues,在單一 API 呼叫中刪除多個子項。

卸離監聽器

當您離開 ViewController 時,觀察者不會自動停止同步處理資料。如果未妥善移除觀察器,觀察器會繼續將資料同步處理至本機記憶體。不再需要觀察器時,請將相關聯的 FIRDatabaseHandle 傳遞至 removeObserverWithHandle 方法,即可移除觀察器。

將回呼區塊新增至參照時,系統會傳回 FIRDatabaseHandle。這些句柄可用來移除回呼區塊。

如果資料庫參照已新增多個事件監聽器,系統會在事件發生時呼叫每個事件監聽器。如要停止同步處理該位置的資料,您必須呼叫 removeAllObservers 方法,移除該位置的所有觀察器。

在事件監聽器上呼叫 removeObserverWithHandleremoveAllObservers 不會自動移除在子節點上註冊的事件監聽器;您還必須追蹤這些參照或句柄,才能將其移除。

將資料儲存為交易

如果要處理可能因並行修改而毀損的資料 (例如遞增計數器),您可以使用交易作業。您將為這項作業提供兩個引數:更新函式和選用的完成回呼。update 函式會將資料目前狀態當做引數,並傳回您要寫入的新所需狀態。

舉例來說,在上述社群網誌應用程式中,您可以允許使用者為貼文按讚或取消按讚,並追蹤貼文獲得的按讚次數,如下所示:

Swift

注意:這項 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,以及增加的星號數量。如果我們已知使用者將該貼文設為收藏,就可以使用原子遞增作業,而非交易。

Swift

注意:這項 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 用戶端會「盡可能」將這些資料與遠端資料庫伺服器和其他用戶端同步處理。

因此,在將任何資料寫入伺服器之前,所有寫入資料庫的作業會立即觸發本機事件。換句話說,無論網路延遲或連線狀況,應用程式都會持續回應。

重新建立連線後,應用程式會收到適當的事件組合,讓用戶端與目前的伺服器狀態保持同步,而無需撰寫任何自訂程式碼。

我們將在「進一步瞭解線上和離線功能」一文中進一步說明離線行為。

後續步驟