Вы можете использовать Firebase Remote Config для определения параметров в своем приложении и обновления их значений в облаке, что позволяет изменять внешний вид и поведение вашего приложения без распространения обновления приложения.
Библиотека Remote Config используется для хранения значений параметров по умолчанию в приложении, извлечения обновленных значений параметров из бэкэнда Remote Config и управления тем, когда извлеченные значения становятся доступными для вашего приложения. Чтобы узнать больше, см. Стратегии загрузки Remote Config .
В этом руководстве вы найдете пошаговые инструкции по началу работы и примеры кода, которые можно клонировать или загрузить из репозитория firebase/quickstart-unity на GitHub.
Шаг 1: Добавьте Remote Config в свое приложение
Прежде чем использовать Remote Config , вам необходимо:
Зарегистрируйте свой проект Unity и настройте его для использования Firebase.
Если ваш проект Unity уже использует Firebase, значит, он уже зарегистрирован и настроен для Firebase.
Если у вас нет проекта Unity, вы можете загрузить пример приложения .
Добавьте Firebase Unity SDK (в частности,
FirebaseRemoteConfig.unitypackage) в свой проект Unity.
Обратите внимание, что добавление Firebase в проект Unity включает в себя выполнение задач как в консоли Firebase , так и в открытом проекте Unity (например, вы загружаете файлы конфигурации Firebase из консоли, а затем перемещаете их в проект Unity).
Шаг 2: Установите значения параметров приложения по умолчанию
Вы можете задать значения параметров приложения по умолчанию в объекте Remote Config , чтобы ваше приложение вело себя так, как задумано, до того, как оно подключится к бэкэнду Remote Config , и чтобы были доступны значения по умолчанию, если в бэкэнде ничего не задано.
Для этого создайте словарь строк и заполните его парами ключ/значение, представляющими значения по умолчанию, которые вы хотите добавить. Если вы уже настроили значения параметров бэкэнда Remote Config , вы можете загрузить файл, содержащий эти пары ключ/значение, и использовать его для создания словаря строк. Для получения дополнительной информации см. Загрузка шаблонов Remote Config по умолчанию .
(Нестроковые свойства будут преобразованы в тип свойства при вызове SetDefaultsAsync() ).
System.Collections.Generic.Dictionary<string, object> defaults = new System.Collections.Generic.Dictionary<string, object>(); // These are the values that are used if we haven't fetched data from the // server // yet, or if we ask for values that the server doesn't have: defaults.Add("config_test_string", "default local string"); defaults.Add("config_test_int", 1); defaults.Add("config_test_float", 1.0); defaults.Add("config_test_bool", false); Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.SetDefaultsAsync(defaults) .ContinueWithOnMainThread(task => {
Шаг 3: Получите значения параметров для использования в вашем приложении
Теперь вы можете получить значения параметров из объекта Remote Config . Если вы задали значения в бэкэнде Remote Config , извлекли их и затем активировали, эти значения доступны вашему приложению. В противном случае вы получите значения параметров в приложении, настроенные с помощью SetDefaultsAsync() .
Чтобы получить эти значения, используйте GetValue() , указав параметр key в качестве аргумента. Это возвращает ConfigValue , который имеет свойства для преобразования значения в различные базовые типы.
Шаг 4: Установите значения параметров
- В консоли Firebase откройте свой проект.
- Выберите Remote Config в меню, чтобы просмотреть панель управления Remote Config .
- Определите параметры с теми же именами, что и параметры, которые вы определили в своем приложении. Для каждого параметра можно задать значение по умолчанию (которое в конечном итоге переопределит значение по умолчанию в приложении) и условные значения. Чтобы узнать больше, см. Параметры и условия Remote Config .
Шаг 5: Извлечение и активация значений (при необходимости)
Чтобы получить значения параметров из бэкэнда Remote Config , вызовите метод FetchAsync() . Любые значения, которые вы устанавливаете на бэкэнде, извлекаются и кэшируются в объекте Remote Config .
// Start a fetch request. // FetchAsync only fetches new data if the current data is older than the provided // timespan. Otherwise it assumes the data is "recent enough", and does nothing. // By default the timespan is 12 hours, and for production apps, this is a good // number. For this example though, it's set to a timespan of zero, so that // changes in the console will always show up immediately. public Task FetchDataAsync() { DebugLog("Fetching data..."); System.Threading.Tasks.Task fetchTask = Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.FetchAsync( TimeSpan.Zero); return fetchTask.ContinueWithOnMainThread(FetchComplete); }
В приведенном выше коде FetchComplete — это метод, сигнатура которого соответствует параметрам одной из перегрузок ContinueWithOnMainThread() .
В примере кода ниже методу FetchComplete передается предыдущая задача ( fetchTask ), что позволяет FetchComplete определить, была ли она завершена. Код использует Info.LastFetchStatus , чтобы затем определить, была ли завершена также успешно. Если это так, то значения параметров Remote Config затем активируются с помощью ActivateAsync() .
private void FetchComplete(Task fetchTask) {
if (!fetchTask.IsCompleted) {
Debug.LogError("Retrieval hasn't finished.");
return;
}
var remoteConfig = FirebaseRemoteConfig.DefaultInstance;
var info = remoteConfig.Info;
if(info.LastFetchStatus != LastFetchStatus.Success) {
Debug.LogError($"{nameof(FetchComplete)} was unsuccessful\n{nameof(info.LastFetchStatus)}: {info.LastFetchStatus}");
return;
}
// Fetch successful. Parameter values must be activated to use.
remoteConfig.ActivateAsync()
.ContinueWithOnMainThread(
task => {
Debug.Log($"Remote data loaded and ready for use. Last fetch time {info.FetchTime}.");
});
}
Значения, полученные с помощью FetchAsync() кэшируются локально после завершения выборки, но не становятся доступными до тех пор, пока не будет вызван ActivateAsync() . Это позволяет гарантировать, что новые значения не будут применены в середине расчета или в другие моменты, которые могут вызвать проблемы или странное поведение.
Шаг 6: Следите за обновлениями в режиме реального времени
После получения значений параметров вы можете использовать Remote Config в реальном времени для прослушивания обновлений из бэкэнда Remote Config . Remote Config в реальном времени посылает подключенным устройствам сигналы о наличии обновлений и автоматически извлекает изменения после публикации новой версии Remote Config .
Обновления в реальном времени поддерживаются Firebase Unity SDK v11.0.0+ и выше для платформ Android и Apple.
- Добавьте в свое приложение
OnConfigUpdateListener, чтобы начать прослушивание обновлений и автоматически извлекать любые новые или обновленные значения параметров. Затем создайтеConfigUpdateListenerEventHandlerдля обработки событий обновления. Следующий пример прослушивает обновления и использует новые извлеченные значения для отображения обновленного приветственного сообщения.
// Invoke the listener. void Start() { Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.OnConfigUpdateListener += ConfigUpdateListenerEventHandler; } // Handle real-time Remote Config events. void ConfigUpdateListenerEventHandler( object sender, Firebase.RemoteConfig.ConfigUpdateEventArgs args) { if (args.Error != Firebase.RemoteConfig.RemoteConfigError.None) { Debug.Log(String.Format("Error occurred while listening: {0}", args.Error)); return; } Debug.Log("Updated keys: " + string.Join(", ", args.UpdatedKeys)); // Activate all fetched values and then display a welcome message. remoteConfig.ActivateAsync().ContinueWithOnMainThread( task => { DisplayWelcomeMessage(); }); } // Stop the listener. void OnDestroy() { Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.OnConfigUpdateListener -= ConfigUpdateListenerEventHandler; }
В следующий раз, когда вы опубликуете новую версию Remote Config , устройства, на которых запущено ваше приложение и которые ожидают изменений, вызовут обработчик завершения.
Следующие шаги
Если вы еще этого не сделали, изучите варианты использования Remote Config и посмотрите на некоторые из ключевых концепций и документации «Расширенные стратегии», в том числе: