本頁面由 Cloud Translation API 翻譯而成。
Switch to English

在Android上啟用離線功能

即使您的應用程序暫時失去了網絡連接,Firebase應用程序也可以正常工作。此外,Firebase還提供了用於在本地保留數據,管理狀態和處理延遲的工具。

磁盤持久性

Firebase應用程序會自動處理網絡臨時中斷。脫機時可以使用緩存的數據,當網絡連接恢復時,Firebase會重新發送所有寫入操作。

啟用磁盤持久性後,您的應用程序會將數據本地寫入設備,因此即使用戶或操作系統重新啟動應用程序,您的應用程序也可以在脫機時保持狀態。

您只需一行代碼即可啟用磁盤持久性。

爪哇

FirebaseDatabase.getInstance().setPersistenceEnabled(true);

Kotlin + KTX

Firebase.database.setPersistenceEnabled(true)

持續行為

通過啟用持久性,即使用戶或操作系統重新啟動應用程序,Firebase Realtime Database客戶端在聯機時將同步的任何數據也將持久保存到磁盤,並且可以脫機使用。這意味著您的應用程序將通過使用存儲在緩存中的本地數據來像聯機運行一樣工作。偵聽器回調將繼續觸發本地更新。

Firebase Realtime Database客戶端會自動將您的應用離線時執行的所有寫入操作保留在隊列中。啟用持久性後,此隊列也將持久化到磁盤,因此當用戶或操作系統重新啟動應用程序時,所有寫操作均可用。當應用恢復連接時,所有操作都將發送到Firebase實時數據庫服務器。

如果您的應用程序使用Firebase身份驗證 ,則Firebase Realtime Database客戶端會在應用程序重新啟動期間保留用戶的身份驗證令牌。如果在應用程序脫機時身份驗證令牌到期,則客戶端將暫停寫入操作,直到您的應用程序重新驗證用戶身份,否則,由於安全規則,寫入操作可能會失敗。

保持數據新鮮

Firebase實時數據庫為活動偵聽器同步並存儲數據的本地副本。此外,您可以使特定位置保持同步。

爪哇

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

Kotlin + KTX

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

即使引用沒有活動的偵聽器,Firebase Realtime Database客戶端也會自動在這些位置下載數據並保持同步。您可以使用以下代碼關閉同步。

爪哇

scoresRef.keepSynced(false);

Kotlin + KTX

scoresRef.keepSynced(false)

默認情況下,將緩存10MB以前同步的數據。對於大多數應用程序,這應該足夠了。如果緩存超出其配置的大小,則Firebase實時數據庫將清除最近最少使用的數據。保持同步的數據不會從緩存中清除。

離線查詢數據

Firebase實時數據庫存儲從查詢返回的數據,以供離線使用。對於在離線狀態下構建的查詢,Firebase實時數據庫可繼續用於先前加載的數據。如果尚未加載請求的數據,則Firebase實時數據庫將從本地緩存加載數據。當網絡連接再次可用時,數據將加載並反映查詢。

例如,此代碼在Firebase實時分數數據庫中查詢最後四個項目

爪哇

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

    // ...
});

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

    // ...
})

假設用戶斷開連接,脫機並重新啟動應用程序。在離線狀態下,該應用程序從同一位置查詢最後兩項。此查詢將成功返回最後兩個項目,因為該應用程序已在上面的查詢中加載了所有四個項目。

爪哇

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

    // ...
});

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

    // ...
})

在前面的示例中,Firebase實時數據庫客戶端通過使用持久性緩存來為得分最高的兩個恐龍引發“添加子項”事件。但這不會引發“值”事件,因為該應用程序從未在線執行過該查詢。

如果應用程序在脫機時請求最後六個項目,它將立即為四個緩存項目獲得“添加子項”事件。當設備重新聯機時,Firebase Realtime Database客戶端將與服務器同步,並獲取應用程序的最後兩個“添加子項”和“值”事件。

離線處理交易

該應用程序脫機時執行的所有事務都會排隊。應用重新獲得網絡連接後,交易將發送到實時數據庫服務器。

管理人員

在實時應用程序中,檢測客戶端何時連接和斷開連接通常很有用。例如,您可能要在用戶斷開連接時將用戶標記為“脫機”。

Firebase數據庫客戶端提供簡單的原語,當客戶端與Firebase數據庫服務器斷開連接時,您可以使用它們來寫入數據庫。無論客戶端是否乾淨地斷開連接,這些更新都會發生,因此即使連接斷開或客戶端崩潰,您也可以依靠它們來清理數據。斷開連接後即可執行所有寫操作,包括設置,更新和刪除。

這是一個使用onDisconnect原語在斷開連接時寫入數據的簡單示例:

爪哇

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

Kotlin + KTX

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

onDisconnect如何工作

建立onDisconnect()操作時,該操作將駐留在Firebase Realtime Database服務器上。服務器檢查安全性,以確保用戶可以執行請求的寫入事件,並通知您的應用程序是否無效。然後,服務器監視連接。如果在任何時候連接超時或被Realtime Database客戶端主動關閉,服務器將再次檢查安全性(以確保操作仍然有效),然後調用事件。

您的應用可以在寫操作中使用回調,以確保正確連接了onDisconnect

爪哇

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

Kotlin + KTX

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

也可以通過調用.cancel()來取消onDisconnect事件:

爪哇

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

Kotlin + KTX

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

檢測連接狀態

對於許多與狀態相關的功能,對於您的應用程序在線或離線時很有用。 Firebase Realtime Database在/.info/connected提供了一個特殊位置,該位置在Firebase Realtime Database客戶端的連接狀態每次更改時都會更新。這是一個例子:

爪哇

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

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

/.info/connected是一個布爾值,在實時數據庫客戶端之間不同步,因為該值取決於客戶端的狀態。換句話說,如果一個客戶端讀取/.info/connected為false,則不能保證單獨的客戶端也將讀取false。

在Android上,Firebase自動管理連接狀態以減少帶寬和電池消耗。如果客戶端沒有活動的偵聽器,沒有任何掛起的寫操作或onDisconnect操作,並且未通過goOffline方法顯式斷開連接,則Firebase會在閒置60秒後關閉連接。

處理延遲

服務器時間戳

Firebase實時數據庫服務器提供了一種機制,可以插入服務器上生成的時間戳作為數據。此功能與onDisconnect結合使用,提供了一種簡單的方法來可靠地記錄Realtime Database客戶端斷開連接的時間:

爪哇

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

Kotlin + KTX

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

時鐘偏斜

雖然firebase.database.ServerValue.TIMESTAMP更為準確,並且對於大多數讀/寫操作而言更可取,但有時相對於Firebase Realtime Database的服務器來估計客戶端的時鐘偏差可能很有用。您可以在位置/.info/serverTimeOffset上附加一個回調,以獲取以毫秒為單位的值,該值是Firebase Realtime Database客戶端添加到本地報告的時間(以毫秒為單位的紀元時間)以估計服務器時間的值。請注意,此偏移量的精度可能會受到網絡延遲的影響,因此主要用於發現時鐘時間中的較大差異(> 1秒)。

爪哇

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

Kotlin + KTX

不好

樣品存在應用程序

通過將斷開連接操作與連接狀態監視和服務器時間戳相結合,可以構建用戶狀態系統。在此系統中,每個用戶都將數據存儲在數據庫位置,以指示Realtime Database客戶端是否在線。客戶端上線時將此位置設置為true,斷開連接時將其設置為時間戳。該時間戳指示給定用戶的上次在線時間。

請注意,您的應用應在將用戶標記為在線之前對斷開連接操作進行排隊,以避免在將兩個命令發送到服務器之前客戶端的網絡連接丟失的情況下出現任何競爭情況。

這是一個簡單的用戶狀態系統:

爪哇

// 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(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(DatabaseError error) {
        Log.w(TAG, "Listener was cancelled at .info/connected");
    }
});

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