Начало работы с Firebase Remote Config


Вы можете использовать Firebase Remote Config для определения параметров в вашем приложении и обновления их значений в облаке, что позволяет вам изменять внешний вид и поведение вашего приложения без распространения обновления приложения. В этом руководстве описаны шаги, необходимые для начала работы, и представлен пример кода.

Шаг 1. Добавьте Firebase и SDK Remote Config в свое приложение.

  1. Установите и инициализируйте Firebase SDK для Flutter, если вы еще этого не сделали.

  2. Для удаленной настройки требуется Google Analytics для условного таргетинга экземпляров приложения на свойства и аудитории пользователей. Убедитесь, что вы включили Google Analytics в своем проекте.

  3. В корневом каталоге вашего проекта Flutter выполните следующую команду, чтобы установить плагин Remote Config:

    flutter pub add firebase_remote_config

    Кроме того, в рамках настройки Remote Config вам необходимо добавить в свое приложение Firebase SDK для Google Analytics:

    flutter pub add firebase_analytics

  4. Перестройте свой проект:

    flutter run

  5. Если вы используете Remote Config в macOS, включите общий доступ к цепочке ключей в Xcode.

Шаг 2. Получите одноэлементный объект Remote Config.

Получите экземпляр объекта Remote Config и установите минимальный интервал выборки, чтобы обеспечить частые обновления:

final remoteConfig = FirebaseRemoteConfig.instance;
await remoteConfig.setConfigSettings(RemoteConfigSettings(
    fetchTimeout: const Duration(minutes: 1),
    minimumFetchInterval: const Duration(hours: 1),
));

Объект-одиночка используется для хранения значений параметров по умолчанию в приложении, получения обновленных значений параметров из серверной части и управления тем, когда полученные значения становятся доступными для вашего приложения.

Во время разработки рекомендуется установить относительно небольшой минимальный интервал выборки. Дополнительную информацию см. в разделе Регулирование .

Шаг 3. Установите значения параметров по умолчанию в приложении.

Вы можете установить значения параметров по умолчанию в приложении в объекте Remote Config, чтобы ваше приложение вело себя должным образом до подключения к серверной части Remote Config, а также чтобы значения по умолчанию были доступны, если ни один из них не установлен в серверной части.

await remoteConfig.setDefaults(const {
    "example_param_1": 42,
    "example_param_2": 3.14159,
    "example_param_3": true,
    "example_param_4": "Hello, world!",
});

Шаг 4. Получите значения параметров для использования в вашем приложении.

Теперь вы можете получать значения параметров из объекта Remote Config. Если вы задаете значения в серверной части, получаете их, а затем активируете, эти значения будут доступны вашему приложению. В противном случае вы получите значения параметров приложения, настроенные с помощью setDefaults() .

Чтобы получить эти значения, вызовите метод, указанный ниже, который соответствует типу данных, ожидаемому вашим приложением, передав ключ параметра в качестве аргумента:

  • getBool()
  • getDouble()
  • getInt()
  • getString()

Шаг 5. Установите значения параметров в серверной части Remote Config.

Используя консоль Firebase или серверные API Remote Config , вы можете создавать новые значения по умолчанию на стороне сервера, которые переопределяют значения в приложении в соответствии с желаемой условной логикой или таргетингом на пользователя. В этом разделе описаны шаги консоли Firebase для создания этих значений.

  1. В консоли Firebase откройте свой проект.
  2. Выберите Remote Config в меню, чтобы просмотреть панель мониторинга Remote Config.
  3. Определите параметры с теми же именами, что и параметры, которые вы определили в своем приложении. Для каждого параметра вы можете установить значение по умолчанию (которое в конечном итоге переопределит соответствующее значение по умолчанию в приложении), а также вы можете установить условные значения. Дополнительные сведения см. в разделе Параметры и условия удаленной настройки .

Шаг 6. Получите и активируйте значения

  1. Чтобы получить значения параметров из серверной части Remote Config, вызовите метод fetch() . Любые значения, которые вы устанавливаете в серверной части, извлекаются и сохраняются в объекте Remote Config.

  2. Чтобы сделать полученные значения параметров доступными для вашего приложения, вызовите метод activate() .

    В случаях, когда вы хотите получить и активировать значения за один вызов, вы можете использовать запрос fetchAndActivate() , чтобы получить значения из серверной части Remote Config и сделать их доступными для приложения:

    await remoteConfig.fetchAndActivate();

Поскольку эти обновленные значения параметров влияют на поведение и внешний вид вашего приложения, вам следует активировать полученные значения в тот момент, когда это обеспечит удобство работы вашего пользователя, например, когда пользователь в следующий раз откроет ваше приложение. Дополнительные сведения и примеры см. в разделе Стратегии загрузки Remote Config .

Шаг 7. Слушайте обновления в режиме реального времени.

После получения значений параметров вы можете использовать Remote Config в реальном времени для прослушивания обновлений из серверной части Remote Config. Remote Config в реальном времени сигнализирует подключенным устройствам о доступности обновлений и автоматически извлекает изменения после публикации новой версии Remote Config.

Обратите внимание, что Remote Config в реальном времени недоступен для Интернета.

  1. В своем приложении используйте onConfigUpdated чтобы начать прослушивать обновления и автоматически получать любые новые значения параметров.

     remoteConfig.onConfigUpdated.listen((event) async {
   await remoteConfig.activate();

   // Use the new config values here.
 });

  2. В следующий раз, когда вы опубликуете новую версию своей удаленной конфигурации, устройства, на которых работает ваше приложение и прослушивают изменения, активируют новую конфигурацию.

Регулирование

Если приложение выполняет выборку слишком много раз за короткий период времени, вызовы выборки будут регулироваться, а значение свойства lastFetchStatus FirebaseRemoteConfig будет RemoteConfigFetchStatus.throttle .

Минимальный интервал выборки по умолчанию для Remote Config составляет 12 часов. Это означает, что конфигурации не будут извлекаться из серверной части более одного раза в течение 12-часового окна, независимо от того, сколько фактически выполнено вызовов выборки.

Если во время разработки приложения вы не используете удаленную настройку в реальном времени (что мы рекомендуем), вам может потребоваться очень часто (много раз в час) получать и активировать конфигурации, чтобы можно было быстро выполнять итерацию по мере разработки и тестирования приложения. Чтобы обеспечить быструю итерацию проекта с участием до 10 разработчиков, вы можете временно установить низкий минимальный интервал выборки с помощью setConfigSettings() .

final remoteConfig = FirebaseRemoteConfig.instance;
await remoteConfig.setConfigSettings(RemoteConfigSettings(
    fetchTimeout: const Duration(minutes: 1),
    minimumFetchInterval: const Duration(minutes: 5),
));

Следующие шаги

Если вы еще этого не сделали, изучите варианты использования Remote Config и посмотрите на некоторые из ключевых концепций и документации «Расширенные стратегии», в том числе:

,


Вы можете использовать удаленную конфигурацию Firebase для определения параметров в вашем приложении и обновить их значения в облаке, что позволяет вам изменять внешний вид и поведение вашего приложения без распространения обновления приложения. Это руководство проходит через шаги, чтобы начать работу и предоставляет некоторый пример кода.

Шаг 1: Добавьте Firebase и удаленную конфигурацию SDK в ваше приложение

  1. Установите и инициализируйте SDK Firebase для Flutter, если вы еще этого не сделали.

  2. Для удаленной конфигурации Google Analytics требуется для условного нацеливания экземпляров приложений на свойства пользователя и аудиторию. Убедитесь, что вы включите Google Analytics в свой проект.

  3. Из корневого каталога вашего проекта Flutter запустите следующую команду для установки плагина удаленного конфигурации:

    flutter pub add firebase_remote_config

    Кроме того, как часть настройки удаленной конфигурации, вам необходимо добавить SDK Firebase для Google Analytics в ваше приложение:

    flutter pub add firebase_analytics

  4. Восстановите свой проект:

    flutter run

  5. Если вы используете удаленную конфигурацию на MacOS, включите обмен ключевой матчей в XCode.

Шаг 2: Получите удаленный объект Singleton Config.

Получите удаленный экземпляр объекта конфигурации и установите минимальный интервал выборки, чтобы обеспечить частые обновления:

final remoteConfig = FirebaseRemoteConfig.instance;
await remoteConfig.setConfigSettings(RemoteConfigSettings(
    fetchTimeout: const Duration(minutes: 1),
    minimumFetchInterval: const Duration(hours: 1),
));

Объект Singleton используется для хранения значений параметров по умолчанию в приложении, получения обновленных значений параметров из бэкэнда и управления, когда извлеченные значения доступны для вашего приложения.

Во время разработки рекомендуется установить относительно низкий минимальный интервал выборки. Смотрите дросселирование для получения дополнительной информации.

Шаг 3: Установите значения параметров по умолчанию в приложении

Вы можете установить значения параметров по умолчанию в приложении в объекте удаленного конфигурации, чтобы ваше приложение ведет себя так, как задумано, прежде чем подключиться к удаленному бэкэнд на конфигурации, и поэтому значения по умолчанию доступны, если их не установлены в бэкэнд.

await remoteConfig.setDefaults(const {
    "example_param_1": 42,
    "example_param_2": 3.14159,
    "example_param_3": true,
    "example_param_4": "Hello, world!",
});

Шаг 4: Получите значения параметров для использования в вашем приложении

Теперь вы можете получить значения параметров из объекта удаленного конфигурации. Если вы устанавливаете значения в бэкэнд, принесите их, а затем активируйте их, эти значения доступны для вашего приложения. В противном случае вы получаете значения параметров в приложении, настроенные с использованием setDefaults() .

Чтобы получить эти значения, вызовите метод, перечисленный ниже, который отображает тип данных, ожидаемый вашим приложением, предоставляя ключ параметра в качестве аргумента:

  • getBool()
  • getDouble()
  • getInt()
  • getString()

Шаг 5: Установите значения параметров в бэкэнде удаленного конфигурации

Используя консоль Firebase или API-интерфейсы удаленной конфигурации , вы можете создать новые значения по умолчанию на стороне сервера, которые переопределяют значения в приложении в соответствии с желаемой условной логикой или таргетингом пользователя. В этом разделе описываются шаги консоли Firebase для создания этих значений.

  1. В консоли Firebase откройте свой проект.
  2. Выберите удаленную конфигурацию в меню, чтобы просмотреть удаленную панель конфигурации.
  3. Определите параметры с теми же именами, что и параметры, которые вы определили в вашем приложении. Для каждого параметра вы можете установить значение по умолчанию (которое в конечном итоге будет переопределить соответствующее значение по умолчанию в приложении), и вы также можете установить условные значения. Чтобы узнать больше, см. Удаленные параметры и условия конфигурации .

Шаг 6: Принесите и активируйте значения

  1. Чтобы получить значения параметров из удаленной конфигурации, вызовите метод fetch() . Любые значения, которые вы устанавливаете в бэкэнде, извлекаются и хранятся в объекте удаленного конфигурации.

  2. Чтобы сделать полученные значения параметров, доступных для вашего приложения, вызовите метод activate() .

    Для тех случаев, когда вы хотите получить и активировать значения в одном вызове, вы можете использовать запрос fetchAndActivate() для извлечения значений из удаленной конфигурации и сделать их доступными для приложения:

    await remoteConfig.fetchAndActivate();

Поскольку эти обновленные значения параметров влияют на поведение и внешний вид вашего приложения, вы должны активировать извлекаемые значения за раз, которые обеспечивают плавный опыт для вашего пользователя, например, в следующий раз, когда пользователь открывает ваше приложение. См. Удаленную стратегии загрузки конфигурации для получения дополнительной информации и примеров.

Шаг 7: Слушайте обновления в режиме реального времени

После того, как вы получите значения параметров, вы можете использовать удаленную конфигурацию в реальном времени для прослушивания обновлений из удаленного бэкэнда конфигурации. Удаленные сигналы конфигурации в реальном времени на подключенные устройства, когда доступны обновления, и автоматически получает изменения после публикации новой версии удаленной конфигурации.

Обратите внимание, что удаленная конфигурация в реальном времени недоступна для Интернета.

  1. В вашем приложении используйте onConfigUpdated чтобы начать прослушивание обновлений и автоматически приносить любые новые значения параметров.

     remoteConfig.onConfigUpdated.listen((event) async {
   await remoteConfig.activate();

   // Use the new config values here.
 });

  2. В следующий раз, когда вы публикуете новую версию вашей удаленной конфигурации, устройств, которые запускают ваше приложение и прислушиваются к изменениям, активируют новую конфигурацию.

Дросселя

Если приложение RemoteConfigFetchStatus.throttle слишком много раз за короткий период времени, вызовы Feetch будут углублены, lastFetchStatus значение FirebaseRemoteConfig

Минимальный интервал по умолчанию для удаленной конфигурации составляет 12 часов, что означает, что конфигурации не будут извлечены из бэкэнда более одного раза в 12 -часовом окне, независимо от того, сколько вызовов на самом деле сделано.

Во время разработки приложений, если вы не используете удаленную конфигурацию в режиме реального времени (которую мы рекомендуем), вы можете очень часто привлекать и активировать конфигурации (много раз в час), чтобы вы быстро обращались при разработке и тестировании своего приложения. Чтобы приспособиться к быстрой итерации на проекте с 10 разработчиками, вы можете временно установить низкий минимальный интервал сбора с помощью setConfigSettings() .

final remoteConfig = FirebaseRemoteConfig.instance;
await remoteConfig.setConfigSettings(RemoteConfigSettings(
    fetchTimeout: const Duration(minutes: 1),
    minimumFetchInterval: const Duration(minutes: 5),
));

Следующие шаги

If you haven't already, explore the Remote Config use cases , and take a look at some of the key concepts and advanced strategies documentation, including:

,


You can use Firebase Remote Config to define parameters in your app and update their values in the cloud, allowing you to modify the appearance and behavior of your app without distributing an app update. This guide walks you through the steps to get started and provides some sample code.

Step 1: Add Firebase and the Remote Config SDK to your app

  1. Install and initialize the Firebase SDKs for Flutter if you haven't already done so.

  2. For Remote Config, Google Analytics is required for the conditional targeting of app instances to user properties and audiences. Make sure that you enable Google Analytics in your project.

  3. From the root directory of your Flutter project, run the following command to install the Remote Config plugin:

    flutter pub add firebase_remote_config

    Also, as part of setting up Remote Config, you need to add the Firebase SDK for Google Analytics to your app:

    flutter pub add firebase_analytics

  4. Rebuild your project:

    flutter run

  5. If you're using Remote Config on macOS, enable Keychain Sharing in Xcode.

Step 2: Get the Remote Config singleton object

Get a Remote Config object instance and set the minimum fetch interval to allow for frequent refreshes:

final remoteConfig = FirebaseRemoteConfig.instance;
await remoteConfig.setConfigSettings(RemoteConfigSettings(
    fetchTimeout: const Duration(minutes: 1),
    minimumFetchInterval: const Duration(hours: 1),
));

The singleton object is used to store in-app default parameter values, fetch updated parameter values from the backend, and control when fetched values are made available to your app.

During development, it's recommended to set a relatively low minimum fetch interval. See Throttling for more information.

Step 3: Set in-app default parameter values

You can set in-app default parameter values in the Remote Config object, so that your app behaves as intended before it connects to the Remote Config backend, and so that default values are available if none are set in the backend.

await remoteConfig.setDefaults(const {
    "example_param_1": 42,
    "example_param_2": 3.14159,
    "example_param_3": true,
    "example_param_4": "Hello, world!",
});

Step 4: Get parameter values to use in your app

Now you can get parameter values from the Remote Config object. If you set values in the backend, fetch them, and then activate them, those values are available to your app. Otherwise, you get the in-app parameter values configured using setDefaults() .

To get these values, call the method listed below that maps to the data type expected by your app, providing the parameter key as an argument:

  • getBool()
  • getDouble()
  • getInt()
  • getString()

Step 5: Set parameter values in the Remote Config backend

Using the Firebase console or the Remote Config backend APIs , you can create new server-side default values that override the in-app values according to your desired conditional logic or user targeting. This section describes the Firebase console steps to create these values.

  1. In the Firebase console , open your project.
  2. Select Remote Config from the menu to view the Remote Config dashboard.
  3. Define parameters with the same names as the parameters that you defined in your app. For each parameter, you can set a default value (which will eventually override the corresponding in-app default value), and you can also set conditional values. To learn more, see Remote Config Parameters and Conditions .

Step 6: Fetch and activate values

  1. To fetch parameter values from the Remote Config backend, call the fetch() method. Any values that you set in the backend are fetched and stored in the Remote Config object.

  2. To make fetched parameter values available to your app, call the activate() method.

    For cases where you want to fetch and activate values in one call, you can use a fetchAndActivate() request to fetch values from the Remote Config backend and make them available to the app:

    await remoteConfig.fetchAndActivate();

Because these updated parameter values affect the behavior and appearance of your app, you should activate the fetched values at a time that ensures a smooth experience for your user, such as the next time that the user opens your app. See Remote Config loading strategies for more information and examples.

Step 7: Listen for updates in real time

After you fetch parameter values, you can use real-time Remote Config to listen for updates from the Remote Config backend. Real-time Remote Config signals to connected devices when updates are available and automatically fetches the changes after you publish a new Remote Config version.

Note that real-time Remote Config is not available for Web.

  1. In your app, use onConfigUpdated to start listening for updates and automatically fetch any new parameter values.

     remoteConfig.onConfigUpdated.listen((event) async {
   await remoteConfig.activate();

   // Use the new config values here.
 });

  2. The next time you publish a new version of your Remote Config, devices that are running your app and listening for changes will activate the new config.

Throttling

If an app fetches too many times in a short time period, fetch calls will be throttled and the value of FirebaseRemoteConfig 's lastFetchStatus property will be RemoteConfigFetchStatus.throttle .

The default minimum fetch interval for Remote Config is 12 hours, which means that configs won't be fetched from the backend more than once in a 12 hour window, regardless of how many fetch calls are actually made.

During app development, if you're not using real-time Remote Config (which we recommend), you might want to fetch and activate configs very frequently (many times per hour) to let you rapidly iterate as you develop and test your app. To accommodate rapid iteration on a project with up to 10 developers, you can temporarily set a low minimum fetch interval with setConfigSettings() .

final remoteConfig = FirebaseRemoteConfig.instance;
await remoteConfig.setConfigSettings(RemoteConfigSettings(
    fetchTimeout: const Duration(minutes: 1),
    minimumFetchInterval: const Duration(minutes: 5),
));

Следующие шаги

If you haven't already, explore the Remote Config use cases , and take a look at some of the key concepts and advanced strategies documentation, including: