開始使用 Firebase 遠端設定


您可以使用 Firebase 遠端設定在應用程式中定義參數，並在雲端更新參數的值，這樣就能在不發布應用程式更新的情況下修改應用程式的外觀與行為。本指南將引導您逐步開始使用，並提供部分程式碼範例，您可以在 firebase/quickstart-ios GitHub 存放區複製或下載這些程式碼範例。

步驟 1：在應用程式中新增遠端設定

  1. 如果您尚未將 Firebase 新增至 Apple 專案，請先完成這項作業。

  2. 就遠端設定而言，Google Analytics (分析) 必須指定對使用者屬性和目標對象應用程式執行個體的條件式指定。請務必在專案中啟用 Google Analytics (分析)。

  3. 建立單例模式遠端設定物件，如以下範例所示：

    Swift

    remoteConfig = RemoteConfig.remoteConfig()
let settings = RemoteConfigSettings()
settings.minimumFetchInterval = 0
remoteConfig.configSettings = settings
    ViewController.swift

    Objective-C

    self.remoteConfig = [FIRRemoteConfig remoteConfig];
FIRRemoteConfigSettings *remoteConfigSettings = [[FIRRemoteConfigSettings alloc] init];
remoteConfigSettings.minimumFetchInterval = 0;
self.remoteConfig.configSettings = remoteConfigSettings;
    ViewController.m

這個物件可用來儲存應用程式內預設參數值、從遠端設定後端擷取更新後的參數值，以及控管將擷取的值提供給應用程式的時機。

在開發期間，建議您設定相對較低的擷取時間間隔。詳情請參閱「節流」。

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

您可以在遠端設定物件中設定應用程式內預設參數值，讓應用程式在連線至遠端設定後端前可正常運作，如此如果後端未設定任何預設值，即可使用預設值。

  1. 使用 NSDictionary 物件或 plist 檔案定義一組參數名稱和預設參數值。

    如果您已設定遠端設定後端參數值，可以下載包含所有預設值的 plist 檔案，並將其儲存至 Xcode 專案。

    REST

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

    Firebase 控制台

    1. 在「Parameters」分頁中，開啟 「Menu」，然後選取「Download default value」。

    2. 系統提示時，啟用 .plist for iOS，然後點選「Download file」(下載檔案)。

  2. 使用 setDefaults: 將這些值新增至遠端設定物件。以下範例從 plist 檔案設定應用程式內預設值：

    Swift

    remoteConfig.setDefaults(fromPlist: "RemoteConfigDefaults")
    ViewController.swift

    Objective-C

    [self.remoteConfig setDefaultsFromPlistFileName:@"RemoteConfigDefaults"];
    ViewController.m

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

您現在可以透過遠端設定物件取得參數值。如果您之後在遠端設定後端中設定值、擷取並啟用這些值，您的應用程式就能使用這些值。否則，請使用 setDefaults: 設定應用程式內參數值。如要取得這些值，請呼叫 configValueForKey: 方法，並提供參數鍵做為引數。

步驟 4：設定參數值

使用 Firebase 主控台或遠端設定後端 API 即可建立新的後端預設值，根據您想要的條件邏輯或使用者指定目標來覆寫應用程式內的值。本節將逐步引導您完成 Firebase 控制台建立這些值的步驟。

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

步驟 5：擷取並啟用值

如要從遠端設定擷取參數值，請呼叫 fetchWithCompletionHandler: 或 fetchWithExpirationDuration:completionHandler: 方法。系統會擷取您在後端設定的任何值，並快取到遠端設定物件。

如果您想在單一呼叫中擷取及啟用值，請使用 fetchAndActivateWithCompletionHandler:。

以下範例會從遠端設定後端擷取值 (非快取值)，並呼叫 activateWithCompletionHandler: 以提供給應用程式：

Swift

remoteConfig.fetch { (status, error) -> Void in
  if status == .success {
    print("Config fetched!")
    self.remoteConfig.activate { changed, error in
      // ...
    }
  } else {
    print("Config not fetched")
    print("Error: \(error?.localizedDescription ?? "No error available.")")
  }
  self.displayWelcome()
}
ViewController.swift

Objective-C

[self.remoteConfig fetchWithCompletionHandler:^(FIRRemoteConfigFetchStatus status, NSError *error) {
    if (status == FIRRemoteConfigFetchStatusSuccess) {
        NSLog(@"Config fetched!");
      [self.remoteConfig activateWithCompletion:^(BOOL changed, NSError * _Nullable error) {
        if (error != nil) {
          NSLog(@"Activate error: %@", error.localizedDescription);
        } else {
          dispatch_async(dispatch_get_main_queue(), ^{
            [self displayWelcome];
          });
        }
      }];
    } else {
        NSLog(@"Config not fetched");
        NSLog(@"Error %@", error.localizedDescription);
    }
}];
ViewController.m

這些更新後的參數值會影響應用程式的行為與外觀，因此建議您一次啟用擷取的值，以確保使用者享有流暢的使用體驗，例如使用者下次開啟您的應用程式時。詳情請參閱遠端設定載入策略。

步驟 6：聽取即時動態

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

Apple 平台適用的 Firebase SDK 10.7.0 以上版本支援即時更新。

  1. 在應用程式中呼叫 addOnConfigUpdateListener，開始監聽更新，並自動擷取任何新的或更新的參數值。以下範例會監聽更新，並在呼叫 activateWithCompletionHandler 時，使用新擷取的值來顯示更新的歡迎訊息。

    Swift

    remoteConfig.addOnConfigUpdateListener { configUpdate, error in
  guard let configUpdate, error == nil else {
    print("Error listening for config updates: \(error)")
  }

  print("Updated keys: \(configUpdate.updatedKeys)")

  self.remoteConfig.activate { changed, error in
    guard error == nil else { return self.displayError(error) }
    DispatchQueue.main.async {
      self.displayWelcome()
    }
  }
}

    Objective-C

    __weak __typeof__(self) weakSelf = self;
[self.remoteConfig addOnConfigUpdateListener:^(FIRRemoteConfigUpdate * _Nonnull configUpdate, NSError * _Nullable error) {
  if (error != nil) {
    NSLog(@"Error listening for config updates %@", error.localizedDescription);
  } else {
    NSLog(@"Updated keys: %@", configUpdate.updatedKeys);

    __typeof__(self) strongSelf = weakSelf;
    [strongSelf.remoteConfig activateWithCompletion:^(BOOL changed, NSError * _Nullable error) {
      if (error != nil) {
        NSLog(@"Activate error %@", error.localizedDescription);
      }

      dispatch_async(dispatch_get_main_queue(), ^{
        [strongSelf displayWelcome];
      });
    }];
  }
}];

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

調節

如果應用程式在短時間內擷取太多次，擷取呼叫就會受到限制，且 SDK 會傳回 FIRRemoteConfigFetchStatusThrottled。在 SDK 6.3.0 版之前，60 分鐘內最多只能發出 5 個擷取要求 (較新的版本較寬鬆)。

在應用程式開發期間，建議您提高快取的擷取頻率 (每小時多次)，以便在應用程式開發及測試應用程式時迅速進行疊代。當伺服器上的設定更新時，即時遠端設定更新會自動略過快取。如要配合有眾多開發人員的專案快速疊代，您可以在應用程式中暫時新增 FIRRemoteConfigSettings 屬性，並設定最短擷取時間間隔 (MinimumFetchInterval)。

遠端設定的預設實際工作環境擷取時間間隔為 12 小時。也就是說，無論實際發出多少擷取呼叫，設定在 12 小時內都不會從後端多次擷取設定。具體來說，最小擷取間隔順序如下：

  1. fetch(long) 中的參數
  2. FIRRemoteConfigSettings.MinimumFetchInterval 中的參數
  3. 預設值是 12 小時

後續步驟

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