開始使用 Firebase 遠端設定


您可以使用 Firebase 遠端設定來定義應用程式中的參數， 更新雲端值，讓您可以修改外觀和 未發布應用程式更新。本指南將引導您 協助您開始使用並提供一些程式碼範例 就能複製或下載 firebase/quickstart-js GitHub 存放區

步驟 1：新增並初始化遠端設定 SDK

  1. 如果您還沒有這樣做， 安裝 Firebase JS SDK 並初始化 Firebase。

  2. 新增遠端設定 JS SDK 並初始化遠端設定：

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();

這個物件是用來儲存應用程式內的預設參數值，並擷取更新後的值 ，並且控制擷取的時間 適用於您的應用程式

步驟 2：設定擷取間隔下限

在開發期間，建議您設定相對較低的擷取次數下限 間隔。請參閱節流，瞭解 瞭解詳情

Web

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;
rc_set_minimum_fetch_time.js

Web

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;
index.js

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

您可以在遠端設定中設定應用程式內預設參數值 物件，因此應用程式在連線至 以便使用預設值 沒有設定在後端

Web

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

Web

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

如果已設定遠端設定後端參數值 您可以下載產生的 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. 在「Parameters」分頁中 開啟選單，然後選取 下載預設值。
  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：取得要用於應用程式的參數值

您現在可以從遠端設定物件取得參數值。如果您之後再 在後端設定值、擷取值然後啟用 可用的可用選項。如要取得這些值，請呼叫 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 控制台或 遠端設定後端 API 您可以建立新的伺服器端預設值，用來覆寫應用程式內的值 將採用您所需的條件式邏輯或使用者指定目標為依據這個區段 將逐步引導您使用 Firebase 控制台建立這些值。

  1. 在 Firebase 控制台開啟專案。
  2. 從選單中選取「Remote Config」，即可查看遠端設定 儀表板中指定這項設定。
  3. 使用與剛才定義的參數相同的名稱定義參數 您可以為每個參數設定預設值 (也就是 最終覆寫應用程式內預設值)，您也可以 條件式值。詳情請參閱： 遠端設定參數與條件。

步驟 6：擷取並啟用值

  1. 如要從遠端設定後端擷取參數值，請呼叫 fetchConfig() 方法。系統將擷取您在後端設定的任何值 快取錯誤。
  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)。

遠端設定的預設正式環境擷取時間間隔 12 小時 這代表在 12 小時內，系統不會多次從後端擷取設定 則無論實際發出多少擷取呼叫。具體而言， 擷取間隔時間下限則依下列順序決定：

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

後續步驟

如果您尚未探索遠端設定，請先探索 用途，以及 重要概念和進階策略說明文件，包括：