開始使用 Firebase 遠端設定


您可以使用 Firebase Remote Config 在應用程式中定義參數，並在雲端更新參數值，藉此修改應用程式的外觀和行為，而無須發布應用程式更新。本指南將逐步引導您開始使用，並提供一些程式碼範例，您可以從 firebase/quickstart-js GitHub 存放區複製或下載這些程式碼範例。

步驟 1：新增及初始化 Remote Config SDK

  1. 如果您尚未安裝，請 安裝 Firebase JS SDK 並初始化 Firebase。

  2. 新增 Remote Config JS SDK 並初始化 Remote Config：

Web 

import { initializeApp } from "firebase/app";
import { getRemoteConfig } from "firebase/remote-config";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
const app = initializeApp(firebaseConfig);


// Initialize Remote Config and get a reference to the service
const remoteConfig = getRemoteConfig(app);

Web 

import firebase from "firebase/compat/app";
import "firebase/compat/remote-config";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
firebase.initializeApp(firebaseConfig);


// Initialize Remote Config and get a reference to the service
const remoteConfig = firebase.remoteConfig();

這個物件可用於儲存應用程式內的預設參數值、從 Remote Config 後端擷取更新的參數值，以及控制擷取的值何時可供應用程式使用。

步驟 2：設定最小擷取間隔

在開發期間，建議您將最小擷取間隔設為較低的值。詳情請參閱「節流」。

Web

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;
rc_set_minimum_fetch_time.js

Web

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;
index.js

步驟 3：設定應用程式內的預設參數值

您可以在 Remote Config 物件中設定應用程式內的預設參數值，讓應用程式在連線至 Remote Config 後端之前正常運作，並在後端未設定任何預設值時使用預設值。

Web

remoteConfig.defaultConfig = {
  "welcome_message": "Welcome"
};
rc_set_default_values.js

Web

remoteConfig.defaultConfig = {
  "welcome_message": "Welcome"
};
index.js

如果您已設定 Remote Config 後端參數值，可以下載產生的 JSON 檔案，其中包含所有預設值，並將該檔案納入應用程式套件：

REST

curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=JSON -o remote_config_defaults.json

Firebase 控制台

  1. 在「參數」分頁中，開啟 「選單」，然後選取「下載預設值」。
  2. 系統提示時，請啟用「.json (適用於網頁)」，然後點選「下載檔案」。

以下範例說明在應用程式中匯入及設定預設值的兩種不同方式。第一個範例使用 fetch，會對應用程式套件中包含的預設檔案提出 HTTP 要求：


  const rcDefaultsFile = await fetch('remote_config_defaults.json');
  const rcDefaultsJson = await rcDefaultsFile.json();
  remoteConfig.defaultConfig = rcDefaultsJson;

下一個範例使用 require，這個方法會在建構期間將值編譯至應用程式：

  let rcDefaults = require('./remote_config_defaults.json');
  remoteConfig.defaultConfig = rcDefaults;

步驟 4：取得要在應用程式中使用的參數值

您現在可以從 Remote Config 物件取得參數值。如果您之後在後端設定值、擷取值，然後再啟用這些值，這些值就會提供給應用程式。如要取得這些值，請呼叫 getValue() 方法，並提供參數鍵做為引數。

Web

import { getValue } from "firebase/remote-config";

const val = getValue(remoteConfig, "welcome_messsage");
rc_get_values.js

Web

const val = remoteConfig.getValue("welcome_messsage");
index.js

步驟 5：設定參數值

您可以使用 Firebase 控制台或 Remote Config 後端 API，根據所需的條件邏輯或使用者指定目標，建立新的伺服器端預設值，以便覆寫應用程式內的值。本節將逐步說明如何透過 Firebase 資訊主頁建立這些值。

  1. 在 Firebase 主控台中開啟專案。
  2. 從選單中選取 Remote Config，即可查看 Remote Config 資訊主頁。
  3. 定義參數時，請使用與應用程式中定義的參數相同的名稱。您可以為每個參數設定預設值 (最終會覆寫應用程式內的預設值)，也可以設定條件值。詳情請參閱「Remote Config 參數和條件」。

步驟 6：擷取並啟用值

  1. 如要從 Remote Config 後端擷取參數值，請呼叫 fetchConfig() 方法。系統會擷取您在後端設定的所有值，並將這些值快取到 Remote Config 物件中。
  2. 如要讓應用程式使用擷取的參數值，請呼叫 activate() 方法。

如果您想在單一呼叫中擷取及啟用值，請使用 fetchAndActivate()，如以下範例所示：

Web

import { fetchAndActivate } from "firebase/remote-config";

fetchAndActivate(remoteConfig)
  .then(() => {
    // ...
  })
  .catch((err) => {
    // ...
  });
rc_fetch_config_callback.js

Web

remoteConfig.fetchAndActivate()
  .then(() => {
    // ...
  })
  .catch((err) => {
    // ...
  });
index.js

由於這些更新的參數值會影響應用程式的行為和外觀，因此您應在確保使用者享有順暢體驗的時間點啟用擷取的值，例如使用者下次開啟應用程式時。如需更多資訊和範例，請參閱「遠端設定載入策略」。

調節

如果應用程式在短時間內擷取過多資料，擷取呼叫可能會受到節流限制。在這種情況下，SDK 會擲回 FETCH_THROTTLE 錯誤。建議您擷取這項錯誤，並在指數輪詢模式中重試，在後續擷取要求之間等待更長的間隔時間。

在應用程式開發期間，您可能會經常 (每小時多次) 重新整理快取，以便在開發及測試應用程式時快速疊代。為了在有許多開發人員的專案中快速疊代，您可以在應用程式中暫時新增具有低最低擷取間隔 (Settings.minimumFetchIntervalMillis) 的屬性。

Remote Config 的預設及建議的正式版擷取間隔為 12 小時，也就是說，無論實際發出多少擷取呼叫，在 12 小時的時間範圍內，系統不會從後端擷取多次設定。具體而言，系統會依以下順序決定最小擷取間隔：

  1. Settings.minimumFetchIntervalMillis 中的參數。
  2. 預設值為 12 小時。

後續步驟

如果您尚未探索，請參閱 Remote Config 用途，並查看一些重要概念和進階策略說明文件，包括：