您可以使用 Firebase Remote Config 在應用程式中定義參數,並在雲端更新參數值,藉此修改應用程式的外觀和行為,而不必發布應用程式更新。本指南將逐步引導您開始使用,並提供一些程式碼範例,您可以從 firebase/quickstart-ios GitHub 存放區複製或下載這些程式碼範例。
步驟 1:將 Remote Config 新增至應用程式
如果您尚未將 Firebase 新增至 Apple 專案,請新增 Firebase。
對於 Remote Config,則必須使用 Google Analytics 的 應用程式執行個體的條件式指定功能 使用者屬性和目標對象請確認 你 在專案中啟用 Google Analytics。
建立單例模式 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 後端,這樣一來,在沒有預設值的情況下,就無法使用預設值 您在後端中設定的連線
使用
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 主控台
在參數中 開啟 「選單」, 選取「下載預設值」。
出現提示時,啟用 iOS 專用 .plist,然後按一下「下載檔案」。
使用
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 控制台的步驟,以便建立這些值。
- 在 Firebase 主控台中開啟專案。
- 從選單中選取 Remote Config,即可查看 Remote Config 資訊主頁。
- 定義參數時,請使用與應用程式中定義的參數相同的名稱。您可以為每個參數設定預設值 (最終會覆寫應用程式內的預設值),也可以設定條件值。詳情請參閱「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 平台 10.7.0 以上版本的 Firebase SDK 支援即時更新。
在應用程式中呼叫
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]; }); }]; } }];
下次發布新版 Remote Config 時,裝置 呼叫完成後,系統就會呼叫完成 處理常式。
調節
如果應用程式在短時間內擷取過多次,擷取呼叫會受到節流限制,SDK 會傳回 FIRRemoteConfigFetchStatusThrottled
。在 SDK 6.3.0 之前,60 分鐘內的擷取要求上限為 5 次 (較新版本的上限較寬鬆)。
在應用程式開發期間,您可能需要提高擷取頻率,以重新整理快取
非常頻繁 (每小時多次) 方便您快速疊代
以及測試應用程式即時遠端設定更新會自動略過
更新快取。為了在有許多開發人員的專案中進行快速迭代,您可以在應用程式中暫時新增 FIRRemoteConfigSettings
屬性,並設定低的最低擷取間隔 (MinimumFetchInterval
)。
Remote Config 的預設和建議的正式版擷取間隔 12 小時 這代表在 12 小時內,系統不會多次從後端擷取設定 則無論實際發出多少擷取呼叫。具體來說,最小擷取間隔會依照以下順序決定:
fetch(long)
中的參數FIRRemoteConfigSettings.MinimumFetchInterval
中的參數- 預設值為 12 小時
後續步驟
如果尚未體驗,請前往Remote Config 用途,以及 重要概念和進階策略說明文件,包括: