在 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 Database 和 Cloud 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];

讀取資料

監聽價值事件來讀取資料

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

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

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

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

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 樹狀結構中的多個位置，例如這個範例如何在兩個位置建立新貼文。以這種方式進行的同時更新作業是原子性的：所有更新都會成功，或所有更新都會失敗。

新增完成方塊

如要瞭解資料何時已提交，您可以新增完成區塊。setValue 和 updateChildValues 都會採用選用的完成區塊，該區塊會在寫入作業已提交至資料庫時呼叫。這個事件監聽器有助於追蹤哪些資料已經儲存，以及哪些資料仍在同步處理。如果呼叫失敗，事件監聽器會傳送錯誤物件，指出失敗的原因。

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

卸離監聽器

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

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

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

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

將資料儲存為交易

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

舉例來說，在社交網誌應用程式範例中，您可以讓使用者為文章加上星號或移除星號，也可以追蹤貼文獲得的星星數量，如下所示：

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

因此，所有寫入資料庫的作業都會立即觸發本機事件，然後才將任何資料寫入伺服器。也就是說，無論網路延遲或連線狀況為何，應用程式都能持續回應。

重新建立連線後，應用程式會收到一組適當的事件，讓用戶端與目前的伺服器狀態同步，而不必編寫任何自訂程式碼。

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

後續步驟