Configurer plusieurs projets

Cette page explique comment utiliser plusieurs projets Firebase dans votre application.

De nombreuses applications n'ont besoin que d'un seul projet Firebase et de la configuration par défaut décrite dans les guides Premiers pas. Voici quelques exemples de cas où il peut être utile d'utiliser plusieurs projets Firebase :

• Configurer votre environnement de développement pour qu'il utilise différents projets Firebase en fonction du type de compilation ou de la cible.
• Accéder au contenu de plusieurs projets Firebase dans votre application.

Prendre en charge différents environnements

Un cas d'utilisation courant consiste à prendre en charge des projets Firebase distincts pour vos environnements de développement et de production.

Les SDK Web et Admin sont configurés en transmettant directement des valeurs à leurs fonctions d'initialisation. Pour ces SDK, vous pouvez utiliser une vérification au moment de l'exécution pour sélectionner des variables de configuration de développement ou de production.

Les plates-formes Android et Apple (ainsi que leurs wrappers Unity et C++) chargent normalement la configuration à partir d'un fichier de configuration : GoogleService-Info.plist sur la plate-forme Apple et google-services.json sur Android. Ces fichiers sont lus dans un objet d'options (FIROption ou FirebaseOptions) référencé par l'objet d'application Firebase (FIRApp ou FirebaseApp).

Pour ces plates-formes, le basculement entre les environnements est généralement implémenté en tant que décision au moment de la compilation, grâce à l'utilisation de différents fichiers de configuration pour chaque environnement.

Prendre en charge plusieurs environnements dans votre application Apple

Par défaut, FirebaseApp.configure() charge le fichier GoogleService-Info.plist fourni avec l'application. Si vos environnements de développement et de production sont configurés en tant que cibles distinctes dans Xcode, vous pouvez procéder comme suit :

• Téléchargez les deux fichiers GoogleService-Info.plist.
• Stockez les deux fichiers dans des répertoires différents.
• Ajoutez-les tous les deux à votre projet Xcode.
• Associez les différents fichiers aux différentes cibles à l'aide du panneau "Target Membership" (Appartenance à la cible) :

Si les compilations font partie d'une seule cible, la meilleure option consiste à attribuer des noms uniques aux deux fichiers de configuration (par exemple, GoogleService-Info-Free.plist et GoogleService-Info-Paid.plist). Choisissez ensuite au moment de l'exécution le fichier plist à charger. Ceci est illustré dans l'exemple suivant :

// Load a named file.
guard 
  let filePath = Bundle.main.path(forResource: "MyGoogleService", ofType: "plist"),
  let fileOptions = FirebaseOptions(contentsOfFile: filePath)
else { fatalError("Couldn't load config file.") }
FirebaseApp.configure(options: fileOptions)

Avertissement : Cette approche peut avoir un impact sur la collecte Analytics dans certaines circonstances. Consultez la section sur l'analyse fiable.

Prendre en charge plusieurs environnements dans votre application Android

Dans les projets Android, le fichier de configuration google-services.json est traité en ressources de chaîne Android par le google-services plug-in Gradle. Pour savoir quelles ressources sont créées par le plug-in, consultez Traitement du fichier de configuration JSON.

Vous pouvez disposer d'un fichier de configuration google-services.json pour chacune de vos différentes variantes de compilation en plaçant chaque fichier de configuration google-services.json dans un répertoire dédié nommé pour chaque variante sous la racine du module d'application. Par exemple, si vous disposez de saveurs de compilation "development" et "release", votre configuration peut être organisée comme suit :

app/
    google-services.json
    src/development/google-services.json
    src/release/google-services.json
    ...

Pour en savoir plus, consultez Ajouter le fichier JSON.

Ces ressources sont ensuite chargées par le FirebaseInitProvider, qui s'exécute avant le code de votre application et initialise les API Firebase à l'aide de ces valeurs.

Étant donné que ce fournisseur ne fait que lire des ressources avec des noms connus, vous pouvez également ajouter les ressources de chaîne directement à votre application au lieu d'utiliser le plug-in Gradle google-services. Pour ce faire, procédez comme suit :

• Supprimez le plug-in Gradle google-services de votre build.gradle racine.
• Supprimez le fichier de configuration google-services.json de votre projet.
• Ajoutez directement les ressources de chaîne.
• Supprimez apply plugin: 'com.google.gms.google-services' de votre application build.gradle

Utiliser plusieurs projets dans votre application

Vous devez parfois accéder à différents projets à l'aide des mêmes API, par exemple pour accéder à plusieurs instances de base de données. Dans la plupart des cas, il existe un objet d'application Firebase central qui gère la configuration de toutes les API Firebase. Cet objet est initialisé dans le cadre de votre configuration normale. Toutefois, lorsque vous souhaitez accéder à plusieurs projets à partir d'une seule application, vous avez besoin d'un objet d'application Firebase distinct pour référencer chacun d'eux individuellement. Il vous appartient d'initialiser ces autres instances.

Dans les deux cas, vous devez d'abord créer un objet d'options Firebase pour contenir les données de configuration de l'application Firebase. La documentation complète des options est disponible dans la documentation de référence de l'API pour les classes suivantes :

• Swift: FirebaseOptions(googleAppID:gcmSenderID:)
• Android: FirebaseOptions.Builder
• Web: initializeApp()
• C++: firebase::App::Create
• Unity: FirebaseApp.Create
• Node.js: initializeApp
• Java: FirebaseOptions.Builder

L'utilisation de ces classes pour prendre en charge plusieurs projets dans une application est illustrée dans les exemples suivants :

Swift

// Configure with manual options. Note that projectID and apiKey, though not
// required by the initializer, are mandatory.
let secondaryOptions = FirebaseOptions(googleAppID: "1:27992087142:ios:2a4732a34787067a",
                                       gcmSenderID: "27992087142")
secondaryOptions.apiKey = "AIzaSyBicqfAZPvMgC7NZkjayUEsrepxuXzZDsk"
secondaryOptions.projectID = "projectid-12345"

// The other options are not mandatory, but may be required
// for specific Firebase products.
secondaryOptions.bundleID = "com.google.firebase.devrel.FiroptionConfiguration"
secondaryOptions.clientID = "27992087142-ola6qe637ulk8780vl8mo5vogegkm23n.apps.googleusercontent.com"
secondaryOptions.databaseURL = "https://myproject.firebaseio.com"
secondaryOptions.storageBucket = "myproject.appspot.com"
secondaryOptions.deepLinkURLScheme = "myapp://"
secondaryOptions.storageBucket = "projectid-12345.appspot.com"
secondaryOptions.appGroupID = nil
AppDelegate.swift

Kotlin

// Manually configure Firebase Options. The following fields are REQUIRED:
//   - Project ID
//   - App ID
//   - API Key
val options = FirebaseOptions.Builder()
    .setProjectId("my-firebase-project")
    .setApplicationId("1:27992087142:android:ce3b6448250083d1")
    .setApiKey("AIzaSyADUe90ULnQDuGShD9W23RDP0xmeDc6Mvw")
    // .setDatabaseUrl(...)
    // .setStorageBucket(...)
    .build()
MainActivity.kt

Java

// Manually configure Firebase Options. The following fields are REQUIRED:
//   - Project ID
//   - App ID
//   - API Key
FirebaseOptions options = new FirebaseOptions.Builder()
        .setProjectId("my-firebase-project")
        .setApplicationId("1:27992087142:android:ce3b6448250083d1")
        .setApiKey("AIzaSyADUe90ULnQDuGShD9W23RDP0xmeDc6Mvw")
        // setDatabaseURL(...)
        // setStorageBucket(...)
        .build();
MainActivity.java

sur le Web

// The following fields are REQUIRED:
//  - Project ID
//  - App ID
//  - API Key
const secondaryAppConfig = {
    projectId: "<PROJECT_ID>",
    appId: "<APP_ID>",
    apiKey: "<API_KEY>",
    // databaseURL: "...",
    // storageBucket: "...",
};
firebaseapp.js

C++

firebase::AppOptions secondary_app_options;

// API key, app ID, and project ID are always required.
secondary_app_options.set_api_key("<API_KEY>");
secondary_app_options.set_app_id("<GOOGLE_APP_ID>");
secondary_app_options.set_project_id("<PROJECT_ID>");

// The following options are specific to individual Firebase products
// and may not always be required.
secondary_app_options.set_database_url("<DATABASE_URL>");
secondary_app_options.set_messaging_sender_id("<SENDER_ID>");
secondary_app_options.set_storage_bucket("<STORAGE_BUCKET>");

Unity

Firebase.AppOptions secondaryAppOptions = new Firebase.AppOptions {
  ApiKey = "<API_KEY>",
  AppId = "<GOOGLE_APP_ID>",
  ProjectId = "<PROJECT_ID>"
};

Node.js

const secondaryServiceAccount = require('./path/to/serviceAccountKey.json');

// All required options are specified by the service account,
// add service-specific configuration like databaseURL as needed.
const secondaryAppConfig = {
    credential: cert(secondaryServiceAccount),
    // databaseURL: 'https://<DATABASE_NAME>.firebaseio.com'
};
index.js

Java

FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccountKey.json");

FirebaseOptions secondaryAppConfig = new FirebaseOptions.Builder()
  .setCredential(FirebaseCredentials.fromCertificate(serviceAccount))
  .setDatabaseUrl("https://<DATABASE_NAME>.firebaseio.com/")
  .build();

Une fois cet objet d'options initialisé, vous pouvez l'utiliser pour configurer une instance d'application Firebase supplémentaire. Notez que dans tous les exemples ci-dessous, nous utilisons la chaîne secondary. Ce nom est utilisé pour récupérer l'instance d'application et la distinguer des autres instances, y compris l'instance par défaut (nommée [DEFAULT]). Vous devez choisir une chaîne appropriée à l'utilisation prévue de l'autre projet Firebase.

Les extraits suivants montrent comment se connecter à une autre Realtime Database (les API pour les autres fonctionnalités Firebase suivent le même modèle).

Swift

// Configure an alternative FIRApp.
FirebaseApp.configure(name: "secondary", options: secondaryOptions)

// Retrieve a previous created named app.
guard let secondary = FirebaseApp.app(name: "secondary")
  else { fatalError("Could not retrieve secondary app") }


// Retrieve a Real Time Database client configured against a specific app.
let secondaryDb = Database.database(app: secondary)
AppDelegate.swift

Kotlin

// Initialize secondary FirebaseApp.
Firebase.initialize(context = this, options, "secondary")

// Retrieve secondary FirebaseApp.
val secondary = Firebase.app("secondary")
// Get the database for the other app.
val secondaryDatabase = Firebase.database(secondary)
MainActivity.kt

Java

// Initialize with secondary app
FirebaseApp.initializeApp(this /* Context */, options, "secondary");

// Retrieve secondary FirebaseApp
FirebaseApp secondary = FirebaseApp.getInstance("secondary");
MainActivity.java

sur le Web

// Initialize another app with a different config
const secondaryApp = firebase.initializeApp(secondaryAppConfig, "secondary");
// Access services, such as the Realtime Database
// secondaryApp.database();
firebaseapp.js

C++

firebase::App* secondary_app = firebase::App::Create(secondary_app_options, "Secondary");
firebase::database::Database* secondary_database = firebase::database::Database::GetInstance(secondary_app);

Unity

var secondaryApp = Firebase.FirebaseApp.Create(secondaryAppOptions, "Secondary"));
var secondaryDatabase = Firebase.Database.FirebaseDatabase.getInstance(secondaryApp);

Node.js

// Initialize another app with a different config
const secondary = initializeApp(secondaryAppConfig, 'secondary');
// Access services, such as the Realtime Database
// const secondaryDatabase = secondary.database();
index.js

Java

// Initialize another app with a different config
FirebaseApp secondaryApp = FirebaseApp.initializeApp(secondaryAppConfig, "secondary");

// Retrieve the database.
FirebaseDatabase secondaryDatabase = FirebaseDatabase.getInstance(secondaryApp);

Remarque : Sur les plates-formes Android et Apple, les données Analytics ne sont enregistrées que pour l’application par défaut.

Garantir des rapports fiables pour Analytics

Google Analytics collecte des événements très tôt dans le flux de démarrage de l'application, dans certains cas avant que l'instance d'application Firebase principale n'ait été configurée. Dans ce cas, Firebase fait référence à la ressource Android ou à GoogleService-Info.plist sur les plates-formes Apple pour rechercher l'ID d'application Google correct afin de stocker les événements. C'est pourquoi nous vous recommandons d'utiliser les méthodes de configuration par défaut dans la mesure du possible.

Si une configuration au moment de l'exécution est requise, veuillez noter les mises en garde suivantes :

1. Si vous utilisez AdMob et que vous demandez des annonces au démarrage comme recommandé, vous risquez de manquer certaines données Analytics liées aux annonces mobiles si vous n'utilisez pas l'approche de configuration basée sur les ressources.
2. Ne fournissez qu'un seul ID d'application Google dans chaque variante distribuée de votre application. Par exemple, si vous distribuez la version 1 de votre application avec un certain GOOGLE_APP_ID dans la configuration, puis que vous importez la version 2 avec un ID différent, cela peut entraîner la suppression des données Analytics.
3. Sur les plates-formes Apple, n'ajoutez pas GoogleService-Info.plist à votre projet si vous fournissez une configuration différente au moment de l'exécution, car cela peut entraîner une modification apparente de GOOGLE_APP_ID et une perte de données Analytics.