在 Android 裝置上啟用離線功能

持續性行為

啟用持續性後，即使使用者或作業系統重新啟動應用程式，Firebase 即時資料庫用戶端中的所有資料都會同步處理至磁碟，且可供離線使用。也就是說，應用程式會照常使用儲存在快取中的本機資料在線上運作。取得本機更新時，系統會持續觸發事件監聽器回呼。

Firebase 即時資料庫用戶端會自動將應用程式離線時執行的所有寫入作業排入佇列。持續性啟用後，這個佇列也會保存在磁碟中，以便在使用者或作業系統重新啟動應用程式時，取得所有寫入內容。應用程式重新連線後，所有作業都會傳送至 Firebase 即時資料庫伺服器。

如果應用程式使用 Firebase 驗證，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

根據預設，系統會快取先前同步處理資料的 10 MB。對大多數應用程式來說應該已足夠使用。如果快取超過設定的大小，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 即時資料庫用戶端會與伺服器同步處理，取得最後兩個新增的「子項」和應用程式的「value」事件。

離線處理交易

凡是在應用程式離線時執行的交易，都會排入佇列。應用程式重新連上網路後，系統會將交易傳送至即時資料庫伺服器。

如何中斷連線

建立 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

您也可以呼叫 .cancel() 來取消 onDisconnect 事件：

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