Firebase 遠端配置入門


您可以使用 Firebase Remote Config 在應用程式中定義參數並在雲端中更新其值,從而無需分發應用程式更新即可修改應用程式的外觀和行為。本指南將引導您完成入門步驟並提供一些範例程式碼,所有這些程式碼都可以從firebase/quickstart-ios GitHub 儲存庫複製或下載。

第 1 步:將遠端配置新增至您的應用程式

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

  2. 對於遠端配置,需要 Google Analytics 才能將應用程式實例有條件地定位到使用者屬性和受眾。確保在您的專案中啟用 Google Analytics

  3. 建立單例遠端配置對象,如下例所示:

    迅速

    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 專案。

    休息

    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 檔案設定應用程式內預設值:

    迅速

    remoteConfig.setDefaults(fromPlist: "RemoteConfigDefaults")

    Objective-C

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

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

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

步驟 4:設定參數值

使用 Firebase 控制台或遠端設定後端 API ,您可以建立新的後端預設值,根據您所需的條件邏輯或使用者定位覆寫應用程式內值。本部分將引導您完成 Firebase 控制台步驟來建立這些值。

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

第 5 步:獲取並啟動值

若要從遠端配置取得參數值,請呼叫fetchWithCompletionHandler:fetchWithExpirationDuration:completionHandler:方法。您在後端設定的任何值都會被取得並快取在遠端配置物件中。

如果您想要在一次呼叫中取得並啟動值,請使用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()
}

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 平台 v10.7.0+ 及更高版本的 Firebase SDK 支援即時更新。

  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 小時視窗內不會多次從後端取得配置,無論實際進行了多少次獲取呼叫。具體來說,最小獲取間隔是按以下順序決定:

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

下一步

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