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, vous permettant ainsi de modifier l'apparence et le comportement de votre application sans distribuer de mise à jour d'application. Ce guide vous guide à travers les étapes de démarrage et fournit des exemples de code.

Étape 1 : Ajoutez Firebase et le SDK Remote Config à votre application

  1. Installez et initialisez les SDK Firebase pour Flutter si vous ne l'avez pas déjà fait.

  2. Pour Remote Config, Google Analytics est requis pour le ciblage conditionnel des instances d'application sur les propriétés et les audiences des utilisateurs. Assurez-vous d'activer Google Analytics dans votre projet.

  3. Depuis le répertoire racine de votre projet Flutter, exécutez la commande suivante pour installer le plugin Remote Config :

    flutter pub add firebase_remote_config
    

    De plus, dans le cadre de la configuration de Remote Config, vous devez ajouter le SDK Firebase pour Google Analytics à votre application :

    flutter pub add firebase_analytics
    
  4. Reconstruisez votre projet :

    flutter run
    
  5. Si vous utilisez Remote Config sur macOS, activez le partage de trousseau dans Xcode.

Étape 2 : Obtenez l'objet singleton Remote Config

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

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

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

Pendant le développement, il est recommandé de définir un intervalle de récupération minimum relativement faible. Voir Limitation pour plus d’informations.

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

Vous pouvez définir les valeurs des paramètres par défaut de 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 pour que les valeurs par défaut soient disponibles si aucune n'est définie dans le backend.

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

Étape 4 : Obtenez les valeurs des paramètres à utiliser dans votre application

Vous pouvez désormais 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. Sinon, vous obtenez les valeurs des paramètres dans l'application configurées à l'aide setDefaults() .

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 :

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

Étape 5 : Définir les valeurs des paramètres dans le backend Remote Config

À l'aide de la console Firebase ou des API backend Remote Config , vous pouvez créer de nouvelles valeurs par défaut côté serveur qui remplacent les valeurs de l'application en fonction de la logique conditionnelle ou du ciblage des utilisateurs souhaités. 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 Remote Config dans le menu pour afficher le tableau de bord Remote Config.
  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, consultez Paramètres et conditions de configuration à distance .

Étape 6 : Récupérer et activer les valeurs

  1. Pour récupérer les valeurs des paramètres à partir du backend Remote Config, appelez la méthode fetch() . 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 rendre les valeurs des paramètres récupérées disponibles pour votre application, appelez la méthode activate() .

    Dans les cas où vous souhaitez récupérer et activer des valeurs en un seul appel, vous pouvez utiliser une requête fetchAndActivate() pour récupérer les valeurs du backend Remote Config et les rendre disponibles pour l'application :

    await remoteConfig.fetchAndActivate();
    

É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 à votre utilisateur, par exemple la prochaine fois que l'utilisateur ouvrira votre application. Consultez les stratégies de chargement de Remote Config pour plus d’informations et des exemples.

Étape 7 : Écoutez les mises à jour en temps réel

Après avoir récupéré les valeurs des paramètres, vous pouvez utiliser Remote Config en temps réel pour écouter les mises à jour du backend Remote Config. Remote Config en temps réel 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 version de Remote Config.

Notez que la configuration à distance en temps réel n'est pas disponible pour le Web.

  1. Dans votre application, utilisez onConfigUpdated pour commencer à écouter les mises à jour et récupérer automatiquement toutes les nouvelles valeurs de paramètres.

     remoteConfig.onConfigUpdated.listen((event) async {
       await remoteConfig.activate();
    
       // Use the new config values here.
     });
    
  2. La prochaine fois que vous publierez une nouvelle version de votre configuration à distance, les appareils qui exécutent votre application et écoutent les modifications activeront la nouvelle configuration.

Étranglement

Si une application récupère trop de fois sur une courte période, les appels de récupération seront limités et la valeur de la propriété lastFetchStatus de FirebaseRemoteConfig sera RemoteConfigFetchStatus.throttle .

L'intervalle de récupération minimum par défaut pour Remote Config est de 12 heures, ce qui signifie que les configurations ne seront pas récupérées depuis le backend plus d'une fois dans une fenêtre de 12 heures, quel que soit le nombre d'appels de récupération réellement effectués.

Pendant le développement de l'application, si vous n'utilisez pas Remote Config en temps réel (ce que nous recommandons), 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 pendant que vous développez et testez votre application. Pour permettre une itération rapide sur un projet comptant jusqu'à 10 développeurs, vous pouvez définir temporairement un intervalle de récupération minimum faible avec setConfigSettings() .

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

Prochaines étapes

Si vous ne l'avez pas déjà fait, explorez les cas d'utilisation de la configuration à distance et jetez un œil à certains des concepts clés et des stratégies avancées, notamment: