Appleプラットフォームのオフライン機能

持続性の振る舞い

永続性を有効にすると、オンライン中に Firebase Realtime Database クライアントが同期するデータはすべてディスクに保持され、ユーザーまたはオペレーティング システムがアプリを再起動した場合でも、オフラインで使用できます。これは、キャッシュに保存されたローカル データを使用して、アプリがオンラインの場合と同じように動作することを意味します。リスナー コールバックは、ローカル アップデートに対して引き続き発生します。

Firebase Realtime Database クライアントは、アプリがオフラインの間に実行されるすべての書き込み操作のキューを自動的に保持します。永続化を有効にすると、このキューもディスクに永続化されるため、ユーザーまたはオペレーティング システムがアプリを再起動したときに、すべての書き込みを利用できるようになります。アプリが接続を回復すると、すべての操作が Firebase Realtime Database サーバーに送信されます。

アプリでFirebase Authenticationを使用している場合、Firebase Realtime Database クライアントはアプリの再起動後もユーザーの認証トークンを保持します。アプリがオフラインのときに認証トークンの有効期限が切れると、アプリがユーザーを再認証するまで、クライアントは書き込み操作を一時停止します。そうしないと、セキュリティ ルールが原因で書き込み操作が失敗する可能性があります。

データを最新に保つ

Firebase Realtime Database は、アクティブなリスナーのデータのローカル コピーを同期して保存します。さらに、特定の場所を同期することができます。

let scoresRef = Database.database().reference(withPath: "scores")
scoresRef.keepSynced(true)

FIRDatabaseReference *scoresRef = [[FIRDatabase database] referenceWithPath:@"scores"];
[scoresRef keepSynced:YES];

Firebase Realtime Database クライアントは、これらの場所にあるデータを自動的にダウンロードし、参照にアクティブなリスナーがない場合でも同期を維持します。次のコード行を使用して、同期をオフに戻すことができます。

scoresRef.keepSynced(false)

[scoresRef keepSynced:NO];

デフォルトでは、以前に同期された 10MB のデータがキャッシュされます。ほとんどのアプリケーションではこれで十分です。キャッシュが構成されたサイズを超えると、Firebase Realtime Database は最近使用されていないデータをパージします。同期が保たれているデータは、キャッシュから消去されません。

オフラインでのデータのクエリ

Firebase Realtime Database は、オフライン時に使用するために、クエリから返されたデータを保存します。オフライン中に作成されたクエリの場合、Firebase Realtime Database は以前に読み込まれたデータに対して引き続き機能します。リクエストされたデータが読み込まれていない場合、Firebase Realtime Database はローカル キャッシュからデータを読み込みます。ネットワーク接続が再び利用可能になると、データが読み込まれ、クエリが反映されます。

たとえば、次のコードは、Firebase Realtime Database のスコアの最後の 4 つの項目をクエリします。

let scoresRef = Database.database().reference(withPath: "scores")
scoresRef.queryOrderedByValue().queryLimited(toLast: 4).observe(.childAdded) { snapshot in
  print("The \(snapshot.key) dinosaur's score is \(snapshot.value ?? "null")")
}

FIRDatabaseReference *scoresRef = [[FIRDatabase database] referenceWithPath:@"scores"];
[[[scoresRef queryOrderedByValue] queryLimitedToLast:4]
    observeEventType:FIRDataEventTypeChildAdded withBlock:^(FIRDataSnapshot *snapshot) {
      NSLog(@"The %@ dinosaur's score is %@", snapshot.key, snapshot.value);
    }];

ユーザーが接続を失い、オフラインになり、アプリを再起動したとします。まだオフラインの間、アプリは同じ場所から最後の 2 つのアイテムを照会します。アプリは上記のクエリで 4 つの項目すべてを読み込んだため、このクエリは最後の 2 つの項目を正常に返します。

scoresRef.queryOrderedByValue().queryLimited(toLast: 2).observe(.childAdded) { snapshot in
  print("The \(snapshot.key) dinosaur's score is \(snapshot.value ?? "null")")
}

[[[scoresRef queryOrderedByValue] queryLimitedToLast:2]
    observeEventType:FIRDataEventTypeChildAdded withBlock:^(FIRDataSnapshot *snapshot) {
      NSLog(@"The %@ dinosaur's score is %@", snapshot.key, snapshot.value);
    }];

前の例では、Firebase Realtime Database クライアントは、永続キャッシュを使用して、スコアが最も高い 2 つの恐竜の「子追加」イベントを発生させます。ただし、アプリはオンライン中にそのクエリを実行したことがないため、「値」イベントは発生しません。

アプリがオフライン中に最後の 6 つのアイテムを要求すると、キャッシュされた 4 つのアイテムの「子が追加されました」イベントがすぐに取得されます。デバイスがオンラインに戻ると、Firebase Realtime Database クライアントはサーバーと同期し、アプリの最後の 2 つの「child added」イベントと「value」イベントを取得します。

トランザクションのオフライン処理

アプリがオフラインのときに実行されるすべてのトランザクションは、キューに入れられます。アプリがネットワーク接続を回復すると、トランザクションが Realtime Database サーバーに送信されます。

onDisconnect の仕組み

onDisconnect()操作を確立すると、その操作は Firebase Realtime Database サーバー上に存在します。サーバーはセキュリティをチェックして、要求された書き込みイベントをユーザーが実行できることを確認し、無効な場合はアプリに通知します。その後、サーバーは接続を監視します。いずれかの時点で接続がタイムアウトした場合、または Realtime Database クライアントによってアクティブに閉じられた場合、サーバーは (操作がまだ有効であることを確認するために) セキュリティを 2 回チェックしてから、イベントを呼び出します。

アプリは書き込み操作でコールバックを使用して、 onDisconnectが正しくアタッチされたことを確認できます。

presenceRef.onDisconnectRemoveValue { error, reference in
  if let error = error {
    print("Could not establish onDisconnect event: \(error)")
  }
}

[presenceRef onDisconnectRemoveValueWithCompletionBlock:^(NSError *error, FIRDatabaseReference *reference) {
  if (error != nil) {
    NSLog(@"Could not establish onDisconnect event: %@", error);
  }
}];

onDisconnectイベントは、 .cancel()を呼び出してキャンセルすることもできます:

presenceRef.onDisconnectSetValue("I disconnected")
// some time later when we change our minds
presenceRef.cancelDisconnectOperations()

[presenceRef onDisconnectSetValue:@"I disconnected"];
// some time later when we change our minds
[presenceRef cancelDisconnectOperations];

サーバーのタイムスタンプ

Firebase Realtime Database サーバーは、サーバー上で生成されたタイムスタンプをデータとして挿入するメカニズムを提供します。この機能をonDisconnectと組み合わせると、Realtime Database クライアントが切断された時刻を確実に記録する簡単な方法が提供されます。

let userLastOnlineRef = Database.database().reference(withPath: "users/morgan/lastOnline")
userLastOnlineRef.onDisconnectSetValue(ServerValue.timestamp())

FIRDatabaseReference *userLastOnlineRef = [[FIRDatabase database] referenceWithPath:@"users/morgan/lastOnline"];
[userLastOnlineRef onDisconnectSetValue:[FIRServerValue timestamp]];

クロック スキュー

firebase.database.ServerValue.TIMESTAMPははるかに正確であり、ほとんどの読み取り/書き込み操作に適していますが、Firebase Realtime Database のサーバーに対するクライアントのクロック スキューを推定するのに役立つ場合があります。 /.info/serverTimeOffsetの場所にコールバックをアタッチして、Firebase Realtime Database クライアントがサーバー時間を推定するためにローカルで報告された時間 (ミリ秒単位のエポック時間) に追加する値 (ミリ秒単位) を取得できます。このオフセットの精度はネットワーク レイテンシの影響を受ける可能性があるため、主にクロック時間の大きな (1 秒を超える) 不一致を検出するのに役立ちます。

let offsetRef = Database.database().reference(withPath: ".info/serverTimeOffset")
offsetRef.observe(.value, with: { snapshot in
  if let offset = snapshot.value as? TimeInterval {
    print("Estimated server time in milliseconds: \(Date().timeIntervalSince1970 * 1000 + offset)")
  }
})

FIRDatabaseReference *offsetRef = [[FIRDatabase database] referenceWithPath:@".info/serverTimeOffset"];
[offsetRef observeEventType:FIRDataEventTypeValue withBlock:^(FIRDataSnapshot *snapshot) {
  NSTimeInterval offset = [(NSNumber *)snapshot.value doubleValue];
  NSTimeInterval estimatedServerTimeMs = [[NSDate date] timeIntervalSince1970] * 1000.0 + offset;
  NSLog(@"Estimated server time: %0.3f", estimatedServerTimeMs);
}];