Catch up on everthing we announced at this year's Firebase Summit. Learn more

開始使用 Firebase 遠程配置

您可以使用 Firebase 遠程配置在您的應用中定義參數並在雲中更新它們的值,從而允許您在不分發應用更新的情況下修改應用的外觀和行為。本指南將引導您上手的步驟,並提供了一些示例代碼,所有這些都可以從克隆或下載火力/快速啟動功能的Android GitHub的倉庫。

將 Firebase 和遠程配置 SDK 添加到您的應用

  1. 如果你還沒有,添加火力地堡到您的Android項目

  2. 對於遠程配置,谷歌分析是必需的應用實例有條件目標用戶的屬性,受眾群體和火力地堡預測。請確保您啟用谷歌分析在您的項目。

  3. 使用火力地堡Android的物料清單,聲明你的模塊(應用程序級)搖籃文件(通常在遠程配置的Android庫的依賴app/build.gradle )。

    此外,作為設置 Analytics 的一部分,您需要將適用於 Google Analytics 的 Firebase SDK 添加到您的應用中。

    爪哇

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:29.0.1')
    
        // Declare the dependencies for the Remote Config and Analytics libraries
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-config'
        implementation 'com.google.firebase:firebase-analytics'
    }
    

    通過使用火力地堡Android的物料清單,您的應用程序將始終使用火力地堡的Android庫的兼容版本。

    (替代)聲明火力地堡庫依賴使用物料清單

    如果您選擇不使用 Firebase BoM,則必須在其依賴項行中指定每個 Firebase 庫版本。

    需要注意的是,如果你在你的應用程序使用多個火力地堡庫,我們強烈建議您使用的物料清單管理庫版本,以保證所有版本相互兼容。

    dependencies {
        // Declare the dependencies for the Remote Config and Analytics libraries
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-config:21.0.1'
        implementation 'com.google.firebase:firebase-analytics:20.0.0'
    }
    

    科特林+KTX

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:29.0.1')
    
        // Declare the dependencies for the Remote Config and Analytics libraries
        // When using the BoM, you don't specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-config-ktx'
        implementation 'com.google.firebase:firebase-analytics-ktx'
    }
    

    通過使用火力地堡Android的物料清單,您的應用程序將始終使用火力地堡的Android庫的兼容版本。

    (替代)聲明火力地堡庫依賴使用物料清單

    如果您選擇不使用 Firebase BoM,則必須在其依賴項行中指定每個 Firebase 庫版本。

    需要注意的是,如果你在你的應用程序使用多個火力地堡庫,我們強烈建議您使用的物料清單管理庫版本,以保證所有版本相互兼容。

    dependencies {
        // Declare the dependencies for the Remote Config and Analytics libraries
        // When NOT using the BoM, you must specify versions in Firebase library dependencies
        implementation 'com.google.firebase:firebase-config-ktx:21.0.1'
        implementation 'com.google.firebase:firebase-analytics-ktx:20.0.0'
    }
    

獲取遠程配置單例對象

獲取遠程配置對象實例並設置最小獲取間隔以允許頻繁刷新:

爪哇

mFirebaseRemoteConfig = FirebaseRemoteConfig.getInstance();
FirebaseRemoteConfigSettings configSettings = new FirebaseRemoteConfigSettings.Builder()
        .setMinimumFetchIntervalInSeconds(3600)
        .build();
mFirebaseRemoteConfig.setConfigSettingsAsync(configSettings);

科特林+KTX

remoteConfig = Firebase.remoteConfig
val configSettings = remoteConfigSettings {
    minimumFetchIntervalInSeconds = 3600
}
remoteConfig.setConfigSettingsAsync(configSettings)

單例對像用於存儲應用程序內的默認參數值、從後端獲取更新的參數值以及控制獲取的值何時可用於您的應用程序。

在開發過程中,建議設置一個相對較低的最小獲取間隔。見節流以獲取更多信息。

設置應用內默認參數值

您可以在遠程配置對像中設置應用內默認參數值,以便您的應用在連接到遠程配置後端之前按預期運行,並且如果後端未設置任何默認值,則默認值可用。

  1. 定義一組參數名稱和使用默認的參數值的地圖對象或一個XML資源文件存儲在您的應用程序的res/xml文件夾中。遠程配置快速入門示例應用程序使用一個XML文件來定義默認的參數名稱和值。
  2. 添加使用這些值到遠程配置對象setDefaultsAsync(int)如下所示:

爪哇

mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);

科特林+KTX

remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)

獲取要在您的應用程序中使用的參數值

現在您可以從遠程配置對象獲取參數值。如果您在後端設置值,獲取它們,然後激活它們,則這些值可用於您的應用程序。否則,你得到使用配置在應用程序的參數值setDefaultsAsync(int)要獲取這些值,請調用下面列出的方法,該方法映射到您的應用程序所需的數據類型,提供參數鍵作為參數:

在遠程配置後端設置參數值

使用火力地堡控制台或遠程配置後端的API ,你可以根據你的需要的條件邏輯或用戶針對覆蓋在應用程序的價值創造新的服務器端的默認值。本部分介紹了創建這些值的 Firebase 控制台步驟。

  1. 火力地堡控制台,打開您的項目。
  2. 從菜單中選擇遠程配置,查看遠程配置儀表板。
  3. 定義與您在應用程序中定義的參數同名的參數。對於每個參數,您可以設置一個默認值(最終會覆蓋相應的應用內默認值),也可以設置條件值。要了解更多信息,請參閱遠程配置參數和條件

獲取並激活值

  1. 為了從遠程配置後端取的參數值,調用fetch()方法。您在後端設置的任何值都會被提取並存儲在遠程配置對像中。
  2. 為了獲取參數值提供給您的應用程序,調用activate()方法。

    對於您想獲取和一個呼叫激活值的情況下,你可以使用一個fetchAndActivate()請求,以便從遠程配置後端讀取值,並將其提供給應用程序:

    爪哇

    mFirebaseRemoteConfig.fetchAndActivate()
            .addOnCompleteListener(this, new OnCompleteListener<Boolean>() {
                @Override
                public void onComplete(@NonNull Task<Boolean> task) {
                    if (task.isSuccessful()) {
                        boolean updated = task.getResult();
                        Log.d(TAG, "Config params updated: " + updated);
                        Toast.makeText(MainActivity.this, "Fetch and activate succeeded",
                                Toast.LENGTH_SHORT).show();
    
                    } else {
                        Toast.makeText(MainActivity.this, "Fetch failed",
                                Toast.LENGTH_SHORT).show();
                    }
                    displayWelcomeMessage();
                }
            });

    科特林+KTX

    remoteConfig.fetchAndActivate()
            .addOnCompleteListener(this) { task ->
                if (task.isSuccessful) {
                    val updated = task.result
                    Log.d(TAG, "Config params updated: $updated")
                    Toast.makeText(this, "Fetch and activate succeeded",
                            Toast.LENGTH_SHORT).show()
                } else {
                    Toast.makeText(this, "Fetch failed",
                            Toast.LENGTH_SHORT).show()
                }
                displayWelcomeMessage()
            }

由於這些更新後的參數值會影響應用程序的行為和外觀,因此您應該在確保為用戶提供流暢體驗的時間激活獲取的值,例如用戶下次打開您的應用程序時。見遠程配置加載策略的更多信息和示例。

節流

如果一個應用程序在很短的時間內取得過很多次,取呼叫節流和SDK返回FirebaseRemoteConfigFetchThrottledException 。在 SDK 版本 17.0.0 之前,限制是 60 分鐘窗口內 5 個獲取請求(新版本有更多的寬鬆限制)。

在應用程序開發期間,您可能希望非常頻繁地(每小時多次)獲取和激活配置,以便在開發和測試應用程序時快速迭代。為了容納多達10個開發項目快速迭代,你可以臨時設置一個FirebaseRemoteConfigSettings具有低最小物體抓取時間間隔( setMinimumFetchIntervalInSeconds在您的應用程序)。

遠程配置的默認最小提取間隔為 12 小時,這意味著在 12 小時窗口內不會從後端多次提取配置,無論實際進行了多少次提取調用。具體來說,最小獲取間隔按以下順序確定:

  1. 在參數fetch(long)
  2. 在參數FirebaseRemoteConfigSettings.setMinimumFetchIntervalInSeconds(long)
  3. 默認值 12 小時

設置最小時間間隔取為自定義值,使用FirebaseRemoteConfigSettings.Builder.setMinimumFetchIntervalInSeconds(long)

下一步

如果你還沒有準備好,探索遠程配置使用情況,並看看一些關鍵概念和先進的戰略文件,其中包括: