Activer les fonctionnalités hors connexion

Les applications Firebase fonctionnent même si votre application perd temporairement sa connexion réseau. De plus, Firebase fournit des outils permettant de conserver les données localement, la gestion de la présence et de la latence.

Persistance de disque

Les applications Firebase gèrent automatiquement les interruptions de réseau temporaires. Les données mises en cache sont disponibles hors connexion, et Firebase renvoie toutes les écritures lorsque la connectivité réseau est rétablie.

Lorsque vous activez la persistance du disque, votre application écrit les données localement sur le pour que votre application conserve son état hors connexion, même si l'utilisateur ou le système d'exploitation redémarre l'application.

Vous pouvez activer la persistance de disque avec une seule ligne de code.

FirebaseDatabase.instance.setPersistenceEnabled(true);

Comportement de persistance

Si vous activez la persistance, toutes les données que le client Firebase Realtime Database se synchronise alors qu'en ligne reste sur le disque et est disponible hors connexion, même lorsque l'utilisateur ou le système d'exploitation redémarre l'application. Cela signifie que l'application fonctionne comme elle le ferait en ligne en utilisant les données locales stockées dans le cache. Les rappels d'écouteur continueront de se déclencher pour les mises à jour locales.

Le client Firebase Realtime Database conserve automatiquement une file d'attente de toutes les opérations d'écriture effectuées lorsque votre application est hors connexion. Lorsque la persistance est activée, cette file d'attente est également conservée sur le disque afin que toutes vos écritures soient disponibles lorsque l'utilisateur ou le système d'exploitation redémarre l'application. Lorsque l'application retrouve la connectivité, toutes les opérations sont envoyées au serveur Firebase Realtime Database.

Si votre application utilise Firebase Authentication, le client Firebase Realtime Database conserve le jeton d'authentification de l'utilisateur lors des redémarrages de l'application. Si le jeton d'authentification expire alors que votre application est hors connexion, le client met en pause les opérations d'écriture jusqu'à ce que votre application réauthentifie l'utilisateur. Sinon, les opérations d'écriture risquent d'échouer en raison de règles de sécurité.

Maintenir les données à jour

Firebase Realtime Database synchronise et stocke une copie locale des données pour les écouteurs actifs. De plus, vous pouvez synchroniser des établissements spécifiques.

final scoresRef = FirebaseDatabase.instance.ref("scores");
scoresRef.keepSynced(true);

Le client Firebase Realtime Database télécharge automatiquement les données à ces emplacements et les synchronise, même si la référence ne comporte pas d'écouteurs actifs. Vous pouvez désactiver à nouveau la synchronisation à l'aide de la commande la ligne de code suivante.

scoresRef.keepSynced(false);

Par défaut, 10 Mo de données précédemment synchronisées sont mises en cache. Il doit s'agir pour la plupart des applications. Si le cache dépasse sa taille configurée, Firebase Realtime Database supprime définitivement les données qui ont été utilisées le moins récemment. Les données synchronisées ne sont pas supprimées définitivement du cache.

Interroger des données hors connexion

Firebase Realtime Database stocke les données renvoyées par une requête pour les utiliser hors connexion. Pour les requêtes créées hors connexion, Firebase Realtime Database continue de fonctionner pour les données précédemment chargées. Si les données demandées ne sont pas chargées, Firebase Realtime Database charge les données à partir du cache local. Lorsque la connectivité réseau est à nouveau disponible, les données sont chargées et reflètent la requête.

Par exemple, ce code interroge les quatre derniers éléments d'une base de données de scores :

final scoresRef = FirebaseDatabase.instance.ref("scores");
scoresRef.orderByValue().limitToLast(4).onChildAdded.listen((event) {
  debugPrint("The ${event.snapshot.key} dinosaur's score is ${event.snapshot.value}.");
});

Supposons que l'utilisateur perde la connexion, passe en mode hors connexion et redémarre l'application. Lorsqu'elle est toujours hors connexion, l'application interroge les deux derniers éléments de la même localisation. Cette requête renverra les deux derniers éléments, car l'application a chargé les quatre éléments de la requête ci-dessus.

scoresRef.orderByValue().limitToLast(2).onChildAdded.listen((event) {
  debugPrint("The ${event.snapshot.key} dinosaur's score is ${event.snapshot.value}.");
});

Dans l'exemple précédent, le client Firebase Realtime Database génère "enfant ajouté" pour les deux dinosaures ayant obtenu le meilleur score, en utilisant du cache persistant. Toutefois, cette "valeur" n'augmente pas. car l'application n'a plus n'ont jamais exécuté cette requête en ligne.

Si l'application demandait les six derniers éléments en mode hors connexion, elle recevrait immédiatement des événements "enfant ajouté" pour les quatre éléments mis en cache. Lorsque l'appareil revient en ligne, le client Firebase Realtime Database se synchronise avec le serveur et obtient les deux derniers événements "enfant ajouté" et "valeur" pour l'application.

Gérer les transactions hors connexion

Toutes les transactions effectuées lorsque l'application est hors connexion sont mises en file d'attente. Une fois que l'application a rétabli la connectivité réseau, les transactions sont envoyées au serveur Realtime Database.

Firebase Realtime Database propose de nombreuses fonctionnalités pour gérer les scénarios hors connexion et la connectivité réseau. Le reste de ce guide s'applique à votre application, que la persistance soit activée ou non.

Gérer la présence

Dans les applications en temps réel, il est souvent utile de détecter quand les clients se connectent et se déconnectent. Par exemple, vous pouvez marquer un utilisateur comme "hors connexion" lorsque son client se déconnecte.

Les clients Firebase Database fournissent des primitives simples que vous pouvez utiliser pour écrire dans la base de données lorsqu'un client se déconnecte de Firebase Database serveurs. Ces mises à jour ont lieu que le client se déconnecte correctement ou non, Vous pouvez donc compter sur eux pour nettoyer les données même en cas de perte de connexion. ou si un client plante. Toutes les opérations d'écriture, y compris le paramétrage, de mise à jour et de suppression peuvent être effectuées lors d'une déconnexion.

Voici un exemple simple d'écriture de données à la déconnexion à l'aide de la classe Primitive onDisconnect:

final presenceRef = FirebaseDatabase.instance.ref("disconnectmessage");
// Write a string when this client loses connection
presenceRef.onDisconnect().set("I disconnected!");

Fonctionnement de onDisconnect

Lorsque vous établissez une opération onDisconnect(), elle réside sur le serveur Firebase Realtime Database. Le serveur vérifie la sécurité pour s'assurer que l'utilisateur peut effectuer l'événement d'écriture demandé et informe votre application si elle n'est pas valide. Le serveur surveille la connexion. Si, à un moment donné, la connexion expire fermé activement par le client Realtime Database, le serveur vérifie la sécurité une deuxième fois (pour s'assurer que l'opération est toujours valide), puis appelle l'événement.

try {
    await presenceRef.onDisconnect().remove();
} catch (error) {
    debugPrint("Could not establish onDisconnect event: $error");
}

Un événement onDisconnect peut également être annulé en appelant .cancel() :

final onDisconnectRef = presenceRef.onDisconnect();
onDisconnectRef.set("I disconnected");
// ...
// some time later when we change our minds
// ...
onDisconnectRef.cancel();

Détecter l'état de la connexion

Pour de nombreuses fonctionnalités liées à la présence, il est utile que votre application sache quand elle est en ligne ou hors connexion. Firebase Realtime Database fournit un emplacement spécial à /.info/connected, qui est mis à jour chaque fois que l'état de connexion du client Firebase Realtime Database change. Voici un exemple :

final connectedRef = FirebaseDatabase.instance.ref(".info/connected");
connectedRef.onValue.listen((event) {
  final connected = event.snapshot.value as bool? ?? false;
  if (connected) {
    debugPrint("Connected.");
  } else {
    debugPrint("Not connected.");
  }
});

/.info/connected est une valeur booléenne qui n'est pas synchronisée entre les clients de Realtime Database, car elle dépend de l'état du client. En d'autres termes, si un client lit /.info/connected comme "false", ce n'est pas garantir qu'un client distinct lira également « false ».

Gérer la latence

Codes temporels du serveur

Les serveurs Firebase Realtime Database fournissent un mécanisme permettant d'insérer des codes temporels générés sur le serveur en tant que données. Cette fonctionnalité, combinée à onDisconnect, permet d'identifier facilement et de manière fiable les éléments suivants : Heure de déconnexion d'un client Realtime Database:

final userLastOnlineRef =
    FirebaseDatabase.instance.ref("users/joe/lastOnline");
userLastOnlineRef.onDisconnect().set(ServerValue.timestamp);

Décalage d'horloge

Bien que ServerValue.timestamp soit beaucoup plus précis et préférable pour la plupart des opérations de lecture/écriture, il peut parfois être utile d'estimer le décalage de l'horloge du client par rapport aux serveurs de Firebase Realtime Database. Vous pouvez associer un rappel à l'emplacement /.info/serverTimeOffset pour obtenir la valeur, en millisecondes, que les clients Firebase Realtime Database ajoutent à l'heure locale signalée (heure d'epoch en millisecondes) afin d'estimer l'heure du serveur. Notez que la précision de ce décalage peut être affectée par la latence réseau. Il est donc principalement utile pour détecter les écarts importants (> 1 seconde) dans l'heure de l'horloge.

final offsetRef = FirebaseDatabase.instance.ref(".info/serverTimeOffset");
offsetRef.onValue.listen((event) {
  final offset = event.snapshot.value as num? ?? 0.0;
  final estimatedServerTimeMs =
      DateTime.now().millisecondsSinceEpoch + offset;
});

Exemple d'application Presence

En combinant les opérations de déconnexion à la surveillance de l'état de la connexion et aux codes temporels du serveur, vous pouvez créer un système de présence des utilisateurs. Dans ce système, chaque utilisateur stocke des données dans un emplacement de base de données pour indiquer si Le client Realtime Database est en ligne. Les clients définissent cet emplacement sur "true" lorsqu'ils se connectent et sur un code temporel lorsqu'ils se déconnectent. Cet horodatage indique quand l'utilisateur donné s'est connecté pour la dernière fois.

Notez que votre application doit mettre en file d'attente les opérations de déconnexion avant qu'un utilisateur ne soit marquée en ligne, pour éviter toute condition de concurrence dans l'éventualité où le client la connexion réseau est perdue avant que les deux commandes puissent être envoyées au serveur.

// Since I can connect from multiple devices, we store each connection
// instance separately any time that connectionsRef's value is null (i.e.
// has no children) I am offline.
final myConnectionsRef =
    FirebaseDatabase.instance.ref("users/joe/connections");

// Stores the timestamp of my last disconnect (the last time I was seen online)
final lastOnlineRef =
    FirebaseDatabase.instance.ref("/users/joe/lastOnline");

final connectedRef = FirebaseDatabase.instance.ref(".info/connected");
connectedRef.onValue.listen((event) {
  final connected = event.snapshot.value as bool? ?? false;
  if (connected) {
    final con = myConnectionsRef.push();

    // When this device disconnects, remove it.
    con.onDisconnect().remove();

    // When I disconnect, update the last time I was seen online.
    lastOnlineRef.onDisconnect().set(ServerValue.timestamp);

    // Add this device to my connections list.
    // This value could contain info about the device or a timestamp too.
    con.set(true);
  }
});