開始使用 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

    Objective-C

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

這個物件是用來儲存應用程式內的預設參數值,並擷取更新後的值 ,並且控制擷取的時間 適用於您的應用程式

在開發期間,建議您設定相對較低的擷取次數下限 間隔。請參閱節流 瞭解詳情

步驟 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. 參數中 開啟 「選單」, 選取「下載預設值」

    2. 出現提示時,啟用 iOS 專用 .plist,然後按一下「下載檔案」

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

    Swift

    remoteConfig.setDefaults(fromPlist: "RemoteConfigDefaults")

    Objective-C

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

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

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:即時監聽更新

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

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

  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 小時

後續步驟

如果您尚未探索遠端設定,請先探索 用途,以及 重要概念和進階策略說明文件,包括: