開始在 Android 上使用遠端設定

選取平台: iOS+ Android Web Flutter Unity C++


您可以使用 Firebase Remote Config 在應用程式中定義參數,並在雲端更新參數值,這樣一來,您就能修改應用程式的外觀和行為,而不必發布應用程式更新。本指南將逐步說明入門步驟,並提供一些程式碼範例,您可以從 firebase/quickstart-android GitHub 存放區複製或下載這些範例。

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

  1. 如果您尚未將 Firebase 新增至 Android 專案,請先新增。

  2. 如要使用Remote Config,必須啟用Google Analytics,才能條件式指定應用程式執行個體的使用者屬性和目標對象。請務必在專案中啟用 Google Analytics。

  3. 在模組 (應用程式層級) Gradle 檔案 (通常是 <project>/<app-module>/build.gradle.kts 或 <project>/<app-module>/build.gradle) 中,新增 Android 適用的 Remote Config 和 Analytics 程式庫依附元件。建議使用 Firebase Android BoM 控制程式庫版本管理。

    此外,在設定 Analytics 的過程中,您需要將 Google Analytics 專用 Firebase SDK 新增至應用程式。

    dependencies {
        // Import the BoM for the Firebase platform
        implementation(platform("com.google.firebase:firebase-bom:35.2.0"))
    
        // Add 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")
    }

    只要使用 Firebase Android BoM,應用程式就會一律使用相容的 Firebase Android 程式庫版本。

    (替代方案)  不使用 BoM,新增 Firebase 程式庫依附元件

    如果選擇不使用 Firebase BoM,則必須在依附元件行中指定每個 Firebase 程式庫版本。

    請注意,如果您的應用程式使用多個 Firebase 程式庫,強烈建議您使用 BoM 管理程式庫版本,確保所有版本都相容。

    dependencies {
        // Add 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:24.0.1")
    implementation("com.google.firebase:firebase-analytics:24.0.0")
    }

步驟 2:取得 Remote Config 單例模式物件

取得 Remote Config 物件例項,並設定最短擷取間隔,以便經常重新整理:

Kotlin

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

Java

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

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

在開發期間,建議將最低擷取間隔設為較低的值。詳情請參閱「節流」。

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

您可以在 Remote Config 物件中設定應用程式內預設參數值,讓應用程式在連線至 Remote Config 後端之前,能按照預期運作,並在後端未設定任何值時,提供預設值。

  1. 使用 Map 物件或儲存在應用程式 res/xml 資料夾中的 XML 資源檔案,定義一組參數名稱和預設參數值。Remote Config 快速入門導覽課程範例應用程式會使用 XML 檔案定義預設參數名稱和值。

    如果您已設定 Remote Config 後端參數值,可以下載產生的 XML 檔案 (包含所有預設值),並儲存至應用程式的 res/xml 目錄:

    REST

    curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=XML -o remote_config_defaults.xml
    

    您可以使用 Google Cloud CLI 或 Cloud Shell 執行下列指令,產生不記名權杖:

    gcloud auth print-access-token
    

    這個權杖的效期很短,因此如果收到驗證錯誤,可能需要重新產生權杖。

    Firebase 控制台

    1. 在 Firebase 控制台中,依序前往 「DevOps & Engagement」>「遠端設定」> 「Parameters」(參數) 頁面。

    2. 開啟「 選單」,然後選取「下載預設值」。

    3. 出現提示時,啟用「.xml for Android」,然後點選「Download file」。

  2. 使用 setDefaultsAsync(int) 將這些值新增至 Remote Config 物件,如下所示:

    Kotlin

    remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)

    Java

    mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);

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

現在,您可以從 Remote Config 物件取得參數值。如果您在後端設定值、擷取並啟用這些值,應用程式就能使用這些值。否則,您會取得使用 setDefaultsAsync(int) 設定的應用程式內參數值。如要取得這些值,請呼叫下列程式碼中列出的方法,該方法會對應至應用程式預期的資料類型,並提供參數索引鍵做為引數:

步驟 5:在 Remote Config 後端設定參數值

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

  1. 在 Firebase 控制台中,依序前往 「DevOps & Engagement」>「遠端設定」> 「Parameters」(參數) 頁面。

  2. 定義參數時,請使用與應用程式中定義的參數相同的名稱。您可以為每個參數設定預設值 (最終會覆寫對應的應用程式內預設值),也可以設定條件值。詳情請參閱「Remote Config 參數和條件」。

  3. 如果使用自訂信號條件,請定義屬性和屬性值。以下範例說明如何定義自訂信號條件。

    Kotlin

            val customSignals = customSignals {
                put("city", "Tokyo")
                put("preferred_event_category", "sports")
            }
    
            remoteConfig.setCustomSignals(customSignals)
        

    Java

            CustomSignals customSignals = new CustomSignals.Builder()
                .put("city", "Tokyo")
                .put("preferred_event_category", "sports")
                .build();
    
            mFirebaseRemoteConfig.setCustomSignals(customSignals);
    
        

步驟 6:擷取並啟用值

  1. 如要從 Remote Config 後端擷取參數值,請呼叫 fetch() 方法。系統會擷取您在後端設定的所有值,並儲存在 Remote Config 物件中。
  2. 如要讓應用程式使用擷取的參數值,請呼叫 activate() 方法。

    如果想在一次呼叫中擷取並啟用值,可以使用 fetchAndActivate() 要求,從 Remote Config 後端擷取值,並提供給應用程式:

    Kotlin

    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()
        }

    Java

    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();
                }
            });

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

步驟 7:即時聆聽更新

擷取參數值後,您可以使用即時 Remote Config 監聽 Remote Config 後端的更新。當有更新可用時,系統會即時向連結裝置發出 Remote Config 信號,並在您發布新的 Remote Config 版本後自動擷取變更。

Android Firebase SDK 21.3.0 以上版本 (Firebase BoM 31.2.4 以上版本) 支援即時更新。

  1. 在應用程式中,使用 addOnConfigUpdateListener() 開始監聽更新,並自動擷取任何新的參數值。實作 onUpdate() 回呼,啟用更新後的設定。

    Kotlin

    remoteConfig.addOnConfigUpdateListener(object : ConfigUpdateListener {
            override fun onUpdate(configUpdate : ConfigUpdate) {
            Log.d(TAG, "Updated keys: " + configUpdate.updatedKeys);
    
            if (configUpdate.updatedKeys.contains("welcome_message")) {
                remoteConfig.activate().addOnCompleteListener {
                    displayWelcomeMessage()
                }
            }
            }
    
            override fun onError(error : FirebaseRemoteConfigException) {
                Log.w(TAG, "Config update error with code: " + error.code, error)
            }
        })
        

    Java

        mFirebaseRemoteConfig.addOnConfigUpdateListener(new ConfigUpdateListener() {
            @Override
            public void onUpdate(ConfigUpdate configUpdate) {
                Log.d(TAG, "Updated keys: " + configUpdate.getUpdatedKeys());
                mFirebaseRemoteConfig.activate().addOnCompleteListener(new OnCompleteListener<Boolean>() {
                    @Override
                    public void onComplete(@NonNull Task<Boolean> task) {
                        displayWelcomeMessage();
                    }
                });
            }
            @Override
            public void onError(FirebaseRemoteConfigException error) {
                Log.w(TAG, "Config update error with code: " + error.getCode(), error);
            }
        });
        
  2. 下次發布新版 Remote Config 時,執行應用程式並監聽變更的裝置會呼叫 ConfigUpdateListener。

調節

如果應用程式在短時間內擷取太多次,擷取呼叫會受到限制,且 SDK 會傳回 FirebaseRemoteConfigFetchThrottledException。在 SDK 17.0.0 版之前,限制為 60 分鐘內最多 5 次擷取要求 (新版限制較寬鬆)。

開發應用程式時,您可能需要頻繁擷取及啟用設定 (每小時多次),以便在開發及測試應用程式時快速疊代。當伺服器上的設定更新時,即時 Remote Config 更新會自動略過快取。如要配合最多 10 位開發人員的專案快速疊代,您可以在應用程式中暫時設定 FirebaseRemoteConfigSettings 物件,並設定較短的最短擷取間隔 (setMinimumFetchIntervalInSeconds)。

Remote Config 的預設擷取間隔下限為 12 小時,也就是說,無論實際發出多少次擷取呼叫,系統在 12 小時內都不會從後端擷取設定超過一次。具體來說,系統會按照下列順序決定擷取間隔下限:

  1. fetch(long) 中的參數
  2. FirebaseRemoteConfigSettings.setMinimumFetchIntervalInSeconds(long) 中的參數
  3. 預設值為 12 小時

如要將擷取間隔下限設為自訂值,請使用 FirebaseRemoteConfigSettings.Builder.setMinimumFetchIntervalInSeconds(long)。