Habilitación de capacidades sin conexión en Android

Las aplicaciones de Firebase funcionan incluso si su aplicación pierde temporalmente su conexión de red. Además, Firebase proporciona herramientas para conservar datos localmente, administrar la presencia y controlar la latencia.

Persistencia del disco

Las aplicaciones de Firebase manejan automáticamente las interrupciones temporales de la red. Los datos almacenados en caché están disponibles sin conexión y Firebase reenvía cualquier escritura cuando se restablece la conectividad de la red.

Cuando habilita la persistencia del disco, su aplicación escribe los datos localmente en el dispositivo para que pueda mantener el estado mientras está fuera de línea, incluso si el usuario o el sistema operativo reinicia la aplicación.

Puede habilitar la persistencia del disco con solo una línea de código.

Kotlin+KTX

Firebase.database.setPersistenceEnabled(true)

Java

FirebaseDatabase.getInstance().setPersistenceEnabled(true);

Comportamiento de persistencia

Al habilitar la persistencia, cualquier dato que el cliente Firebase Realtime Database sincronice mientras está en línea persiste en el disco y está disponible sin conexión, incluso cuando el usuario o el sistema operativo reinicia la aplicación. Esto significa que su aplicación funciona como lo haría en línea utilizando los datos locales almacenados en el caché. Las devoluciones de llamadas de los oyentes seguirán enviándose para recibir actualizaciones locales.

El cliente Firebase Realtime Database mantiene automáticamente una cola de todas las operaciones de escritura que se realizan mientras su aplicación está sin conexión. Cuando la persistencia está habilitada, esta cola también persiste en el disco para que todas sus escrituras estén disponibles cuando el usuario o el sistema operativo reinicie la aplicación. Cuando la aplicación recupera la conectividad, todas las operaciones se envían al servidor de Firebase Realtime Database.

Si su aplicación usa Firebase Authentication , el cliente Firebase Realtime Database conserva el token de autenticación del usuario durante los reinicios de la aplicación. Si el token de autenticación caduca mientras su aplicación está fuera de línea, el cliente pausa las operaciones de escritura hasta que su aplicación vuelva a autenticar al usuario; de lo contrario, las operaciones de escritura podrían fallar debido a reglas de seguridad.

Mantener los datos actualizados

Firebase Realtime Database sincroniza y almacena una copia local de los datos para los oyentes activos. Además, puede mantener sincronizadas ubicaciones específicas.

Kotlin+KTX

val scoresRef = Firebase.database.getReference("scores")
scoresRef.keepSynced(true)

Java

DatabaseReference scoresRef = FirebaseDatabase.getInstance().getReference("scores");
scoresRef.keepSynced(true);

El cliente Firebase Realtime Database descarga automáticamente los datos en estas ubicaciones y los mantiene sincronizados incluso si la referencia no tiene oyentes activos. Puede desactivar la sincronización con la siguiente línea de código.

Kotlin+KTX

scoresRef.keepSynced(false)

Java

scoresRef.keepSynced(false);

De forma predeterminada, se almacenan en caché 10 MB de datos previamente sincronizados. Esto debería ser suficiente para la mayoría de las aplicaciones. Si el caché supera su tamaño configurado, Firebase Realtime Database purga los datos que se han utilizado menos recientemente. Los datos que se mantienen sincronizados no se eliminan de la caché.

Consulta de datos sin conexión

Firebase Realtime Database almacena los datos devueltos por una consulta para usarlos sin conexión. Para consultas creadas sin conexión, Firebase Realtime Database continúa funcionando para los datos cargados previamente. Si los datos solicitados no se han cargado, Firebase Realtime Database carga datos desde el caché local. Cuando la conectividad de red vuelva a estar disponible, los datos se cargarán y reflejarán la consulta.

Por ejemplo, este código consulta los últimos cuatro elementos en una base de datos de puntuaciones en tiempo real de Firebase.

Kotlin+KTX

val scoresRef = Firebase.database.getReference("scores")
scoresRef.orderByValue().limitToLast(4).addChildEventListener(object : ChildEventListener {
    override fun onChildAdded(snapshot: DataSnapshot, previousChild: String?) {
        Log.d(TAG, "The ${snapshot.key} dinosaur's score is ${snapshot.value}")
    }

    // ...
})

Java

DatabaseReference scoresRef = FirebaseDatabase.getInstance().getReference("scores");
scoresRef.orderByValue().limitToLast(4).addChildEventListener(new ChildEventListener() {
    @Override
    public void onChildAdded(@NonNull DataSnapshot snapshot, String previousChild) {
        Log.d(TAG, "The " + snapshot.getKey() + " dinosaur's score is " + snapshot.getValue());
    }

    // ...
});

Supongamos que el usuario pierde la conexión, se desconecta y reinicia la aplicación. Mientras aún está fuera de línea, la aplicación consulta los dos últimos elementos desde la misma ubicación. Esta consulta devolverá correctamente los dos últimos elementos porque la aplicación había cargado los cuatro elementos en la consulta anterior.

Kotlin+KTX

scoresRef.orderByValue().limitToLast(2).addChildEventListener(object : ChildEventListener {
    override fun onChildAdded(snapshot: DataSnapshot, previousChild: String?) {
        Log.d(TAG, "The ${snapshot.key} dinosaur's score is ${snapshot.value}")
    }

    // ...
})

Java

scoresRef.orderByValue().limitToLast(2).addChildEventListener(new ChildEventListener() {
    @Override
    public void onChildAdded(@NonNull DataSnapshot snapshot, String previousChild) {
        Log.d(TAG, "The " + snapshot.getKey() + " dinosaur's score is " + snapshot.getValue());
    }

    // ...
});

En el ejemplo anterior, el cliente Firebase Realtime Database genera eventos de "niño agregado" para los dos dinosaurios con la puntuación más alta, mediante el uso del caché persistente. Pero no generará un evento de "valor", ya que la aplicación nunca ejecutó esa consulta mientras estaba en línea.

Si la aplicación solicitara los últimos seis elementos sin conexión, obtendría eventos de "niño agregado" para los cuatro elementos almacenados en caché de inmediato. Cuando el dispositivo vuelve a estar en línea, el cliente Firebase Realtime Database se sincroniza con el servidor y obtiene los dos últimos eventos 'niño agregado' y 'valor' para la aplicación.

Manejo de transacciones sin conexión

Todas las transacciones que se realizan mientras la aplicación está fuera de línea se ponen en cola. Una vez que la aplicación recupera la conectividad de la red, las transacciones se envían al servidor de Realtime Database.

Gestionar la presencia

En aplicaciones en tiempo real, suele resultar útil detectar cuándo los clientes se conectan y desconectan. Por ejemplo, es posible que desees marcar a un usuario como "fuera de línea" cuando su cliente se desconecta.

Los clientes de Firebase Database proporcionan primitivas simples que puedes usar para escribir en la base de datos cuando un cliente se desconecta de los servidores de Firebase Database. Estas actualizaciones ocurren independientemente de que el cliente se desconecte limpiamente o no, por lo que puede confiar en ellas para limpiar los datos incluso si se interrumpe una conexión o un cliente falla. Todas las operaciones de escritura, incluida la configuración, actualización y eliminación, se pueden realizar tras una desconexión.

A continuación se muestra un ejemplo sencillo de escritura de datos tras una desconexión utilizando la primitiva onDisconnect :

Kotlin+KTX

val presenceRef = Firebase.database.getReference("disconnectmessage")
// Write a string when this client loses connection
presenceRef.onDisconnect().setValue("I disconnected!")

Java

DatabaseReference presenceRef = FirebaseDatabase.getInstance().getReference("disconnectmessage");
// Write a string when this client loses connection
presenceRef.onDisconnect().setValue("I disconnected!");

Cómo funciona onDisconnect

Cuando estableces una operación onDisconnect() , la operación reside en el servidor de Firebase Realtime Database. El servidor verifica la seguridad para asegurarse de que el usuario pueda realizar el evento de escritura solicitado e informa a su aplicación si no es válido. Luego, el servidor monitorea la conexión. Si en algún momento la conexión se agota o el cliente Realtime Database la cierra activamente, el servidor verifica la seguridad por segunda vez (para asegurarse de que la operación aún sea válida) y luego invoca el evento.

Su aplicación puede usar la devolución de llamada en la operación de escritura para garantizar que onDisconnect se adjuntó correctamente:

Kotlin+KTX

presenceRef.onDisconnect().removeValue { error, reference ->
    error?.let {
        Log.d(TAG, "could not establish onDisconnect event: ${error.message}")
    }
}

Java

presenceRef.onDisconnect().removeValue(new DatabaseReference.CompletionListener() {
    @Override
    public void onComplete(DatabaseError error, @NonNull DatabaseReference reference) {
        if (error != null) {
            Log.d(TAG, "could not establish onDisconnect event:" + error.getMessage());
        }
    }
});

Un evento onDisconnect también se puede cancelar llamando .cancel() :

Kotlin+KTX

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

Java

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

Detectando el estado de la conexión

Para muchas funciones relacionadas con la presencia, es útil que su aplicación sepa cuándo está en línea o fuera de línea. Firebase Realtime Database proporciona una ubicación especial en /.info/connected que se actualiza cada vez que cambia el estado de conexión del cliente de Firebase Realtime Database. Aquí hay un ejemplo:

Kotlin+KTX

val connectedRef = Firebase.database.getReference(".info/connected")
connectedRef.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(snapshot: DataSnapshot) {
        val connected = snapshot.getValue(Boolean::class.java) ?: false
        if (connected) {
            Log.d(TAG, "connected")
        } else {
            Log.d(TAG, "not connected")
        }
    }

    override fun onCancelled(error: DatabaseError) {
        Log.w(TAG, "Listener was cancelled")
    }
})

Java

DatabaseReference connectedRef = FirebaseDatabase.getInstance().getReference(".info/connected");
connectedRef.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot snapshot) {
        boolean connected = snapshot.getValue(Boolean.class);
        if (connected) {
            Log.d(TAG, "connected");
        } else {
            Log.d(TAG, "not connected");
        }
    }

    @Override
    public void onCancelled(@NonNull DatabaseError error) {
        Log.w(TAG, "Listener was cancelled");
    }
});

/.info/connected es un valor booleano que no está sincronizado entre clientes de Realtime Database porque el valor depende del estado del cliente. En otras palabras, si un cliente lee /.info/connected como falso, esto no garantiza que otro cliente también lea falso.

En Android, Firebase administra automáticamente el estado de la conexión para reducir el ancho de banda y el uso de la batería. Cuando un cliente no tiene escuchas activas, operaciones de escritura u onDisconnect pendientes y el método goOffline no lo desconecta explícitamente, Firebase cierra la conexión después de 60 segundos de inactividad.

Manejo de la latencia

Marcas de tiempo del servidor

Los servidores de Firebase Realtime Database proporcionan un mecanismo para insertar marcas de tiempo generadas en el servidor como datos. Esta característica, combinada con onDisconnect , proporciona una manera fácil de tomar nota de manera confiable del momento en que un cliente de Realtime Database se desconectó:

Kotlin+KTX

val userLastOnlineRef = Firebase.database.getReference("users/joe/lastOnline")
userLastOnlineRef.onDisconnect().setValue(ServerValue.TIMESTAMP)

Java

DatabaseReference userLastOnlineRef = FirebaseDatabase.getInstance().getReference("users/joe/lastOnline");
userLastOnlineRef.onDisconnect().setValue(ServerValue.TIMESTAMP);

Desviación del reloj

Si bien firebase.database.ServerValue.TIMESTAMP es mucho más preciso y preferible para la mayoría de las operaciones de lectura/escritura, en ocasiones puede resultar útil para estimar la desviación del reloj del cliente con respecto a los servidores de Firebase Realtime Database. Puedes adjuntar una devolución de llamada a la ubicación /.info/serverTimeOffset para obtener el valor, en milisegundos, que los clientes de Firebase Realtime Database agregan al tiempo reportado local (tiempo de época en milisegundos) para estimar el tiempo del servidor. Tenga en cuenta que la precisión de esta compensación puede verse afectada por la latencia de la red y, por lo tanto, es útil principalmente para descubrir grandes discrepancias (> 1 segundo) en el tiempo del reloj.

Kotlin+KTX

val offsetRef = Firebase.database.getReference(".info/serverTimeOffset")
offsetRef.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(snapshot: DataSnapshot) {
        val offset = snapshot.getValue(Double::class.java) ?: 0.0
        val estimatedServerTimeMs = System.currentTimeMillis() + offset
    }

    override fun onCancelled(error: DatabaseError) {
        Log.w(TAG, "Listener was cancelled")
    }
})

Java

DatabaseReference offsetRef = FirebaseDatabase.getInstance().getReference(".info/serverTimeOffset");
offsetRef.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot snapshot) {
        double offset = snapshot.getValue(Double.class);
        double estimatedServerTimeMs = System.currentTimeMillis() + offset;
    }

    @Override
    public void onCancelled(@NonNull DatabaseError error) {
        Log.w(TAG, "Listener was cancelled");
    }
});

Aplicación de presencia de muestra

Al combinar operaciones de desconexión con monitoreo del estado de la conexión y marcas de tiempo del servidor, puede crear un sistema de presencia de usuarios. En este sistema, cada usuario almacena datos en una ubicación de base de datos para indicar si un cliente de Realtime Database está en línea o no. Los clientes configuran esta ubicación como verdadera cuando se conectan y una marca de tiempo cuando se desconectan. Esta marca de tiempo indica la última vez que el usuario determinado estuvo en línea.

Tenga en cuenta que su aplicación debe poner en cola las operaciones de desconexión antes de que un usuario sea marcado en línea, para evitar condiciones de carrera en caso de que la conexión de red del cliente se pierda antes de que ambos comandos puedan enviarse al servidor.

A continuación se muestra un sistema sencillo de presencia de usuarios:

Kotlin+KTX

// 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
val database = Firebase.database
val myConnectionsRef = database.getReference("users/joe/connections")

// Stores the timestamp of my last disconnect (the last time I was seen online)
val lastOnlineRef = database.getReference("/users/joe/lastOnline")

val connectedRef = database.getReference(".info/connected")
connectedRef.addValueEventListener(object : ValueEventListener {
    override fun onDataChange(snapshot: DataSnapshot) {
        val connected = snapshot.getValue<Boolean>() ?: false
        if (connected) {
            val con = myConnectionsRef.push()

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

            // When I disconnect, update the last time I was seen online
            lastOnlineRef.onDisconnect().setValue(ServerValue.TIMESTAMP)

            // Add this device to my connections list
            // this value could contain info about the device or a timestamp too
            con.setValue(java.lang.Boolean.TRUE)
        }
    }

    override fun onCancelled(error: DatabaseError) {
        Log.w(TAG, "Listener was cancelled at .info/connected")
    }
})

Java

// 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 FirebaseDatabase database = FirebaseDatabase.getInstance();
final DatabaseReference myConnectionsRef = database.getReference("users/joe/connections");

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

final DatabaseReference connectedRef = database.getReference(".info/connected");
connectedRef.addValueEventListener(new ValueEventListener() {
    @Override
    public void onDataChange(@NonNull DataSnapshot snapshot) {
        boolean connected = snapshot.getValue(Boolean.class);
        if (connected) {
            DatabaseReference con = myConnectionsRef.push();

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

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

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

    @Override
    public void onCancelled(@NonNull DatabaseError error) {
        Log.w(TAG, "Listener was cancelled at .info/connected");
    }
});