在 Android 上啟用離線功能

持久性行為

通過啟用持久性，Firebase 實時數據庫客戶端在聯機時同步的任何數據都會保留在磁盤上並且可以離線使用，即使在用戶或操作系統重新啟動應用程序時也是如此。這意味著您的應用程序通過使用存儲在緩存中的本地數據像在線一樣工作。偵聽器回調將繼續觸發本地更新。

Firebase 實時數據庫客戶端會自動保留一個隊列，其中包含您的應用離線時執行的所有寫入操作。啟用持久性後，此隊列也會持久保存到磁盤，因此當用戶或操作系統重新啟動應用程序時，您的所有寫入都可用。當應用程序重新連接時，所有操作都會發送到 Firebase 實時數據庫服務器。

如果您的應用使用Firebase Authentication ，則 Firebase 實時數據庫客戶端會在應用重新啟動時保留用戶的身份驗證令牌。如果授權令牌在您的應用離線時過期，客戶端會暫停寫入操作，直到您的應用重新對用戶進行身份驗證，否則寫入操作可能會因安全規則而失敗。

保持數據新鮮

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

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

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

Firebase 實時數據庫客戶端會自動下載這些位置的數據並保持同步，即使引用沒有活動的偵聽器也是如此。您可以使用以下代碼行關閉同步。

scoresRef.keepSynced(false)
OfflineActivity.kt

scoresRef.keepSynced(false);
OfflineActivity.java

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

離線查詢數據

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

例如，此代碼查詢 Firebase 實時分數數據庫中的最後四項

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

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

假設用戶斷開連接、掉線並重新啟動應用程序。雖然仍處於離線狀態，但該應用程序會從同一位置查詢最後兩項。此查詢將成功返回最後兩個項目，因為應用程序已加載上述查詢中的所有四個項目。

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

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

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

如果應用程序在離線時請求最後六個項目，它會立即獲得四個緩存項目的“添加孩子”事件。當設備重新聯機時，Firebase 實時數據庫客戶端與服務器同步並獲取應用程序的最後兩個“已添加子項”和“值”事件。

離線處理交易

在應用程序離線時執行的任何事務都會排隊。一旦應用程序重新獲得網絡連接，交易就會發送到實時數據庫服務器。

onDisconnect 如何工作

當您建立onDisconnect()操作時，該操作存在於 Firebase 實時數據庫服務器上。服務器檢查安全性以確保用戶可以執行請求的寫入事件，並在無效時通知您的應用程序。服務器然後監視連接。如果連接在任何時候超時，或者被實時數據庫客戶端主動關閉，服務器會再次檢查安全性（以確保操作仍然有效），然後調用事件。

您的應用程序可以使用寫入操作的回調來確保onDisconnect已正確附加：

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

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

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

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

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

服務器時間戳

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

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

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

時鐘偏差

雖然firebase.database.ServerValue.TIMESTAMP更準確，並且對於大多數讀/寫操作更可取，但有時它可以用於估計客戶端相對於 Firebase 實時數據庫服務器的時鐘偏差。您可以將回調附加到位置/.info/serverTimeOffset以獲取以毫秒為單位的值，Firebase 實時數據庫客戶端添加到本地報告的時間（以毫秒為單位的紀元時間）以估計服務器時間。請注意，此偏移量的準確性可能會受到網絡延遲的影響，因此主要用於發現時鐘時間中的大（> 1 秒）差異。

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

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