開始使用 Firebase 遠端設定


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

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

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

  2. 針對遠端設定，Google Analytics (分析) 必須指定應用程式執行個體的條件式指定至使用者屬性與目標對象。確認您已在專案中啟用 Google Analytics (分析)。

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

    flutter pub add firebase_remote_config

    此外，在設定遠端設定的過程中，您需要將 Google Analytics (分析) 專用 Firebase SDK 新增至您的應用程式：

    flutter pub add firebase_analytics

  4. 重新建構您的專案：

    flutter run

  5. 如果您在 macOS 上使用遠端設定，請在 Xcode 中啟用鑰匙圈共用。

步驟 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),
));

後續步驟

如果您尚未瞭解遠端設定用途，請先瞭解遠端設定的用途，並參考一些重要概念和進階策略說明文件，包括：