開始使用 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. 下次您發布新版本的遠端設定時,執行應用程式並監聽變更的裝置都會啟用新設定。

調節

如果應用程式在短時間內擷取太多次,擷取呼叫會受到限制,而 FirebaseRemoteConfiglastFetchStatus 屬性的值將為 RemoteConfigFetchStatus.throttle

遠端設定的預設擷取時間間隔為 12 小時。這表示無論實際發出多少擷取呼叫,設定在 12 小時內都不會從後端多次擷取設定。

在應用程式開發期間,如果您並未使用即時遠端設定 (建議做法),建議您以非常頻繁的擷取和啟用設定 (每小時多次),以便在您開發及測試應用程式時迅速疊代。如要在最多 10 名開發人員的專案上配合快速疊代,可以使用 setConfigSettings() 暫時設定較低的擷取時間間隔。

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

後續步驟

如果您尚未瞭解遠端設定的用途,請先查看一些重要概念和進階策略說明文件,包括: