開始使用 Firebase 遠端設定


您可以使用 Firebase 遠端設定在應用程式中定義參數，並在雲端更新參數的值，這樣就能修改應用程式的外觀和行為，而不必發布應用程式更新。

遠端設定程式庫的用途包括儲存應用程式內的預設參數值、從遠端設定後端擷取更新後的參數值，以及在應用程式提供擷取的值時進行控管。詳情請參閱遠端設定載入策略。

本指南將逐步引導您踏出第一步，並提供一些程式碼範例，所有程式碼都能從 firebase/quickstart-unity GitHub 存放區中複製或下載。

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

您必須先完成下列事項，才能使用遠端設定：

  • 註冊 Unity 專案，並將其設定為使用 Firebase。

    • 如果您的 Unity 專案已使用 Firebase，表示該專案已完成註冊並設定 Firebase。

    • 如果您沒有 Unity 專案，可以下載範例應用程式。

  • 在 Unity 專案中新增 Firebase Unity SDK (尤其是 FirebaseRemoteConfig.unitypackage)。

請注意，將 Firebase 新增至 Unity 專案涉及到 Firebase 主控台和開放式 Unity 專案中的工作 (例如從主控台下載 Firebase 設定檔，再移至 Unity 專案)。

步驟 2：設定應用程式內預設參數值

您可以在遠端設定物件中設定應用程式內預設參數值，讓應用程式在連線至遠端設定後端之前能正常運作。如此一來，在後端未設定任何預設值的情況下，就能使用預設值。

方法是建立字串字典，並在鍵/值組合中填入代表要新增的預設鍵/值組合。如果您已設定遠端設定後端參數值，可以下載包含這些鍵/值組合的檔案，並用來建構字串字典。詳情請參閱下載遠端設定範本預設值。

(呼叫 SetDefaultsAsync() 時，非字串屬性會轉換為屬性的類型)。

System.Collections.Generic.Dictionary<string, object> defaults =
  new System.Collections.Generic.Dictionary<string, object>();

// These are the values that are used if we haven't fetched data from the
// server
// yet, or if we ask for values that the server doesn't have:
defaults.Add("config_test_string", "default local string");
defaults.Add("config_test_int", 1);
defaults.Add("config_test_float", 1.0);
defaults.Add("config_test_bool", false);

Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.SetDefaultsAsync(defaults)
  .ContinueWithOnMainThread(task => {

步驟 3：取得要用於應用程式的參數值

您現在可以從遠端設定物件取得參數值。如果您在遠端設定後端設定值、擷取後啟用這些值，應用程式即可使用這些值。否則，您將使用 SetDefaultsAsync() 設定應用程式內參數值。

如要取得這些值，請使用 GetValue()，以引數形式提供參數鍵。這會傳回 ConfigValue，其具有將值轉換為各種基礎類型的屬性。

步驟 4：設定參數值

  1. 在 Firebase 控制台開啟專案。
  2. 從選單中選取「遠端設定」，查看「遠端設定」資訊主頁。
  3. 定義參數時，請使用與應用程式中定義的參數相同的名稱。您可以為每個參數設定預設值 (最終覆寫應用程式內預設值) 和條件值。詳情請參閱遠端設定參數與條件。

步驟 5：擷取並啟用值 (視需要)

如要從遠端設定後端擷取參數值，請呼叫 FetchAsync() 方法。您在後端設定的任何值都會在遠端設定物件中擷取並快取。

// Start a fetch request.
// FetchAsync only fetches new data if the current data is older than the provided
// timespan.  Otherwise it assumes the data is "recent enough", and does nothing.
// By default the timespan is 12 hours, and for production apps, this is a good
// number. For this example though, it's set to a timespan of zero, so that
// changes in the console will always show up immediately.
public Task FetchDataAsync() {
  DebugLog("Fetching data...");
  System.Threading.Tasks.Task fetchTask =
  Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.FetchAsync(
      TimeSpan.Zero);
  return fetchTask.ContinueWithOnMainThread(FetchComplete);
}

在上述程式碼中，FetchComplete 是一種方法，其簽章與 ContinueWithOnMainThread() 超載其中一個超載參數相符。

在下列程式碼範例中，FetchComplete 方法會傳遞上一個工作 (fetchTask)，讓 FetchComplete 判斷是否已完成。程式碼會使用 Info.LastFetchStatus 判斷完成「也」是否成功。如果是，系統會使用 ActivateAsync() 啟用遠端設定參數值。

private void FetchComplete(Task fetchTask) {
  if (!fetchTask.IsCompleted) {
    Debug.LogError("Retrieval hasn't finished.");
    return;
  }

  var remoteConfig = FirebaseRemoteConfig.DefaultInstance;
  var info = remoteConfig.Info;
  if(info.LastFetchStatus != LastFetchStatus.Success) {
    Debug.LogError($"{nameof(FetchComplete)} was unsuccessful\n{nameof(info.LastFetchStatus)}: {info.LastFetchStatus}");
    return;
  }

  // Fetch successful. Parameter values must be activated to use.
  remoteConfig.ActivateAsync()
    .ContinueWithOnMainThread(
      task => {
        Debug.Log($"Remote data loaded and ready for use. Last fetch time {info.FetchTime}.");
    });
}

擷取完成後，使用 FetchAsync() 擷取的值會在本機進行快取，但只有在叫用 ActivateAsync() 後才能使用。如此可以確保新的值不會在進行中計算時套用，或是在可能導致問題或異常行為的其他情況下套用。

步驟 6：即時監聽更新

擷取參數值後，您可以使用即時遠端設定，從遠端設定後端監聽更新。當有可用的更新時，即時遠端設定會向已連線的裝置發出信號，並在您發布新的遠端設定版本後自動擷取變更。

適用於 Android 和 Apple 平台的 Firebase Unity SDK v11.0.0 以上版本支援即時更新。

  1. 在應用程式中新增 OnConfigUpdateListener，開始監聽更新，並自動擷取任何全新或更新的參數值。然後建立 ConfigUpdateListenerEventHandler 來處理更新事件。以下範例會監聽更新，並使用新擷取的值來顯示更新的歡迎訊息。
// Invoke the listener.
void Start()
{
  Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.OnConfigUpdateListener
    += ConfigUpdateListenerEventHandler;
}

// Handle real-time Remote Config events.
void ConfigUpdateListenerEventHandler(
   object sender, Firebase.RemoteConfig.ConfigUpdateEventArgs args) {
  if (args.Error != Firebase.RemoteConfig.RemoteConfigError.None) {
    Debug.Log(String.Format("Error occurred while listening: {0}", args.Error));
    return;
  }

  Debug.Log("Updated keys: " + string.Join(", ", args.UpdatedKeys));
  // Activate all fetched values and then display a welcome message.
  remoteConfig.ActivateAsync().ContinueWithOnMainThread(
    task => {
        DisplayWelcomeMessage();
    });
}

// Stop the listener.
void OnDestroy() {
    Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.OnConfigUpdateListener
      -= ConfigUpdateListenerEventHandler;
}

下次發布新版遠端設定時，執行應用程式並監聽變更的裝置將呼叫完成處理常式。

後續步驟

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