iOS でのデータの保存

Firebase Realtime Database にデータを書き込むメソッドは次の 4 種類です。

メソッド 一般的な使用例
setValue users/<user-id>/<username> など、定義済みのパスへのデータの書き込みや、データの置換を行います。
childByAutoId データのリストに追加します。childByAutoId を呼び出すたびに、user-posts/<user-id>/<unique-post-id> のような一意の識別子としても使用できる一意のキーが生成されます。
updateChildValues データのすべてを置換することなく、定義済みのパスのキーの一部を更新します。
runTransactionBlock 同時更新によって破損する可能性がある複合データを更新します。

参照でのデータの書き込み、更新、削除

基本的な書き込み操作

基本的な書き込み操作には、setValue を使用してデータを特定の参照に保存できます。そのパスにある既存のデータが置換されます。このメソッドを使用してできる内容は次のとおりです。

  • 次のような、使用可能な JSON 型に対応する型を渡します。
    • NSString
    • NSNumber
    • NSDictionary
    • NSArray

たとえば、次のように setValue でユーザーを追加できます。

Objective-C

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

Swift

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

setValue をこの方法で使用すると、特定の場所にあるデータ(子ノードも含む)が上書きされます。ただし、オブジェクト全体を書き換えずに子を更新することも可能です。users に自分のプロフィールの更新を許可する場合、次のように username を更新できます。

Objective-C

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

Swift

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

データのリストへの追加

childByAutoId メソッドを使用して、マルチユーザー アプリケーションでリストにデータを追加します。指定した Firebase 参照に新しい子が追加されると、そのたびに childByAutoId メソッドは一意のキーを生成します。この自動生成されたキーをリスト内の新しい各要素に使用することで、書き込みの競合を伴わずに複数のクライアントが同時に子を同じ場所に追加できます。childByAutoId によって生成される一意のキーはタイムスタンプに基づいているので、リストのアイテムは自動的に時系列で並べ替えられます。

childByAutoId メソッドによって返された新しいデータを参照することで、子の自動生成されたキーの値を取得することも、子のデータを設定することも可能になります。 childByAutoId 参照の getKey を呼び出すと、自動生成されたキーの値が返されます。

この自動生成されたキーを使用すると、データ構造を平坦化しやすくなります。詳細については、データのファンアウトのをご覧ください。

特定のフィールドの更新

他の子ノードを上書きすることなく、ノードの特定の複数の子に同時に書き込むには、updateChildValues メソッドを使用します。

updateChildValues の呼び出し時に、キーのパスを指定して下位レベルの子の値を更新できます。拡張性を向上させるためにデータが複数の場所に保存されている場合、データのファンアウトを使用してそのデータのすべてのインスタンスを更新できます。たとえば、ソーシャルブログ アプリで、投稿を作成して、それと同時にその投稿から最近のアクティビティ フィードと投稿ユーザーのアクティビティ フィードを更新するとします。これを実現するには、ブログアプリで次のようなコードを使用します。

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];

Swift

let key = ref.child("posts").childByAutoId().key
let post = ["uid": userID,
            "author": username,
            "title": title,
            "body": body]
let childUpdates = ["/posts/\(key)": post,
                    "/user-posts/\(userID)/\(key)/": post]
ref.updateChildValues(childUpdates)

この例では、childByAutoId を使用して /posts/$postid にある全ユーザーの投稿を含んでいるノードに投稿を作成し、それと同時に getKey() でキーを取得しています。その後、このキーを使用して、/user-posts/$userid/$postid にあるユーザーの投稿に別のエントリを作成できます。

これらのパスを使用すると、上記の例で両方の場所に新しい投稿を作成したように、updateChildValues を 1 回呼び出すだけで JSON ツリー内の複数の場所に対して更新を同時に実行できます。この方法による同時更新はアトミック(不可分)です。つまり、すべての更新が成功するか、すべての更新が失敗するかのどちらかです。

データの削除

データを削除する最も簡単な方法は、そのデータの場所への参照の removeValue を呼び出すことです。

また、setValueupdateChildValues など、他の書き込み操作の値として nil を指定する方法でも削除できます。この方法と updateChildValues を併用すると、API を 1 回呼び出すだけで複数の子を削除できます。

完了コールバックの受信

Firebase Realtime Database サーバーにデータが commit(確定)されたタイミングを把握するには、完了リスナーを追加します。setValueupdateChildValues のどちらも、書き込みがデータベースに commit されたときに呼び出される完了リスナーをオプションとして取ります。なんらかの理由で呼び出しに失敗した場合、失敗した理由を示すエラー オブジェクトがリスナーに渡されます。

トランザクションとしてのデータの保存

増分カウンタなど、同時変更によって破損する可能性があるデータを操作する場合は、transaction 操作を使用できます。 この操作には、2 つの引数(update 関数とオプションの完了コールバック)を与えます。update 関数はデータの現在の状態を引数として取り、書き込みたい新しい状態を返します。

たとえば、このソーシャルブログ アプリの例では、次のようにして、投稿にスターを付ける / 投稿のスターを取り消す操作をユーザーに許可し、投稿で得られたスターの数を追跡できます。

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 objectForKey:@"stars"];
  if (!stars) {
    stars = [[NSMutableDictionary alloc] initWithCapacity:1];
  }
  NSString *uid = [FIRAuth auth].currentUser.uid;
  int starCount = [post[@"starCount"] intValue];
  if ([stars objectForKey: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"] = [NSNumber numberWithInt:starCount];

  // Set value and report transaction success
  [currentData setValue:post];
  return [FIRTransactionResult successWithValue:currentData];
} andCompletionBlock:^(NSError * _Nullable error,
                       BOOL committed,
                       FIRDataSnapshot * _Nullable snapshot) {
  // Transaction completed
  if (error) {
    NSLog(@"%@", error.localizedDescription);
  }
}];

Swift

ref.runTransactionBlock({ (currentData: FIRMutableData) -> FIRTransactionResult in
  if var post = currentData.value as? [String : AnyObject], let uid = FIRAuth.auth()?.currentUser?.uid {
    var stars : Dictionary<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.removeValueForKey(uid)
    } else {
      // Star the post and add self to stars
      starCount += 1
      stars[uid] = true
    }
    post["starCount"] = starCount
    post["stars"] = stars

    // Set value and report transaction success
    currentData.value = post

    return FIRTransactionResult.successWithValue(currentData)
  }
  return FIRTransactionResult.successWithValue(currentData)
}) { (error, committed, snapshot) in
  if let error = error {
    print(error.localizedDescription)
  }
}

トランザクションを使用することで、複数のユーザーが同じ投稿にスターを同時に付けた場合や、クライアントのデータが古くなった場合でも、スターの数が不正確になることを防ぎます。FIRMutableData クラスに含まれている値は、初期状態では、パスについてクライアントが最後に認識した値か、そのような値がない場合は nil になります。サーバーは、この初期値をその現在の値と比較し、値が一致した場合はトランザクションを受け入れ、そうでない場合は拒否します。トランザクションが拒否された場合、サーバーは現在の値をクライアントに返します。クライアントは更新された値でトランザクションを再度実行します。この処理は、トランザクションが受け入れられるか、試行が上限の回数に達するまで繰り返されます。

オフラインでのデータの書き込み

クライアントでネットワーク接続が切断された場合でも、アプリは引き続き適切に機能します。

Firebase データベースに接続しているクライアントはそれぞれ、アクティブ データの内部バージョンを独自に保持しています。データが書き込まれると、まず、このローカル バージョンに書き込まれます。次に Firebase クライアントは、「ベスト エフォート」ベースでそのデータをリモート データベース サーバーや他のクライアントと同期します。

その結果、データベースへの書き込みはすべて、直ちにローカル イベントをトリガーします(これは、サーバーにデータが書き込まれる前の段階です)。つまり、ネットワークのレイテンシや接続に関係なく、アプリは応答性の高い状態を維持します。

接続が再確立されると、アプリは適切な一連のイベントを受信して、クライアントが現在のサーバー状態と同期するようにします。この処理のためにカスタムコードを記述する必要はありません。

次のステップ

フィードバックを送信...