在 JavaScript 中啟用離線功能 | Firebase Realtime Database

管理在家狀態

在即時應用程式中，偵測用戶端連線和中斷連線的時間通常很有用。舉例來說，您可以在用戶端中斷連線時，將使用者標示為「離線」。

Firebase 資料庫用戶端提供簡易的基元，當用戶端與 Firebase 資料庫伺服器中斷連線時，可用於寫入資料庫。無論用戶端是否完全中斷連線，都會進行這些更新，因此即使連線中斷或用戶端當機，您仍可仰賴更新清除資料。所有寫入作業 (包括設定、更新和移除) 都可以在連線中斷後執行。

以下是使用 onDisconnect 原始版本，在中斷連線時寫入資料的簡單範例：

網頁模組 API

import { getDatabase, ref, onDisconnect } from "firebase/database";

const db = getDatabase();
const presenceRef = ref(db, "disconnectmessage");
// Write a string when this client loses connection
onDisconnect(presenceRef).set("I disconnected!");rtdb_ondisconnect_simple.js

網路命名空間 API

var presenceRef = firebase.database().ref("disconnectmessage");
// Write a string when this client loses connection
presenceRef.onDisconnect().set("I disconnected!");offline.js

如何中斷連線

建立 onDisconnect() 作業時，這項作業會在 Firebase 即時資料庫伺服器中運作。伺服器會檢查安全性，確保使用者可以執行要求的寫入事件，並在無效時通知應用程式。然後，伺服器會監控連線。無論何時，連線逾時或由即時資料庫用戶端主動關閉，伺服器會再次檢查安全性 (確認作業是否仍然有效)，然後叫用事件。

應用程式可以在寫入作業中使用回呼，確保已正確附加 onDisconnect：

網頁模組 API

onDisconnect(presenceRef).remove().catch((err) => {
  if (err) {
    console.error("could not establish onDisconnect event", err);
  }
});rtdb_ondisconnect_callback.js

網路命名空間 API

presenceRef.onDisconnect().remove((err) => {
  if (err) {
    console.error("could not establish onDisconnect event", err);
  }
});offline.js

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

網頁模組 API

const onDisconnectRef = onDisconnect(presenceRef);
onDisconnectRef.set("I disconnected");
// some time later when we change our minds
onDisconnectRef.cancel();rtdb_ondisconnect_cancel.js

網路命名空間 API

var onDisconnectRef = presenceRef.onDisconnect();
onDisconnectRef.set("I disconnected");
// some time later when we change our minds
onDisconnectRef.cancel();offline.js

偵測連線狀態

對許多狀態相關功能而言，應用程式知道裝置是處於離線或離線狀態是很有用的。Firebase 即時資料庫會在 /.info/connected 提供特殊位置，每當 Firebase 即時資料庫用戶端的連線狀態變更時，這個位置就會更新。範例如下：

網頁模組 API

import { getDatabase, ref, onValue } from "firebase/database";

const db = getDatabase();
const connectedRef = ref(db, ".info/connected");
onValue(connectedRef, (snap) => {
  if (snap.val() === true) {
    console.log("connected");
  } else {
    console.log("not connected");
  }
});rtdb_detect_connection_state.js

網路命名空間 API

var connectedRef = firebase.database().ref(".info/connected");
connectedRef.on("value", (snap) => {
  if (snap.val() === true) {
    console.log("connected");
  } else {
    console.log("not connected");
  }
});offline.js

/.info/connected 是布林值，因為值取決於用戶端的狀態，因此不會在即時資料庫用戶端之間同步處理。換句話說，如果一個用戶端將 /.info/connected 讀取為 false，並不保證其他用戶端也會讀取 false。

處理延遲時間

伺服器時間戳記

Firebase 即時資料庫伺服器提供一項機制，可將伺服器產生的時間戳記插入為資料。這項功能結合 onDisconnect，可讓您輕鬆可靠地記錄即時資料庫用戶端中斷連線的時間：

網頁模組 API

import { getDatabase, ref, onDisconnect, serverTimestamp } from "firebase/database";

const db = getDatabase();
const userLastOnlineRef = ref(db, "users/joe/lastOnline");
onDisconnect(userLastOnlineRef).set(serverTimestamp());rtdb_set_server_timestamp.js

網路命名空間 API

var userLastOnlineRef = firebase.database().ref("users/joe/lastOnline");
userLastOnlineRef.onDisconnect().set(firebase.database.ServerValue.TIMESTAMP);offline.js

時鐘偏差

雖然 firebase.database.ServerValue.TIMESTAMP 較為準確，且更適合大多數讀取/寫入作業，但預估用戶端與 Firebase 即時資料庫伺服器之間的時鐘偏差有時可能很實用。您可以將回呼附加至位置 /.info/serverTimeOffset，以取得 Firebase 即時資料庫用戶端加入當地回報時間 (以毫秒為單位) 來估計伺服器時間的值 (以毫秒為單位)。請注意，偏移的準確率會受到網路延遲時間的影響，因此最適合用於找出時鐘時間中的大 (超過 1 秒) 差異。

網頁模組 API

import { getDatabase, ref, onValue } from "firebase/database";

const db = getDatabase();
const offsetRef = ref(db, ".info/serverTimeOffset");
onValue(offsetRef, (snap) => {
  const offset = snap.val();
  const estimatedServerTimeMs = new Date().getTime() + offset;
});rtdb_estimate_clock_skew.js

網路命名空間 API

var offsetRef = firebase.database().ref(".info/serverTimeOffset");
offsetRef.on("value", (snap) => {
  var offset = snap.val();
  var estimatedServerTimeMs = new Date().getTime() + offset;
});offline.js

範例在家狀態應用程式

結合中斷連線作業、連線狀態監控和伺服器時間戳記之後，您就能建立使用者線上狀態系統。在這個系統中，每位使用者會將資料儲存於資料庫位置，藉此判斷即時資料庫用戶端是否處於連線狀態。用戶端會在連線時將這個地點設為 true，並在中斷連線時設為時間戳記。這個時間戳記表示特定使用者上次上線的時間。

請注意，在使用者將連線標示為線上之前，應用程式應將中斷連線的作業排入佇列，避免在用戶端網路連線中斷的情況下發生任何競爭狀況，才能將兩個指令傳送至伺服器。

這類簡易的使用者線上狀態系統如下：

網頁模組 API

import { getDatabase, ref, onValue, push, onDisconnect, set, serverTimestamp } from "firebase/database";

// Since I can connect from multiple devices or browser tabs, we store each connection instance separately
// any time that connectionsRef's value is null (i.e. has no children) I am offline
const db = getDatabase();
const myConnectionsRef = ref(db, 'users/joe/connections');

// stores the timestamp of my last disconnect (the last time I was seen online)
const lastOnlineRef = ref(db, 'users/joe/lastOnline');

const connectedRef = ref(db, '.info/connected');
onValue(connectedRef, (snap) => {
  if (snap.val() === true) {
    // We're connected (or reconnected)! Do anything here that should happen only if online (or on reconnect)
    const con = push(myConnectionsRef);

    // When I disconnect, remove this device
    onDisconnect(con).remove();

    // Add this device to my connections list
    // this value could contain info about the device or a timestamp too
    set(con, true);

    // When I disconnect, update the last time I was seen online
    onDisconnect(lastOnlineRef).set(serverTimestamp());
  }
});rtdb_sample_presence_app.js

網路命名空間 API

// Since I can connect from multiple devices or browser tabs, we store each connection instance separately
// any time that connectionsRef's value is null (i.e. has no children) I am offline
var myConnectionsRef = firebase.database().ref('users/joe/connections');

// stores the timestamp of my last disconnect (the last time I was seen online)
var lastOnlineRef = firebase.database().ref('users/joe/lastOnline');

var connectedRef = firebase.database().ref('.info/connected');
connectedRef.on('value', (snap) => {
  if (snap.val() === true) {
    // We're connected (or reconnected)! Do anything here that should happen only if online (or on reconnect)
    var con = myConnectionsRef.push();

    // When I disconnect, remove this device
    con.onDisconnect().remove();

    // Add this device to my connections list
    // this value could contain info about the device or a timestamp too
    con.set(true);

    // When I disconnect, update the last time I was seen online
    lastOnlineRef.onDisconnect().set(firebase.database.ServerValue.TIMESTAMP);
  }
});offline.js