開始使用 Firebase 遠端設定


您可以使用 Firebase 遠端設定定義應用程式中的參數，並在雲端更新參數的值，以便在不發布應用程式更新的情況下修改應用程式的外觀和行為。本指南將逐步引導您踏出第一步，並提供一些程式碼範例。

步驟 1：在應用程式中新增 Firebase 和遠端設定 SDK

  1. 如果您尚未安裝並初始化 Flutter 專用的 Firebase SDK，請先完成這項操作。

  2. 就遠端設定而言，必須使用 Google Analytics，才能條件式指定應用程式執行個體的使用者屬性和目標對象。請確認您已在專案中啟用 Google Analytics。

  3. 在 Flutter 專案的根目錄中執行下列指令，安裝 Remote Config 外掛程式：

    flutter pub add firebase_remote_config

    此外，在設定遠端設定時，您必須將 Google Analytics 專用 Firebase SDK 加進應用程式：

    flutter pub add firebase_analytics

  4. 重建專案：

    flutter run

  5. 如果您在 macOS 上使用遠端設定，請在 Xcode 中啟用「Keychain Sharing」。

步驟 2：取得遠端設定單例模式物件

取得遠端設定物件執行個體，並設定最短擷取間距，才能經常更新：

final remoteConfig = FirebaseRemoteConfig.instance;
await remoteConfig.setConfigSettings(RemoteConfigSettings(
    fetchTimeout: const Duration(minutes: 1),
    minimumFetchInterval: const Duration(hours: 1),
));

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

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

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

您可以在遠端設定物件中設定應用程式內預設參數值，讓應用程式在連線至遠端設定後端之前能正常運作。如此一來，在後端未設定任何預設值的情況下，就能使用預設值。

await remoteConfig.setDefaults(const {
    "example_param_1": 42,
    "example_param_2": 3.14159,
    "example_param_3": true,
    "example_param_4": "Hello, world!",
});

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

您現在可以從遠端設定物件取得參數值。如果您在後端設定值、擷取值，然後再啟用這些值，這些值就會提供給應用程式。否則，您會取得使用 setDefaults() 設定的應用程式內參數值。

如要取得這些值，請呼叫下列對應至應用程式預期資料類型的對應方法，並提供參數鍵做為引數：

  • getBool()
  • getDouble()
  • getInt()
  • getString()

步驟 5：在遠端設定後端設定參數值

您可以使用 Firebase 控制台或 遠端設定後端 API，根據所需的條件邏輯或使用者指定目標，建立新的伺服器端預設值，覆寫應用程式內的值。本節將說明 Firebase 控制台建立這些值的步驟。

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

步驟 6：擷取並啟用值

  1. 如要從遠端設定後端擷取參數值，請呼叫 fetch() 方法。您在後端設定的任何值都會擷取並儲存在遠端設定物件中。

  2. 如要讓應用程式取得參數值，請呼叫 activate() 方法。

    如果您想在單一呼叫中擷取及啟用值，可以使用 fetchAndActivate() 要求從遠端設定後端擷取值，並將這些值提供給應用程式：

    await remoteConfig.fetchAndActivate();

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

步驟 7：即時監聽更新

擷取參數值後，您可以使用即時遠端設定，從遠端設定後端監聽更新。當有可用的更新時，即時遠端設定就會向已連線的裝置發出信號，並在您發布新的遠端設定版本後自動擷取變更。

請注意，即時遠端設定不適用於網頁。

  1. 在應用程式中，使用 onConfigUpdated 開始聆聽更新，並自動擷取任何新的參數值。

     remoteConfig.onConfigUpdated.listen((event) async {
   await remoteConfig.activate();

   // Use the new config values here.
 });

  2. 下次您發布新版遠端設定時，執行應用程式並監聽變更的裝置將啟用新設定。

調節

如果應用程式在短時間內擷取過多資料，擷取呼叫就會受到節流限制，而 FirebaseRemoteConfig 的 lastFetchStatus 屬性值會變成 RemoteConfigFetchStatus.throttle。

遠端設定的預設擷取間隔為 12 小時，也就是說，無論實際發出多少擷取呼叫，在 12 小時的時間範圍內，系統都不會從後端擷取兩次以上的設定。

在應用程式開發期間，如果您沒有使用即時的遠端設定 (這是我們建議的做法)，可能需要經常擷取及啟用設定 (每小時多次)，以便在開發及測試應用程式時快速進行疊代。為了在最多 10 位開發人員的專案中進行快速疊代，您可以暫時使用 setConfigSettings() 設定較低的擷取間隔。

final remoteConfig = FirebaseRemoteConfig.instance;
await remoteConfig.setConfigSettings(RemoteConfigSettings(
    fetchTimeout: const Duration(minutes: 1),
    minimumFetchInterval: const Duration(minutes: 5),
));

後續步驟

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