Вы можете использовать Firebase Remote Config для определения параметров в вашем приложении и обновления их значений в облаке, что позволяет вам изменять внешний вид и поведение вашего приложения без распространения обновления приложения. В этом руководстве рассказывается, как начать работу, и приводятся примеры кода, которые можно клонировать или загрузить из репозитория Firebase/quickstart-js на GitHub.
Шаг 1. Добавьте и инициализируйте SDK Remote Config.
Установите Firebase JS SDK и инициализируйте Firebase , если вы еще этого не сделали.
Добавьте Remote Config JS SDK и инициализируйте Remote Config:
Веб-модульный API
import { initializeApp } from "firebase/app";
import { getRemoteConfig } from "firebase/remote-config";
// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
// ...
};
// Initialize Firebase
const app = initializeApp(firebaseConfig);
// Initialize Remote Config and get a reference to the service
const remoteConfig = getRemoteConfig(app);
Веб-API в пространстве имен
import firebase from "firebase/compat/app";
import "firebase/compat/remote-config";
// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
// ...
};
// Initialize Firebase
firebase.initializeApp(firebaseConfig);
// Initialize Remote Config and get a reference to the service
const remoteConfig = firebase.remoteConfig();
Этот объект используется для хранения значений параметров по умолчанию в приложении, получения обновленных значений параметров из серверной части Remote Config и управления тем, когда полученные значения становятся доступными для вашего приложения.
Шаг 2. Установите минимальный интервал выборки
Во время разработки рекомендуется установить относительно небольшой минимальный интервал выборки. Дополнительную информацию см. в разделе Регулирование .
Web modular API
remoteConfig.settings.minimumFetchIntervalMillis = 3600000;
Web namespaced API
remoteConfig.settings.minimumFetchIntervalMillis = 3600000;
Шаг 3. Установите значения параметров по умолчанию в приложении.
Вы можете установить значения параметров по умолчанию в приложении в объекте Remote Config, чтобы ваше приложение вело себя так, как задумано, прежде чем оно подключится к серверной части Remote Config, и чтобы значения по умолчанию были доступны, если ни один из них не установлен на серверной части.
Web modular API
remoteConfig.defaultConfig = {
"welcome_message": "Welcome"
};Web namespaced API
remoteConfig.defaultConfig = {
"welcome_message": "Welcome"
};Если вы уже настроили значения параметров серверной части Remote Config, вы можете загрузить сгенерированный файл JSON, который включает все значения по умолчанию, и включить его в свой пакет приложений:
ОТДЫХ
curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=JSON -o remote_config_defaults.json
Консоль Firebase
- На вкладке «Параметры» откройте меню и выберите «Загрузить значения по умолчанию» .
- При появлении запроса включите .json для Интернета , затем нажмите «Загрузить файл» .
В следующих примерах показаны два разных способа импорта и установки значений по умолчанию в вашем приложении. В первом примере используется fetch , который отправляет HTTP-запрос к файлу настроек по умолчанию, включенному в пакет вашего приложения:
const rcDefaultsFile = await fetch('remote_config_defaults.json');
const rcDefaultsJson = await rcDefaultsFile.json();
remoteConfig.defaultConfig = rcDefaultsJson;
В следующем примере используется require , который компилирует значения в ваше приложение во время сборки:
let rcDefaults = require('./remote_config_defaults.json');
remoteConfig.defaultConfig = rcDefaults;
Шаг 4. Получите значения параметров для использования в вашем приложении.
Теперь вы можете получать значения параметров из объекта Remote Config. Если вы позже установите значения в серверной части, получите их, а затем активируете, эти значения станут доступны вашему приложению. Чтобы получить эти значения, вызовите метод getValue() , указав ключ параметра в качестве аргумента.
Web modular API
import { getValue } from "firebase/remote-config";
const val = getValue(remoteConfig, "welcome_messsage");Web namespaced API
const val = remoteConfig.getValue("welcome_messsage");Шаг 5: Установите значения параметров
Используя консоль Firebase или серверные API Remote Config , вы можете создавать новые значения по умолчанию на стороне сервера, которые переопределяют значения в приложении в соответствии с желаемой условной логикой или таргетингом на пользователя. В этом разделе вы узнаете, как создать эти значения в консоли Firebase.
- В консоли Firebase откройте свой проект.
- Выберите Remote Config в меню, чтобы просмотреть панель мониторинга Remote Config.
- Определите параметры с теми же именами, что и параметры, которые вы определили в своем приложении. Для каждого параметра вы можете установить значение по умолчанию (которое в конечном итоге переопределит значение по умолчанию в приложении), а также вы можете установить условные значения. Дополнительные сведения см. в разделе Параметры и условия удаленной настройки .
Шаг 6. Получите и активируйте значения
- Чтобы получить значения параметров из серверной части Remote Config, вызовите метод
fetchConfig(). Любые значения, которые вы устанавливаете на серверной стороне, извлекаются и кэшируются в объекте Remote Config. - Чтобы сделать полученные значения параметров доступными для вашего приложения, вызовите метод
activate().
В случаях, когда вы хотите получить и активировать значения за один вызов, используйте fetchAndActivate() , как показано в этом примере:
Web modular API
import { fetchAndActivate } from "firebase/remote-config";
fetchAndActivate(remoteConfig)
.then(() => {
// ...
})
.catch((err) => {
// ...
});Web namespaced API
remoteConfig.fetchAndActivate()
.then(() => {
// ...
})
.catch((err) => {
// ...
});Поскольку эти обновленные значения параметров влияют на поведение и внешний вид вашего приложения, вам следует активировать полученные значения в тот момент, когда это обеспечит удобство работы вашего пользователя, например, когда пользователь в следующий раз откроет ваше приложение. Дополнительные сведения и примеры см. в разделе Стратегии загрузки Remote Config .
Регулирование
Если приложение выполняет выборку слишком много раз за короткий период времени, вызовы выборки могут быть ограничены. В таких случаях SDK выдает ошибку FETCH_THROTTLE . Рекомендуется обнаружить эту ошибку и повторить попытку в режиме экспоненциальной задержки, ожидая более длительных интервалов между последующими запросами на выборку.
Во время разработки приложения вам может потребоваться очень частое обновление кэша (много раз в час), чтобы можно было быстро выполнять итерации по мере разработки и тестирования приложения. Чтобы обеспечить быструю итерацию проекта с большим количеством разработчиков, вы можете временно добавить в свое приложение свойство с низким минимальным интервалом выборки ( Settings.minimumFetchIntervalMillis ).
Рекомендуемый интервал выборки по умолчанию для Remote Config составляет 12 часов. Это означает, что конфигурации не будут извлекаться из серверной части более одного раза в течение 12-часового окна, независимо от того, сколько фактически выполнено вызовов выборки. В частности, минимальный интервал выборки определяется в следующем порядке:
- Параметр в
Settings.minimumFetchIntervalMillis. - Значение по умолчанию — 12 часов.
Следующие шаги
Если вы еще этого не сделали, изучите варианты использования Remote Config и ознакомьтесь с некоторыми ключевыми концепциями и документацией по расширенным стратегиям, в том числе: