Habilita funciones sin conexión en Android

Las aplicaciones de Firebase funcionan incluso si tu app pierde temporalmente la conexión de red. Además, Firebase proporciona herramientas para la persistencia local de los datos, la administración de la presencia y el control de la latencia.

Persistencia en disco

Las apps de Firebase controlan las interrupciones temporales de red de manera automática. Los datos almacenados en caché están disponibles sin conexión y Firebase vuelve a enviar todas las operaciones de escritura cuando se restablece la conectividad de red.

Cuando habilitas la persistencia en disco, la app escribe los datos de manera local en el dispositivo para poder mantener el estado mientras está sin conexión, incluso si el usuario o el sistema operativo la reinician.

Puedes habilitar la persistencia en disco con una sola línea de código.

Kotlin+KTX

Firebase.database.setPersistenceEnabled(true)
OfflineActivity.kt

Java

FirebaseDatabase.getInstance().setPersistenceEnabled(true);
OfflineActivity.java

Comportamiento de la persistencia

Cuando habilitas la persistencia, los datos que sincroniza el cliente de Firebase Realtime Database mientras está en línea persisten en el disco y están disponibles sin conexión, incluso cuando el usuario o el sistema operativo reinician la app. Esto significa que la app funciona como lo haría en línea con los datos locales almacenados en la caché. Las devoluciones de llamada de los objetos de escucha continúan activándose para las actualizaciones locales.

El cliente de Firebase Realtime Database mantiene automáticamente una cola de todas las operaciones de escritura ejecutadas mientras la app está sin conexión. Cuando se habilita la persistencia, esta cola persiste en el disco, de manera que todas las escrituras están disponibles cuando el usuario o el sistema operativo reinician la app. Cuando se vuelve a conectar la app, todas las operaciones se envían al servidor de Firebase Realtime Database.

Si la app usa Firebase Authentication, el cliente de Firebase Realtime Database conserva el token de autenticación del usuario cuando se la reinicia. Si el token de autenticación vence mientras la app está sin conexión, el cliente pausa las operaciones de escritura hasta que la app vuelva a autenticar al usuario. De lo contrario, las operaciones de escritura podrían fallar debido a las reglas de seguridad.

Mantén los datos actualizados

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

Kotlin+KTX

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

Java

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

El cliente de Firebase Realtime Database descarga automáticamente los datos a estas ubicaciones y las mantiene sincronizadas, incluso si la referencia no tiene objetos de escucha activos. Puedes volver a desactivar la sincronización con la siguiente línea de código.

Kotlin+KTX

scoresRef.keepSynced(false)
OfflineActivity.kt

Java

scoresRef.keepSynced(false);
OfflineActivity.java

De forma predeterminada, se almacenan en caché 10 MB de datos antes sincronizados. Esto debería ser suficiente para la mayoría de las aplicaciones. Si la caché sobrepasa el tamaño configurado, Firebase Realtime Database borra de manera definitiva los datos que se usaron de forma menos reciente. Los datos que se mantienen sincronizados no se borran definitivamente de la memoria caché.

Consulta datos sin conexión

Firebase Realtime Database almacena los datos que se muestran con una consulta para usarlos sin conexión. En el caso de las consultas que se crean sin conexión, Firebase Realtime Database continúa trabajando con los datos cargados con anterioridad. Si no se cargaron los datos solicitados, Firebase Realtime Database carga datos de la caché local. Cuando la conectividad de red vuelva a estar disponible, se cargarán los datos conforme a la consulta.

Por ejemplo, este código consulta los últimos cuatro elementos de Firebase Realtime Database de puntuaciones

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}")
    }

    // ...
})
OfflineActivity.kt

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());
    }

    // ...
});
OfflineActivity.java

Supongamos que falla la conectividad, se desconecta el usuario y se reinicia la app. Mientras está sin conexión, la app consulta los últimos dos elementos de la misma ubicación. Esta consulta dará como resultado los dos últimos elementos correctamente, porque la app cargó 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}")
    }

    // ...
})
OfflineActivity.kt

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());
    }

    // ...
});
OfflineActivity.java

En el ejemplo anterior, el cliente de Firebase Realtime Database genera eventos de tipo "child added" para los dos dinosaurios con puntuaciones más altas, a partir de la memoria caché que persistió. Sin embargo, no generará un evento "value", ya que la app nunca ejecutó esa consulta mientras estaba en línea.

Si la aplicación solicitara los últimos seis elementos mientras está sin conexión, obtendría los eventos "child added" de inmediato para los cuatro elementos en caché. Cuando el dispositivo vuelva a estar en línea, el cliente de Firebase Realtime Database se sincronizará con el servidor y obtendrá los dos últimos eventos "child added" y el "value" para la app.

Administra transacciones sin conexión

Todas las transacciones que se ejecutan mientras la app está sin conexión se agregan a la cola. Cuando la app recupera la conectividad de red, las transacciones se envían al servidor de Realtime Database.

Las transacciones no persisten cuando se reinicia la app

Aunque esté habilitada la persistencia, las transacciones no permanecen cuando se reinicia la app. Por lo tanto, no puedes confiar en que las transacciones realizadas sin conexión se confirmen en Firebase Realtime Database. Para brindarle una experiencia óptima al usuario, la app debe mostrar que una transacción todavía no se guardó en Firebase Realtime Database, o debes asegurarte de que la app la recuerde manualmente y vuelva a ejecutarla después de reiniciarse.

Firebase Realtime Database tiene muchas funciones para abordar situaciones sin conexión y la conectividad de red. El resto de la guía se aplica a la app sin importar si habilitaste la persistencia.

Administra la presencia

En aplicaciones en tiempo real, detectar en qué momento se conectan y desconectan los clientes suele ser útil. Por ejemplo, puede ser conveniente marcar a un usuario como "sin conexión" cuando el 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 sin importar si el cliente se desconecta de manera limpia o no, de modo que puedes confiar en ellas y limpiar los datos, incluso si se pierde la conexión o un cliente falla. Cuando ocurre una desconexión, se pueden ejecutar todas las operaciones de escritura (que incluyen configurar, actualizar y quitar).

A continuación, se muestra un ejemplo sencillo de escritura de datos cuando ocurre una desconexión, mediante la primitiva onDisconnect:

Kotlin+KTX

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

Java

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

Cómo funciona onDisconnect

Cuando estableces una operación onDisconnect(), esta se aloja en el servidor Firebase Realtime Database. El servidor verifica la seguridad para comprobar que el usuario pueda ejecutar el evento de escritura solicitado y le informa a la app si no es válido. Después, el servidor supervisa la conexión. Si en algún momento se agota el tiempo de espera de la conexión o el cliente de Realtime Database la cierra, el servidor verifica la seguridad por segunda vez (para asegurarse de que la operación todavía sea válida) y después invoca el evento.

La app puede usar la devolución de llamada en la operación de escritura para asegurarse de que se haya adjuntado correctamente la operación onDisconnect:

Kotlin+KTX

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

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());
        }
    }
});
OfflineActivity.java

Los eventos onDisconnect también se pueden cancelar llamando a .cancel():

Kotlin+KTX

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

Java

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

Detecta el estado de conexión

Para muchas funciones relacionadas con la presencia, es útil que la app sepa si está en línea o no. 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. A continuación, se muestra 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")
    }
})
OfflineActivity.kt

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");
    }
});
OfflineActivity.java

/.info/connected es un valor booleano que no se sincroniza entre clientes de Realtime Database, ya que el valor depende del estado del cliente. En otras palabras, si un cliente lee que /.info/connected es falso, no se garantiza que otro cliente también lo lea como falso.

En Android, Firebase administra el estado de conexión de forma automática para reducir el uso del ancho de banda y de batería. Cuando un cliente no tiene objetos de escucha activos ni operaciones de escritura o de onDisconnect pendientes, y no se desconecta de manera explícita con el método goOffline, Firebase cierra la conexión después de 60 segundos de inactividad.

Administra 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 función, combinada con onDisconnect, proporciona una manera simple y confiable de tomar nota de la hora a la que se desconectó el cliente de Realtime Database:

Kotlin+KTX

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

Java

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

Sesgo de reloj

Aunque firebase.database.ServerValue.TIMESTAMP es mucho más preciso y se prefiere para la mayoría de las operaciones de lectura o escritura, en ocasiones, puede ser útil hacer un cálculo aproximado del sesgo de reloj del cliente en relación con 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 a la hora local informada (época en milisegundos) para calcular de manera aproximada la hora del servidor. Ten en cuenta que la precisión de este ajuste horario puede verse afectada por la latencia de la red, por lo que es útil principalmente para descubrir discrepancias grandes en la hora del reloj (de más de 1 segundo).

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")
    }
})
OfflineActivity.kt

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");
    }
});
OfflineActivity.java

Ejemplo de app con presencia

Puedes combinar operaciones de desconexión con la supervisión del estado de conexión y las marcas de tiempo del servidor para crear un sistema de presencia del usuario. En este sistema, cada usuario almacena datos en una ubicación de la base de datos para indicar si el cliente de Realtime Database está en línea. Los clientes configuran esta ubicación con el valor "true" cuando están en línea y dejan una marca de tiempo cuando se desconectan. La marca de tiempo indica la hora en que el usuario estuvo en línea por última vez.

Ten en cuenta que la app debe poner en cola las operaciones de desconexión antes de que se marque a un usuario como "en línea", a fin de evitar cualquier condición de carrera en caso de que la conexión de red del cliente se pierda antes de que se envíen al servidor los dos comandos.

Aquí se muestra un sistema simple de presencia del usuario:

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")
    }
})
OfflineActivity.kt

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");
    }
});
OfflineActivity.java