Catch up on everthing we announced at this year's Firebase Summit. Learn more

Premiers pas avec Firebase Remote Config

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 de votre application sans distribuer de mise à jour d'application. Ce guide vous guide à travers les étapes pour commencer et fournit quelques exemples de code, tous qui est disponible pour clone ou téléchargement à partir du firebase / QuickStart-android GitHub dépôt.

Ajoutez Firebase et le SDK Remote Config à votre application

  1. Si vous avez pas déjà, ajoutez Firebase à votre projet Android .

  2. Pour Config à distance, Google Analytics est nécessaire pour le ciblage conditionnel des cas d'applications aux propriétés de l' utilisateur, le public et les prévisions Firebase. Assurez - vous que vous activez Google Analytics dans votre projet.

  3. Utilisation de la Firebase Android BoM , déclarer la dépendance de la bibliothèque Android à distance Config dans votre module (app-niveau) de fichier Gradle (généralement app/build.gradle ).

    De plus, dans le cadre de la configuration d'Analytics, vous devez ajouter le SDK Firebase pour Google Analytics à votre application.

    Java

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:29.0.0')
    
        // Declare 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 le Firebase Android BoM , votre application utilise toujours des versions compatibles des bibliothèques Firebase Android.

    (Alternative) déclarer des dépendances de bibliothèque firebase sans utiliser la nomenclature

    Si vous choisissez de ne pas utiliser la nomenclature de Firebase, 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 fortement d' utiliser la BoM pour gérer les versions bibliothèque, ce qui garantit que toutes les versions sont compatibles.

    dependencies {
        // Declare 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:21.0.1'
        implementation 'com.google.firebase:firebase-analytics:20.0.0'
    }
    

    Kotlin+KTX

    dependencies {
        // Import the BoM for the Firebase platform
        implementation platform('com.google.firebase:firebase-bom:29.0.0')
    
        // Declare 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-ktx'
        implementation 'com.google.firebase:firebase-analytics-ktx'
    }
    

    En utilisant le Firebase Android BoM , votre application utilise toujours des versions compatibles des bibliothèques Firebase Android.

    (Alternative) déclarer des dépendances de bibliothèque firebase sans utiliser la nomenclature

    Si vous choisissez de ne pas utiliser la nomenclature de Firebase, 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 fortement d' utiliser la BoM pour gérer les versions bibliothèque, ce qui garantit que toutes les versions sont compatibles.

    dependencies {
        // Declare 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-ktx:21.0.1'
        implementation 'com.google.firebase:firebase-analytics-ktx:20.0.0'
    }
    

Obtenir l'objet singleton Remote Config

Obtenez une instance d'objet Remote Config et définissez l'intervalle d'extraction minimum pour permettre des actualisations fréquentes :

Java

mFirebaseRemoteConfig = FirebaseRemoteConfig.getInstance();
FirebaseRemoteConfigSettings configSettings = new FirebaseRemoteConfigSettings.Builder()
        .setMinimumFetchIntervalInSeconds(3600)
        .build();
mFirebaseRemoteConfig.setConfigSettingsAsync(configSettings);

Kotlin+KTX

remoteConfig = Firebase.remoteConfig
val configSettings = remoteConfigSettings {
    minimumFetchIntervalInSeconds = 3600
}
remoteConfig.setConfigSettingsAsync(configSettings)

L'objet singleton est utilisé pour stocker les valeurs de paramètres par défaut dans l'application, récupérer les valeurs de paramètres mises à jour à partir du backend et contrôler quand les valeurs récupérées sont mises à disposition de votre application.

Pendant le développement, il est recommandé de définir un intervalle d'extraction minimum relativement faible. Voir Throttling pour plus d' informations.

Définir les valeurs des paramètres par défaut dans l'application

Vous pouvez définir des valeurs de paramètre par défaut dans l'application dans l'objet Remote Config, afin que votre application se comporte comme prévu avant de se connecter au backend Remote Config, et afin que les valeurs par défaut soient disponibles si aucune n'est définie dans le backend.

  1. Définir un ensemble de noms de paramètres et les valeurs des paramètres par défaut en utilisant une carte objet ou d' un fichier de ressources XML stockées dans votre application res/xml dossier. L'application à distance Config échantillon quickstart utilise un fichier XML pour définir les noms des paramètres et valeurs par défaut.
  2. Ajouter ces valeurs à l'objet Config à distance à l' aide setDefaultsAsync(int) , comme le montre:

Java

mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);

Kotlin+KTX

remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)

Obtenez les valeurs des paramètres à utiliser dans votre application

Vous pouvez maintenant obtenir les valeurs des paramètres à partir de l'objet Remote Config. Si vous définissez des valeurs dans le backend, les récupérez, puis les activez, ces valeurs sont disponibles pour votre application. Dans le cas contraire, vous obtenez les valeurs des paramètres en application configurés à l' aide setDefaultsAsync(int) . Pour obtenir ces valeurs, appelez la méthode répertoriée ci-dessous qui correspond au type de données attendu par votre application, en fournissant la clé de paramètre comme argument :

Définir les valeurs des paramètres dans le backend Remote Config

Utilisation de la console Firebase ou les API back - end Config à distance , vous pouvez créer de nouvelles valeurs par défaut du côté du serveur qui remplacent les valeurs en-application en fonction de votre logique conditionnelle ou de l' utilisateur cible souhaité. Cette section décrit les étapes de la console Firebase pour créer ces valeurs.

  1. Dans la console Firebase , ouvrez votre projet.
  2. Sélectionnez Config à distance dans le menu pour afficher le tableau de bord Config à distance.
  3. Définissez des paramètres portant les mêmes noms que les paramètres que vous avez définis dans votre application. Pour chaque paramètre, vous pouvez définir une valeur par défaut (qui remplacera éventuellement la valeur par défaut correspondante dans l'application) et vous pouvez également définir des valeurs conditionnelles. Pour en savoir plus, reportez - vous à distance Config Paramètres et Conditions .

Récupérer et activer les valeurs

  1. Pour extraire les valeurs des paramètres du back - end Config à distance, appelez la fetch() méthode. Toutes les valeurs que vous définissez dans le backend sont récupérées et stockées dans l'objet Remote Config.
  2. Pour les valeurs des paramètres disponibles à votre extraites application, appelez le activate() méthode.

    Pour le cas où vous souhaitez chercher et activer des valeurs dans un appel, vous pouvez utiliser un fetchAndActivate() demande de lire des valeurs du back - end Config à distance et les rendre disponibles à l'application:

    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();
                }
            });

    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()
            }

Étant donné que ces valeurs de paramètres mises à jour affectent le comportement et l'apparence de votre application, vous devez activer les valeurs récupérées à un moment qui garantit une expérience fluide pour votre utilisateur, comme la prochaine fois que l'utilisateur ouvre votre application. Voir les stratégies de chargement à distance Config pour plus d' informations et des exemples.

Étranglement

Si une application va chercher trop de fois dans un court laps de temps, les appels sont étranglées chercher et le SDK retourne FirebaseRemoteConfigFetchThrottledException . Avant la version 17.0.0 du SDK, la limite était de 5 requêtes d'extraction dans une fenêtre de 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 les configurations très fréquemment (plusieurs fois par heure) pour vous permettre d'itérer rapidement au fur et à mesure que vous développez et testez votre application. Pour répondre à l' itération rapide sur un projet avec un maximum de 10 développeurs, vous pouvez définir temporairement un FirebaseRemoteConfigSettings objet avec un minimum faible (Intervalle de récupération setMinimumFetchIntervalInSeconds ) dans votre application.

L'intervalle d'extraction minimum par défaut pour la configuration à distance est de 12 heures, ce qui signifie que les configurations ne seront pas extraites du backend plus d'une fois dans une fenêtre de 12 heures, quel que soit le nombre d'appels d'extraction réellement effectués. Plus précisément, l'intervalle d'extraction minimum est déterminé dans l'ordre suivant :

  1. Le paramètre d' fetch(long)
  2. Le paramètre dans FirebaseRemoteConfigSettings.setMinimumFetchIntervalInSeconds(long)
  3. La valeur par défaut de 12 heures

Pour définir le minimum Intervalle de récupération à une valeur personnalisée, utilisez FirebaseRemoteConfigSettings.Builder.setMinimumFetchIntervalInSeconds(long) .

Prochaines étapes

Si vous n'avez pas déjà, explorer les Config à distance des cas d'utilisation , et jeter un oeil à quelques - uns des concepts et des stratégies avancées clés de la documentation, y compris: