Firebase 遠端配置入門


您可以使用Firebase Remote配置來定義應用程式中的參數並在雲端中更新其值，讓您可以在不分發應用程式更新的情況下修改應用程式的外觀和行為。本指南將引導您完成入門的步驟並提供一些範例程式碼，所有這些程式碼均可複製或從firebase/quickstart-ios github儲存庫中下載。

步驟1：將遠端設定新增至您的應用

  1. 為Apple平台安裝Firebase SDK 。

  2. 建立Singleton遠端配置對象，如以下範例所示：

    迅速

    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檔案來定義一組參數名稱，並使用預設參數值。

    如果您已經配置了遠端配置後端參數值，則可以下載包含所有預設值並將其儲存到XCode專案的生成的plist檔案。

    休息

    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

    火箱控制台

    1. 在「參數」標籤中，開啟選單，然後選擇下載預設值。

    2. 提示時，啟用。iOS的.plist ，然後按下載檔。

  2. 使用setDefaults: 。以下範例從plist檔案設定應用程式內預設值：

    迅速

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

    Objective-C

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

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

現在，您可以從遠端配置物件取得參數值。如果以後在遠端配置後端設定值，請取得它們，然後啟動它們，則這些值可用於您的應用程式。否則，您將獲得使用setDefaults: 。若要取得這些值，請呼叫configValueForKey:方法，將參數密鑰作為參數提供。

步驟4：設定參數值

使用Firebase控制台或遠端設定後端API ，您可以建立新的後端預設值，該值根據所需的條件邏輯或使用者定位覆寫應用程式內值。本節將引導您瀏覽Firebase Console步驟以建立這些值。

  1. 在Firebase控制台中，開啟您的專案。
  2. 從選單中選擇“遠端配置”以查看遠端配置儀表板。
  3. 定義與您在應用程式中定義的參數相同名稱的參數。對於每個參數，您可以設定一個預設值（最終將覆蓋應用程式內預設值），也可以設定有條件的值。要了解更多信息，請參閱遠端配置參數和條件。

步驟5：獲取和激活值

若要從遠端配置取得參數值，請呼叫fetchWithCompletionHandler:或fetchWithExpirationDuration:completionHandler: method。您在後端設定的任何值都在遠端配置物件中取得和快取。

對於要在一個呼叫中取得和啟動值的情況，請使用fetchAndActivateWithCompletionHandler:

此範例從遠端配置後端（而不是快取值）取得值，並呼叫activateWithCompletionHandler:使其可用於應用程式：

迅速

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：即時收聽更新

取得參數值後，您可以使用即時遠端配置來偵聽遠端配置後端的更新。當您發布新的遠端設定版本後，即時遠端遠端設定訊號在可用時，可隨時使用更新並自動取得變更。

Firebase SDK為Apple平台v10.7.0+及更高版本提供了即時更新。

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

    迅速

    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個提取請求（較新的版本具有更多的允許限制）。

在應用程式開發過程中，您可能需要更頻繁地獲取以非常頻繁地刷新快取（每小時很多次），以使您在開發和測試應用程式時迅速迭代。當在伺服器上更新配置時，即時遠端配置會自動繞過快取。為了適應與眾多開發人員的專案的快速迭代，您可以在應用程式中暫時新增具有最小最小擷取間隔（ MinimumFetchInterval ）的FIRRemoteConfigSettings屬性。

遠端配置的預設和建議的生產提取間隔為12小時，這意味著在12小時的視窗中不會多次從後端取得配置，而不管實際進行了多少個fetch呼叫。具體而言，按以下順序確定最小提取間隔：

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

下一步

如果您還沒有，請探索遠端配置用例，並查看一些關鍵概念和高級策略文檔，包括：