(選用) 使用 Firebase Local Emulator Suite 設計原型並進行測試
在討論應用程式如何從 Realtime Database 讀取及寫入之前, 以下介紹一組工具,可用來設計原型及測試 Realtime Database 功能:Firebase Local Emulator Suite。如要透過其他資料 最佳化安全性規則,或是盡量找出 以符合成本效益的方式與後端互動 未部署即時服務,也是不錯的點子
Realtime Database 模擬器是 Local Emulator Suite 的一部分, 可讓應用程式與模擬的資料庫內容和設定互動,如 以及選用的模擬專案資源 (函式、其他資料庫 和安全性規則)。
使用 Realtime Database 模擬器只需完成幾個步驟:
- 將一行程式碼新增至應用程式的測試設定,即可與模擬器連線。
- 從本機專案目錄的根目錄中執行
firebase emulators:start
。 - 使用 Realtime Database 平台從應用程式的原型程式碼發出呼叫 或 Realtime Database REST API 繼續使用 SDK。
請參閱有關 Realtime Database 和 Cloud Functions 的詳細說明。建議您也參閱 Local Emulator Suite 簡介。
取得 FIRDatabaseReference
如要從資料庫讀取或寫入資料,您需要使用
FIRDatabaseReference
:
Swift
var ref: DatabaseReference! ref = Database.database().reference()
Objective-C
@property (strong, nonatomic) FIRDatabaseReference *ref; self.ref = [[FIRDatabase database] reference];
寫入資料
本文說明讀取及寫入 Firebase 資料的基本概念。
Firebase 資料會寫入 Database
參照,並由
將非同步事件監聽器附加到參照中。事件監聽器會觸發
也就是資料的初始狀態,並在資料變更時再次執行
基本寫入作業
針對基本寫入作業,您可以使用 setValue
將資料儲存至指定
取代該路徑中的任何現有資料。您可以使用這個方法:
- 對應可用 JSON 類型的票證類型如下:
NSString
NSNumber
NSDictionary
NSArray
舉例來說,您可以新增包含 setValue
的使用者,如下所示:
Swift
self.ref.child("users").child(user.uid).setValue(["username": username])
Objective-C
[[[self.ref child:@"users"] child:authResult.user.uid] setValue:@{@"username": username}];
以這種方式使用 setValue
會覆寫指定位置的資料,
包括任何子節點不過,您仍可在沒有權限的情況下更新孩子
重寫整個物件如要允許使用者更新個人資料
您可以按照下列方式更新使用者名稱:
Swift
self.ref.child("users/\(user.uid)/username").setValue(username)
Objective-C
[[[[_ref child:@"users"] child:user.uid] child:@"username"] setValue:username];
讀取資料
監聽價值事件來讀取資料
如要在路徑中讀取資料及監聽變更,請使用
observeEventType:withBlock
個待觀察 (共 FIRDatabaseReference
個)
FIRDataEventTypeValue
事件。
事件類型 | 一般用量 |
---|---|
FIRDataEventTypeValue |
讀取及監聽路徑完整內容的異動。 |
您可以使用 FIRDataEventTypeValue
事件讀取指定路徑的資料。
與活動當下一樣。此方法會在
並在每次資料 (包括任何子項) 時
並輸入變更內容系統會向事件回呼傳遞 snapshot
,當中包含該回呼
包括兒童資料如果沒有資料,系統會傳回快照
呼叫 exists()
和 nil
時,當您讀取其 value
屬性時,系統會傳回 false
。
下列範例示範社交網誌應用程式擷取 資料庫中貼文的詳細資料:
Swift
refHandle = postRef.observe(DataEventType.value, with: { snapshot in // ... })
Objective-C
_refHandle = [_postRef observeEventType:FIRDataEventTypeValue withBlock:^(FIRDataSnapshot * _Nonnull snapshot) { NSDictionary *postDict = snapshot.value; // ... }];
事件監聽器收到含有指定指定位置資料的 FIRDataSnapshot
位置是在事件發生時位於資料庫的 value
屬性中。個人中心
可以將值指派給適當的原生類型,例如 NSDictionary
。
如果位置上沒有資料,則 value
為 nil
。
讀取資料一次
使用 getData() 讀取一次
SDK 的設計用意是管理與資料庫伺服器的互動 應用程式處於連線狀態或離線。
一般而言,您應使用上述的價值事件技術,以便讀取 接收資料更新通知,以便接收來自後端的資料更新通知。這些技巧 減少用量與帳單,並經過最佳化調整 都能更輕鬆有效率地完成工作
如果只需要資料一次,可以使用 getData()
取得
儲存資料庫資料如果因任何原因導致 getData()
無法傳回
伺服器值時,用戶端會探測本機儲存空間快取,並傳回錯誤
。
以下範例說明如何擷取公開的使用者名稱 只需刪除資料庫一次:
Swift
do { let snapshot = try await ref.child("users/\(uid)/username").getData() let userName = snapshot.value as? String ?? "Unknown" } catch { print(error) }
Objective-C
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
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
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
時,您可以透過
指定金鑰的路徑如果資料儲存在多個位置,以便進行擴充
您可以使用 kubectl 指令
資料擴散傳遞。舉例來說
社交網誌應用程式可用來建立文章,並同時更新到
最近的活動動態消息和發布使用者的活動動態消息。如要這麼做,
網誌應用程式使用以下程式碼:
Swift
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
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
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
[[[_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 函式會將資料的目前狀態視為 引數並傳回要寫入的新所需狀態
以社交網誌應用程式為例,您可以讓使用者: 為貼文加上星號、移除星號,並追蹤貼文獲得的星星數量 如下所示:
Swift
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
[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
。伺服器會比較
與目前值相比較,並在發現
或拒絕值如果交易遭拒,伺服器會傳回
用戶端目前的值,便會使用
更新的值。系統會重複此步驟,直到接受交易或交易金額過多為止
整體伺服器端增量
在上述用途中,我們要將兩個值寫入資料庫: 使用者為貼文加上星號/移除星號,以及逐漸增加的星號數量。如果我們 就可以知道使用者已為貼文加上星號 而不是交易作業
Swift
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
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 用戶端會將這些資料與遠端資料庫同步處理 並與其他用戶端共用。
因此,所有寫入資料庫的動作都會立即觸發本機事件, 任何資料都會寫入伺服器也就是說,您的應用程式 回應,無論網路延遲或連線。
連線恢復後,應用程式會收到一組適當的 以便用戶端與目前的伺服器狀態同步, 即可撰寫任何自訂程式碼
我們將在下列單元中進一步說明離線行為: 進一步瞭解線上和離線功能。