Vous pouvez utiliser Firebase Remote Config pour définir des paramètres dans votre application et mettre à jour leurs valeurs dans le cloud, ce qui vous permet de modifier l'apparence et le comportement sans distribuer de mise à jour. Ce guide vous explique comment commencer et fournit des exemples de code, tous disponibles à cloner ou à télécharger à partir du dépôt GitHub firebase/quickstart-android.
Étape 1: Ajoutez Firebase et le SDK Remote Config à votre application
Si ce n'est pas déjà fait, Ajoutez Firebase à votre projet Android.
Pour Remote Config, Google Analytics est requis pour le ciblage conditionnel des instances d'application avec des propriétés utilisateur et des audiences. Assurez-vous d'activer Google Analytics dans votre projet.
Dans le fichier Gradle de votre module (au niveau de l'application) (généralement
<project>/<app-module>/build.gradle.kts
ou<project>/<app-module>/build.gradle
), Ajoutez la dépendance pour la bibliothèque Remote Config pour Android. Nous vous recommandons d'utiliser Firebase Android BoM pour contrôler le contrôle des versions de la bibliothèque.De plus, pour configurer Analytics, vous devez ajouter le SDK Firebase pour Google Analytics à votre application.
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.4.0")) // Add the dependencies for the Remote Config and Analytics libraries // When using the BoM, you don't specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-config") implementation("com.google.firebase:firebase-analytics") }
En utilisant Firebase Android BoM, votre application utilisera toujours des versions compatibles des bibliothèques Firebase Android.
(Alternative) Ajoutez des dépendances de bibliothèque Firebase sans utiliser BoM.
Si vous choisissez de ne pas utiliser Firebase BoM, vous devez spécifier chaque version de la bibliothèque Firebase dans sa ligne de dépendance.
Notez que si vous utilisez plusieurs bibliothèques Firebase dans votre application, nous vous recommandons vivement d'utiliser BoM pour gérer les versions de la bibliothèque, ce qui garantit que toutes les versions sont compatibles.
dependencies { // Add the dependencies for the Remote Config and Analytics libraries // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-config:22.0.0") implementation("com.google.firebase:firebase-analytics:22.1.2") }
Étape 2 : Obtenir l'objet singleton Remote Config
Obtenez une instance d'objet Remote Config et définissez le Intervalle de récupération minimal requis pour des actualisations fréquentes:
Kotlin+KTX
val remoteConfig: FirebaseRemoteConfig = Firebase.remoteConfig val configSettings = remoteConfigSettings { minimumFetchIntervalInSeconds = 3600 } remoteConfig.setConfigSettingsAsync(configSettings)
Java
FirebaseRemoteConfig mFirebaseRemoteConfig = FirebaseRemoteConfig.getInstance(); FirebaseRemoteConfigSettings configSettings = new FirebaseRemoteConfigSettings.Builder() .setMinimumFetchIntervalInSeconds(3600) .build(); mFirebaseRemoteConfig.setConfigSettingsAsync(configSettings);
L'objet singleton permet de stocker les valeurs de paramètre par défaut dans l'application, d'extraire les valeurs de paramètre mises à jour à partir du backend et de contrôler le moment où les valeurs extraites sont mises à la disposition de votre application.
Lors du développement, nous vous recommandons de définir un intervalle de récupération minimal relativement faible. Pour en savoir plus, consultez la section Limitation.
Étape 3 : Définir les valeurs par défaut des paramètres dans l'application
Vous pouvez définir des valeurs de paramètres par défaut dans l'application dans Remote Config , afin que votre application se comporte comme prévu avant de se connecter Remote Config, et afin que les valeurs par défaut soient disponibles si aucune n'est dans le backend.
Définissez un ensemble de noms et de valeurs de paramètres par défaut à l'aide d'un Map ou un objet Fichier de ressources XML stocké dans le dossier
res/xml
de votre application. L'application exemple du guide de démarrage rapide Remote Config utilise un fichier XML pour définir les noms et valeurs de paramètres par défaut.Si vous avez déjà configuré Remote Config valeurs de paramètre de backend, vous pouvez télécharger un fichier XML généré qui inclut toutes les valeurs par défaut et enregistrez-le dans le répertoire
res/xml
de votre application:REST
curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=XML -o remote_config_defaults.xml
Console Firebase
Dans Paramètres, ouvrez l'onglet Menu, puis sélectionnez Télécharger les valeurs par défaut.
Lorsque vous y êtes invité, activez .xml pour Android, puis cliquez sur Télécharger le fichier
Ajoutez ces valeurs à l'objet Remote Config avec
setDefaultsAsync(int)
comme indiqué ci-dessous:Kotlin+KTX
remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)
Java
mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);
Étape 4 : Obtenez les valeurs de paramètre à utiliser dans votre application
Vous pouvez maintenant obtenir les valeurs des paramètres à partir de l'objet Remote Config. Si vous définissez
dans le backend, les récupérer, puis les activer,
ces valeurs sont disponibles pour votre application. Sinon, vous obtenez
des valeurs de paramètres configurées
setDefaultsAsync(int)
Pour obtenir ces valeurs, appelez la méthode listée ci-dessous qui correspond au type de données attendu par votre application, en fournissant la clé de paramètre comme argument :
Étape 5: Définissez les valeurs de paramètre dans le backend Remote Config
À l'aide de la console Firebase ou des API backend Remote Config, vous pouvez créer des valeurs par défaut côté serveur qui remplacent les valeurs dans l'application en fonction de la logique conditionnelle ou du ciblage utilisateur souhaités. Cette section décrit les étapes à suivre dans la console Firebase pour créer ces valeurs.
- Dans la console Firebase, ouvrez votre projet.
- Sélectionnez Remote Config dans le menu pour afficher le tableau de bord Remote Config.
- Définissez les paramètres en leur attribuant les mêmes noms que ceux que vous avez définis dans votre application. Pour chaque paramètre, vous pouvez définir une valeur par défaut (qui remplacer éventuellement la valeur par défaut correspondante dans l'application), et vous pouvez aussi définir des valeurs conditionnelles. Pour en savoir plus, consultez la section Paramètres et conditions Remote Config.
Étape 6 : Extrayez et activez les valeurs
- Pour récupérer les valeurs de paramètre à partir du backend Remote Config, appelez la méthode
fetch()
. Toutes les valeurs que vous définissez dans le backend sont extraites et stockées dans l'objet Remote Config. Pour que les valeurs des paramètres récupérées soient disponibles pour votre application, appelez la méthode
activate()
.Si vous souhaitez extraire et activer des valeurs en un seul appel, vous pouvez utiliser une requête
fetchAndActivate()
pour extraire des valeurs du backend Remote Config et les mettre à la disposition de l'application :Kotlin+KTX
remoteConfig.fetchAndActivate() .addOnCompleteListener(this) { task -> if (task.isSuccessful) { val updated = task.result Log.d(TAG, "Config params updated: $updated") Toast.makeText( this, "Fetch and activate succeeded", Toast.LENGTH_SHORT, ).show() } else { Toast.makeText( this, "Fetch failed", Toast.LENGTH_SHORT, ).show() } displayWelcomeMessage() }
Java
mFirebaseRemoteConfig.fetchAndActivate() .addOnCompleteListener(this, new OnCompleteListener<Boolean>() { @Override public void onComplete(@NonNull Task<Boolean> task) { if (task.isSuccessful()) { boolean updated = task.getResult(); Log.d(TAG, "Config params updated: " + updated); Toast.makeText(MainActivity.this, "Fetch and activate succeeded", Toast.LENGTH_SHORT).show(); } else { Toast.makeText(MainActivity.this, "Fetch failed", Toast.LENGTH_SHORT).show(); } displayWelcomeMessage(); } });
Étant donné que ces nouvelles valeurs de paramètres ont une incidence sur le comportement et l'apparence de votre application, vous devez activer les valeurs récupérées à un moment une expérience fluide pour l'utilisateur, comme la prochaine fois qu'il ouvrira votre l'application. Consultez l'article Stratégies de chargement Remote Config. pour obtenir plus d'informations et d'exemples.
Étape 7: Écoutez les mises à jour en temps réel
Après avoir extrait les valeurs des paramètres, vous pouvez utiliser Remote Config en temps réel pour écouter les mises à jour du backend Remote Config. En temps réel Remote Config signale aux appareils connectés lorsque des mises à jour sont disponibles et récupère automatiquement les modifications après la publication d'une nouvelle Remote Config version.
Les mises à jour en temps réel sont compatibles avec le SDK Firebase pour Android v21.3.0+ (Firebase BoM v31.2.4+).
Dans votre application, utilisez
addOnConfigUpdateListener()
pour commencer à écouter les mises à jour et à extraire automatiquement les nouvelles valeurs de paramètre. Implémentez le rappelonUpdate()
pour activer la configuration mise à jour.Kotlin+KTX
remoteConfig.addOnConfigUpdateListener(object : ConfigUpdateListener { override fun onUpdate(configUpdate : ConfigUpdate) { Log.d(TAG, "Updated keys: " + configUpdate.updatedKeys); if (configUpdate.updatedKeys.contains("welcome_message")) { remoteConfig.activate().addOnCompleteListener { displayWelcomeMessage() } } } override fun onError(error : FirebaseRemoteConfigException) { Log.w(TAG, "Config update error with code: " + error.code, error) } })
Java
mFirebaseRemoteConfig.addOnConfigUpdateListener(new ConfigUpdateListener() { @Override public void onUpdate(ConfigUpdate configUpdate) { Log.d(TAG, "Updated keys: " + configUpdate.getUpdatedKeys()); mFirebaseRemoteConfig.activate().addOnCompleteListener(new OnCompleteListener<Boolean>() { @Override public void onComplete(@NonNull Task<Boolean> task) { displayWelcomeMessage(); } }); } @Override public void onError(FirebaseRemoteConfigException error) { Log.w(TAG, "Config update error with code: " + error.getCode(), error); } });
La prochaine fois que vous publierez une nouvelle version de votre Remote Config, les appareils qui exécutent votre application et écoutent les modifications
ConfigUpdateListener
Limitations
Si une application effectue trop de récupérations sur une courte période, les appels de récupération sont limités et le SDK renvoie FirebaseRemoteConfigFetchThrottledException
. Avant la version 17.0.0 du SDK, le
La limite était de 5 requêtes de récupération en 60 minutes
(les versions plus récentes ont des limites plus permissives).
Pendant le développement de l'application, vous souhaiterez
peut-être récupérer et activer des configurations
(plusieurs fois par heure) pour vous permettre d'itérer rapidement
tester votre application. Les mises à jour Remote Config en temps réel contournent automatiquement
lorsque la configuration est mise à jour sur le serveur. Pour permettre une itération rapide sur un projet comprenant jusqu'à 10 développeurs, vous pouvez définir temporairement un objet FirebaseRemoteConfigSettings
avec un intervalle d'extraction minimal faible (setMinimumFetchIntervalInSeconds
) dans votre application.
L'intervalle de récupération minimal par défaut pour Remote Config est de 12 heures, ce qui signifie que les configurations ne seront pas récupérées plus d'une fois en 12 heures depuis le backend quel que soit le nombre d'appels réellement effectués. Plus précisément, l'intervalle de récupération minimal est déterminé dans l'ordre suivant:
- Paramètre dans
fetch(long)
- Paramètre dans
FirebaseRemoteConfigSettings.setMinimumFetchIntervalInSeconds(long)
- La valeur par défaut est de 12 heures.
Pour définir l'intervalle de récupération minimal sur une valeur personnalisée, utilisez FirebaseRemoteConfigSettings.Builder.setMinimumFetchIntervalInSeconds(long)
.
Étapes suivantes
Si ce n'est pas déjà fait, explorez les Remote Config cas d'utilisation et consultez certains des concepts clés et la documentation sur les stratégies avancées, y compris :