開始使用 Firebase 遠端設定


您可以使用 Firebase Remote Config 在應用程式中定義參數，並在雲端更新參數值，不必發布應用程式更新，就能修改應用程式的外觀和行為。本指南將逐步說明如何開始使用，並提供一些程式碼範例，您都可以從 firebase/quickstart-js GitHub 存放區複製或下載。

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

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

  2. 新增 Remote Config JavaScript 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

// The default and recommended production fetch interval for Remote Config is 12 hours
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參數和條件」。

  4. 如果使用自訂信號條件，請定義屬性和屬性值。以下範例說明如何定義自訂信號條件。

      let customSignals = {
     "city": "Tokyo",
     "preferred_event_category": "sports"
  }

  setCustomSignals(config, customSignals);

步驟 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 應用情境，請參閱一些重要概念和進階策略說明文件，包括：