您可以使用 Firebase 遠端設定在應用程式中定義參數,並在雲端更新參數的值,這樣就能修改應用程式的外觀和行為,而不必發布應用程式更新。本指南將逐步引導您踏出第一步,並提供一些程式碼範例,所有程式碼都能複製或從 firebase/quickstart-ios GitHub 存放區下載。
步驟 1:在應用程式中加入遠端設定
如果您尚未將 Firebase 新增至 Apple 專案,請先完成這項操作。
針對遠端設定,Google Analytics (分析) 必須指定應用程式執行個體的條件式指定至使用者屬性與目標對象。確認您已在專案中啟用 Google Analytics (分析)。
建立單例模式遠端設定物件,如以下範例所示:
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:設定應用程式內預設參數值
您可以在遠端設定物件中設定應用程式內預設參數值,讓應用程式在連線至遠端設定後端之前能正常運作。如此一來,在後端未設定任何預設值的情況下,就能使用預設值。
使用
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 控制台
在「Parameters」分頁中開啟 「Menu」,然後選取「Download default value」。
出現提示時,啟用 iOS 專用 .plist,然後按一下「下載檔案」。
使用
setDefaults:
將這些值新增至遠端設定物件。以下範例從 plist 檔案設定應用程式內預設值:Swift
remoteConfig.setDefaults(fromPlist: "RemoteConfigDefaults")
Objective-C
[self.remoteConfig setDefaultsFromPlistFileName:@"RemoteConfigDefaults"];
步驟 3:取得要用於應用程式的參數值
您現在可以從遠端設定物件取得參數值。如果您之後在遠端設定後端設定、擷取及啟用這些值,應用程式就能使用這些值。否則,請使用 setDefaults:
設定應用程式內參數值。如要取得這些值,請呼叫 configValueForKey:
方法,提供參數鍵做為引數。
步驟 4:設定參數值
您可以使用 Firebase 主控台或遠端設定後端 API 建立新的後端預設值,根據所需的條件邏輯或使用者指定目標覆寫應用程式內值。本節將逐步引導您使用 Firebase 控制台建立這些值。
- 在 Firebase 控制台開啟專案。
- 選取選單中的「Remote Config」(遠端設定),查看「遠端設定」資訊主頁。
- 定義參數時,請使用與應用程式中定義的參數相同的名稱。您可以為每個參數設定預設值 (該參數最終會覆寫應用程式內預設值),也可以設定條件式值。詳情請參閱遠端設定參數與條件。
步驟 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 支援即時更新。
在應用程式中呼叫
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]; }); }]; } }];
下次發布新版遠端設定時,執行應用程式並監聽變更的裝置將呼叫完成處理常式。
調節
如果應用程式在短時間內擷取太多次,系統會限制擷取呼叫,而 SDK 會傳回 FIRRemoteConfigFetchStatusThrottled
。在 SDK 6.3.0 版之前,限制是在 60 分鐘內最多擷取 5 個要求 (較新的版本則有較多的限制)。
在應用程式開發期間,您可能需要更頻繁地擷取快取 (每小時多次),以便在開發及測試應用程式時迅速疊代。當伺服器上的設定更新時,即時遠端設定更新會自動略過快取。如要因應擁有多個開發人員的專案快速疊代作業,您可以在應用程式中暫時新增 FIRRemoteConfigSettings
屬性的擷取間隔下限 (MinimumFetchInterval
) 較低。
遠端設定的預設和建議的實際工作環境擷取間隔是 12 小時,這表示無論實際發出多少擷取呼叫,在 12 小時內,都不會從後端多次擷取設定。具體來說,擷取時間間隔的最小值順序如下:
fetch(long)
中的參數FIRRemoteConfigSettings.MinimumFetchInterval
中的參數- 預設值是 12 小時
後續步驟
如果您尚未瞭解遠端設定用途,請先瞭解遠端設定的用途,並參考一些重要概念和進階策略說明文件,包括: