開始使用 Firebase 遠端設定


您可以使用 Firebase Remote Config 在應用程式中定義參數,並在雲端更新參數值,藉此修改應用程式的外觀和行為,而無須發布應用程式更新。本指南將逐步引導您開始使用,並提供一些程式碼範例,您可以從 firebase/quickstart-ios GitHub 存放區複製或下載這些程式碼範例。

步驟 1:將 Remote Config 新增至應用程式

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

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

  3. 建立單例 Remote Config 物件,如以下範例所示:

    Swift

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

    Objective-C

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

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

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

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

您可以在 Remote Config 物件中設定應用程式內的預設參數值,讓應用程式在連線至 Remote Config 後端前正常運作,並在後端未設定任何預設值時使用預設值。

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

    如果您已設定 Remote Config 後端參數值,可以下載產生的 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. 在「參數」分頁中,開啟 「選單」,然後選取「下載預設值」

    2. 系統提示時,請啟用 iOS 專用的 .plist,然後按一下「下載檔案」

  2. 使用 setDefaults: 將這些值新增至 Remote Config 物件。以下範例會設定 plist 檔案中的應用程式內預設值:

    Swift

    remoteConfig.setDefaults(fromPlist: "RemoteConfigDefaults")

    Objective-C

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

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

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

步驟 4:設定參數值

您可以使用 Firebase 控制台或 Remote Config 後端 API,根據所需的條件邏輯或使用者指定目標,建立新的後端預設值,覆寫應用程式內的值。本節將逐步說明如何透過 Firebase 資訊主頁建立這些值。

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

步驟 5:擷取並啟用值

如要從 Remote Config 擷取參數值,請呼叫 fetchWithCompletionHandler:fetchWithExpirationDuration:completionHandler: 方法。系統會擷取您在後端設定的所有值,並將這些值快取至 Remote Config 物件中。

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

此範例會從 Remote Config 後端擷取值 (非快取值),並呼叫 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()
}

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

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

步驟 6:即時監聽更新

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

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. 下次發布新版 Remote Config 時,執行應用程式並監聽變更的裝置會呼叫完成處理常式。

調節

如果應用程式在短時間內擷取過多資料,擷取呼叫會受到節流限制,SDK 會傳回 FIRRemoteConfigFetchStatusThrottled。在 SDK 6.3.0 之前,60 分鐘內的擷取要求上限為 5 次 (較新版本的上限較寬鬆)。

在應用程式開發期間,您可能會想更頻繁地擷取資料,以便快速重新整理快取 (每小時多次),讓您在開發及測試應用程式時快速迭代。當設定在伺服器上更新時,即時遠端設定更新會自動略過快取。為了在有許多開發人員的專案中進行快速迭代,您可以在應用程式中暫時新增 FIRRemoteConfigSettings 屬性,並設定低的最低擷取間隔 (MinimumFetchInterval)。

Remote Config 的預設和建議的實際工作環境擷取間隔是 12 小時,這表示無論實際發出多少擷取呼叫,在 12 小時內,都不會從後端擷取超過一次設定。具體來說,最小擷取間隔會依照以下順序決定:

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

後續步驟

如果您尚未探索,請參閱 Remote Config 用途,並查看一些重要概念和進階策略說明文件,包括: