Firebase 遠端配置入門


您可以使用 Firebase Remote Config 在應用程式中定義參數並在雲端中更新其值,從而無需分發應用程式更新即可修改應用程式的外觀和行為。本指南將引導您完成入門步驟並提供一些範例程式碼。

步驟 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. 從選單中選擇遠端配置以查看遠端配置儀表板。
  3. 定義與您在應用程式中定義的參數同名的參數。對於每個參數,您可以設定一個預設值(最終將覆蓋對應的應用程式內預設值),也可以設定條件值。要了解更多信息,請參閱遠端配置參數和條件

第 6 步:獲取並啟動值

  1. 若要從遠端配置後端取得參數值,請呼叫fetch()方法。您在後端設定的任何值都會被取得並儲存在遠端設定物件中。

  2. 若要讓取得的參數值可供您的應用程式使用,請呼叫activate()方法。

    如果您想要在一次呼叫中取得並啟動值,您可以使用fetchAndActivate()請求從遠端配置後端取得值並使它們可供應用程式使用:

    await remoteConfig.fetchAndActivate();
    

由於這些更新的參數值會影響應用程式的行為和外觀,因此您應該在確保使用者獲得流暢體驗的時間(例如使用者下次開啟應用程式時)啟動所獲取的值。如需更多資訊和範例,請參閱遠端設定載入策略

步驟7:即時監聽更新

取得參數值後,您可以使用即時遠端配置來偵聽來自遠端配置後端的更新。當有更新可用時,即時遠端設定會向連接的裝置發出訊號,並在您發布新的遠端設定版本後自動取得變更。

請注意,即時遠端配置不適用於 Web。

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

下一步

如果您還沒有,請探索遠端配置用例,並查看一些關鍵概念和高級策略文檔,包括: