Ajouter Firebase à votre projet C++

Améliorez vos jeux C++ avec nos SDK Firebase C++, qui fournissent une interface C++ au-dessus des SDK Firebase.

Accédez entièrement à Firebase à partir de votre code C++, sans avoir à écrire de code natif de la plate-forme. Le SDK Firebase traduit également de nombreux idiomes propres à la langue utilisés par Firebase en une interface plus familière aux développeurs C++.

Pour en savoir plus sur l'optimisation de vos jeux avec Firebase, consultez la page des jeux Firebase.

Avez-vous déjà ajouté Firebase à votre projet C++ ? Assurez-vous d'utiliser la dernière version du SDK C++ Firebase.


Prérequis

  • Installez l'IDE ou l'éditeur de votre choix, comme Android Studio, IntelliJ ou VS Code.

  • Obtenez le SDK Android.

  • Assurez-vous que votre projet répond aux exigences suivantes:

    • Cible le niveau d'API 21 (Lollipop) ou version ultérieure

    • Utilise Gradle et est configuré avec CMake

  • Configurez un appareil physique ou utilisez un émulateur pour exécuter votre application.

    • Les émulateurs doivent utiliser une image d'émulateur avec Google Play.

    • Pour certaines bibliothèques C++, les services Google Play sont requis sur l'appareil client. Consultez la liste sur cette page.

  • Connectez-vous à Firebase avec votre compte Google.

Étape 2: Créer un projet Firebase

Avant de pouvoir ajouter Firebase à votre projet C++, vous devez créer un projet Firebase pour vous y connecter. Consultez Comprendre les projets Firebase pour en savoir plus sur les projets Firebase.

Étape 3: Enregistrez votre application auprès de Firebase

Pour utiliser Firebase dans votre application Android, vous devez enregistrer votre application auprès de votre projet Firebase. L'enregistrement de votre application est souvent appelé "ajout" de votre application à votre projet.

  1. Accédez à la console Firebase.

  2. Au centre de la page de présentation du projet, cliquez sur l'icône Android () ou sur Ajouter une application pour lancer le processus de configuration.

  3. Saisissez le nom du package de votre application dans le champ Nom du package Android.

  4. (Facultatif) Saisissez d'autres informations sur l'application : Pseudo de l'application et Certificat de signature de débogage SHA-1.

  5. Cliquez sur Enregistrer l'application.

Étape 4: Ajoutez le fichier de configuration Firebase

  1. Cliquez sur Télécharger google-services.json pour obtenir votre fichier de configuration Firebase Android.

  2. Ouvrez votre projet C++ dans un IDE, puis ajoutez votre fichier de configuration à votre projet:

  3. (Compilations Gradle uniquement) Pour activer les services Firebase dans votre projet C++, ajoutez le plug-in google-services à votre fichier build.gradle de niveau supérieur.

    1. Ajoutez des règles pour inclure le plug-in Gradle des services Google. Vérifiez également que vous disposez du dépôt Maven de Google.

        buildscript {

    repositories {
      // Check that you have the following line (if not, add it):
      google()  // Google's Maven repository
    }

    dependencies {
      // ...

      // Add the following lines:
      classpath 'com.google.gms:google-services:4.4.2'  // Google Services plugin
      implementation 'com.google.android.gms:18.5.0'
    }
  }

  allprojects {
    // ...

    repositories {
      // Check that you have the following line (if not, add it):
      google()  // Google's Maven repository
      // ...
    }
  }

    2. Appliquez le plug-in Gradle des services Google:

        apply plugin: 'com.android.application'
  // Add the following line:
  apply plugin: 'com.google.gms.google-services'  // Google Services plugin

  android {
    // ...
  }

  4. Vous avez terminé les tâches de configuration dans la console Firebase. Passez à la section Ajouter les SDK Firebase C++ ci-dessous.

Étape 5: Ajouter les SDK Firebase C++

Les étapes de cette section sont un exemple d'ajout de produits Firebase compatibles à votre projet Firebase C++.

  1. Téléchargez le SDK C++ Firebase, puis décompressez-le dans un emplacement pratique.

    Le SDK C++ Firebase n'est pas spécifique à la plate-forme, mais il contient des bibliothèques spécifiques à la plate-forme.

  2. Dans le fichier gradle.properties de votre projet, spécifiez l'emplacement du SDK décompressé:

    systemProp.firebase_cpp_sdk.dir=full-path-to-SDK

  3. Ajoutez le contenu suivant au fichier settings.gradle de votre projet:

    def firebase_cpp_sdk_dir = System.getProperty('firebase_cpp_sdk.dir')

gradle.ext.firebase_cpp_sdk_dir = "$firebase_cpp_sdk_dir"
includeBuild "$firebase_cpp_sdk_dir"

  4. Ajoutez le contenu suivant à votre fichier Gradle (généralement app/build.gradle) de votre module (au niveau de l'application).
    Incluez les dépendances de bibliothèque pour les produits Firebase que vous souhaitez utiliser dans votre application.

    Analytics activé 

    android.defaultConfig.externalNativeBuild.cmake {
arguments "-DFIREBASE_CPP_SDK_DIR=$gradle.firebase_cpp_sdk_dir"
}

# Add the dependencies for the Firebase products you want to use in your app
# For example, to use Analytics, Firebase Authentication, and Firebase Realtime Database
apply from: "$gradle.firebase_cpp_sdk_dir/Android/firebase_dependencies.gradle"
firebaseCpp.dependencies {
  analytics
  auth
  database
}

    Analytics non activé 

    android.defaultConfig.externalNativeBuild.cmake {
arguments "-DFIREBASE_CPP_SDK_DIR=$gradle.firebase_cpp_sdk_dir"
}

# Add the dependencies for the Firebase products you want to use in your app
# For example, to use Firebase Authentication and Firebase Realtime Database
apply from: "$gradle.firebase_cpp_sdk_dir/Android/firebase_dependencies.gradle"
firebaseCpp.dependencies {
  auth
  database
}

  5. Ajoutez le contenu suivant au fichier CMakeLists.txt de votre projet.
    Incluez les bibliothèques pour les produits Firebase que vous souhaitez utiliser dans votre application.

    Analytics activé 

    # Add Firebase libraries to the target using the function from the SDK.
add_subdirectory(${FIREBASE_CPP_SDK_DIR} bin/ EXCLUDE_FROM_ALL)

# The Firebase C++ library `firebase_app` is required,
# and it must always be listed last.

# Add the Firebase SDKs for the products you want to use in your app
# For example, to use Analytics, Firebase Authentication, and Firebase Realtime Database
set(firebase_libs
  firebase_analytics
  firebase_auth
  firebase_database
  firebase_app
)
target_link_libraries(${target_name} "${firebase_libs}")

    Analytics non activé 

    # Add Firebase libraries to the target using the function from the SDK.
add_subdirectory(${FIREBASE_CPP_SDK_DIR} bin/ EXCLUDE_FROM_ALL)

# The Firebase C++ library `firebase_app` is required,
# and it must always be listed last.

# Add the Firebase SDKs for the products you want to use in your app
# For example, to use Firebase Authentication and Firebase Realtime Database
set(firebase_libs
  firebase_auth
  firebase_database
  firebase_app
)
target_link_libraries(${target_name} "${firebase_libs}")

  6. Synchronisez votre application pour vous assurer que toutes les dépendances disposent des versions nécessaires.

  7. Si vous avez ajouté Analytics, exécutez votre application pour envoyer à Firebase la confirmation que vous avez bien intégré Firebase. Sinon, vous pouvez ignorer l'étape de validation.

    Les journaux de votre appareil afficheront la validation Firebase indiquant que l'initialisation est terminée. Si vous avez exécuté votre application sur un émulateur disposant d'un accès réseau, la console Firebase vous informe que la connexion de votre application est terminée.

Vous avez terminé ! Votre application C++ est enregistrée et configurée pour utiliser les services Firebase.

Bibliothèques disponibles

Pour en savoir plus sur les bibliothèques Firebase C++, consultez la documentation de référence et la version de notre SDK Open Source sur GitHub.

Bibliothèques disponibles pour Android (à l'aide de CMake)

Notez que les bibliothèques C++ pour les plates-formes Apple sont listées sur la version de cette page de configuration pour les plates-formes Apple (iOS+).

Produit Firebase Références de bibliothèque
(firebaseCpp.dependencies
pour le fichier build.gradle)		 Références de bibliothèque
(firebase_libs
pour le fichier CMakeLists.txt)
AdMob admob firebase_admob
(obligatoire) firebase_analytics
(obligatoire) firebase_app
Analytics analytics firebase_analytics
(obligatoire) firebase_app
App Check appCheck firebase_app_check
(obligatoire) firebase_app
Authentication auth firebase_auth
(obligatoire) firebase_app
Cloud Firestore firestore firebase_firestore
(obligatoire) firebase_auth
(obligatoire) firebase_app
Cloud Functions functions firebase_functions
(obligatoire) firebase_app
Cloud Messaging messaging firebase_messaging
(recommandé) firebase_analytics
(obligatoire) firebase_app
Cloud Storage storage firebase_storage
(obligatoire) firebase_app
Dynamic Links dynamicLinks firebase_dynamic_links
(recommandé) firebase_analytics
(obligatoire) firebase_app
Realtime Database database firebase_database
(obligatoire) firebase_app
Remote Config remoteConfig firebase_remote_config
(recommandé) firebase_analytics
(obligatoire) firebase_app

Informations supplémentaires pour la configuration sur mobile

Obtenir des rapports de plantage du NDK

Firebase Crashlytics est compatible avec les rapports d'erreur pour les applications qui utilisent des bibliothèques natives Android. Pour en savoir plus, consultez la section Obtenir des rapports d'erreur du NDK Android.

Systèmes de compilation personnalisés

Firebase fournit le script generate_xml_from_google_services_json.py pour convertir google-services.json en ressources .xml que vous pouvez inclure dans votre projet. Ce script applique la même transformation que le plug-in Gradle des services Google Play lors de la création d'applications Android.

Si vous ne compilez pas avec Gradle (par exemple, si vous utilisez ndk-build, des fichiers de compilation, Visual Studio, etc.), vous pouvez utiliser ce script pour automatiser la génération de ressources de chaîne Android.

ProGuard

De nombreux systèmes de compilation Android utilisent ProGuard pour les builds en mode Release afin de réduire la taille des applications et de protéger le code source Java.

Si vous utilisez ProGuard, vous devez ajouter les fichiers dans libs/android/*.pro correspondant aux bibliothèques C++ Firebase que vous utilisez dans votre configuration ProGuard.

Par exemple, avec Gradle, si vous utilisez Google Analytics, votre fichier build.gradle se présente comme suit:

android {
  // ...
  buildTypes {
    release {
      minifyEnabled true
      proguardFile getDefaultProguardFile('your-project-proguard-config.txt')
      proguardFile file(project.ext.your_local_firebase_sdk_dir + "/libs/android/app.pro")
      proguardFile file(project.ext.your_local_firebase_sdk_dir + "/libs/android/analytics.pro")
      // ...  and so on, for each Firebase C++ library that you're using
    }
  }
}

Exigences concernant les services Google Play

La plupart des bibliothèques Firebase C++ nécessitent que les services Google Play soient installés sur l'appareil Android du client. Si une bibliothèque C++ Firebase renvoie kInitResultFailedMissingDependency à l'initialisation, cela signifie que les services Google Play ne sont pas disponibles sur l'appareil client (ce qui signifie qu'ils doivent être mis à jour, réactivés, que les autorisations doivent être corrigées, etc.). La bibliothèque Firebase ne peut pas être utilisée tant que la situation sur l'appareil client n'est pas corrigée.

Vous pouvez découvrir pourquoi les services Google Play ne sont pas disponibles sur l'appareil client (et essayer de résoudre le problème) à l'aide des fonctions de google_play_services/availability.h.

Le tableau suivant indique si les services Google Play sont requis sur un appareil client pour chaque produit Firebase compatible.

Bibliothèque Firebase C++ Services Google Play requis sur l'appareil client ?
AdMob Non obligatoire (généralement)
Analytics Non obligatoire
Authentication Requis
Cloud Firestore Obligatoire
Cloud Functions Obligatoire
Cloud Messaging Obligatoire
Cloud Storage Obligatoire
Dynamic Links Obligatoire
Realtime Database Obligatoire
Remote Config Obligatoire

AdMob et services Google Play

La plupart des versions du SDK Google Mobile Ads pour Android peuvent fonctionner correctement sans les services Google Play sur l'appareil client. Toutefois, si vous utilisez la dépendance com.google.android.gms:play-services-ads-lite au lieu de la dépendance com.google.firebase:firebase-ads standard indiquée ci-dessus, les services Google Play sont obligatoires.

L'initialisation de AdMob ne renvoie kInitResultFailedMissingDependency que lorsque les deux conditions suivantes sont remplies:

  • Les services Google Play ne sont pas disponibles sur l'appareil client.
  • Vous utilisez com.google.android.gms:play-services-ads-lite.

Configurer un workflow pour ordinateur (bêta)

Lorsque vous créez un jeu, il est souvent beaucoup plus facile de le tester d'abord sur les plates-formes de bureau, puis de le déployer et de le tester sur des appareils mobiles plus tard dans le développement. Pour prendre en charge ce workflow, nous fournissons un sous-ensemble des SDK C++ Firebase pouvant s'exécuter sur Windows, macOS, Linux et depuis l'éditeur C++.

  1. Pour les workflows sur ordinateur, vous devez effectuer les opérations suivantes:

    1. Configurez votre projet C++ pour CMake.
    2. Créer un projet Firebase
    3. Enregistrer votre application (iOS ou Android) auprès de Firebase
    4. Ajouter un fichier de configuration Firebase pour une plate-forme mobile

  2. Créez une version pour ordinateur du fichier de configuration Firebase:

    • Si vous avez ajouté le fichier google-services.json Android : lorsque vous exécutez votre application, Firebase recherche ce fichier mobile, puis génère automatiquement un fichier de configuration Firebase pour ordinateur (google-services-desktop.json).

    • Si vous avez ajouté le fichier GoogleService-Info.plist iOS : avant d'exécuter votre application, vous devez convertir ce fichier mobile en fichier de configuration Firebase pour ordinateur. Pour convertir le fichier, exécutez la commande suivante à partir du même répertoire que votre fichier GoogleService-Info.plist:

      generate_xml_from_google_services_json.py --plist -i GoogleService-Info.plist

    Ce fichier de configuration pour ordinateur de bureau contient l'ID de projet C++ que vous avez saisi dans le workflow de configuration de la console Firebase. Consultez Comprendre les projets Firebase pour en savoir plus sur les fichiers de configuration.

  3. Ajoutez les SDK Firebase à votre projet C++.

    Les étapes ci-dessous vous montrent comment ajouter un produit Firebase compatible à votre projet C++. Dans cet exemple, nous allons voir comment ajouter Firebase Authentication et Firebase Realtime Database.

    1. Définissez votre variable d'environnement FIREBASE_CPP_SDK_DIR sur l'emplacement du SDK C++ Firebase décompressé.

    2. Ajoutez le contenu suivant au fichier CMakeLists.txt de votre projet, y compris les bibliothèques pour les produits Firebase que vous souhaitez utiliser. Par exemple, pour utiliser Firebase Authentication et Firebase Realtime Database:

      # Add Firebase libraries to the target using the function from the SDK.
add_subdirectory(${FIREBASE_CPP_SDK_DIR} bin/ EXCLUDE_FROM_ALL)

# The Firebase C++ library `firebase_app` is required,
# and it must always be listed last.

# Add the Firebase SDKs for the products you want to use in your app
# For example, to use Firebase Authentication and Firebase Realtime Database
set(firebase_libs firebase_auth firebase_database firebase_app)
target_link_libraries(${target_name} "${firebase_libs}")

  4. Exécutez votre application C++.

Bibliothèques disponibles (ordinateur)

Le SDK C++ Firebase inclut la compatibilité avec les workflows de bureau pour un sous-ensemble de fonctionnalités, ce qui permet d'utiliser certaines parties de Firebase dans des builds de bureau autonomes sous Windows, macOS et Linux.

Produit Firebase Références de bibliothèque (à l'aide de CMake)
App Check firebase_app_check
(obligatoire) firebase_app
Authentication firebase_auth
(obligatoire) firebase_app
Cloud Firestore firebase_firestore
firebase_auth
firebase_app
Cloud Functions firebase_functions
(obligatoire) firebase_app
Cloud Storage firebase_storage
(obligatoire) firebase_app
Realtime Database firebase_database
(obligatoire) firebase_app
Remote Config firebase_remote_config
(obligatoire) firebase_app

Firebase fournit les autres bibliothèques pour ordinateur de bureau en tant qu'implémentations de bouchon (non fonctionnelles) pour plus de commodité lors de la compilation pour Windows, macOS et Linux. Par conséquent, vous n'avez pas besoin de compiler le code de manière conditionnelle pour cibler le bureau.

Ordinateur Realtime Database

Le SDK Realtime Database pour ordinateur utilise REST pour accéder à votre base de données. Vous devez donc déclarer les index que vous utilisez avec Query::OrderByChild() sur ordinateur, sinon vos écouteurs échoueront.

Informations supplémentaires pour la configuration sur ordinateur

Bibliothèques Windows

Pour Windows, les versions de bibliothèque sont fournies en fonction des éléments suivants:

  • Plate-forme de compilation: mode 32 bits (x86) ou 64 bits (x64)
  • Environnement d'exécution Windows: multithreading / MT par rapport aux DLL multithread /MD
  • Cible: version ou débogage

Notez que les bibliothèques suivantes ont été testées avec Visual Studio 2015 et 2017.

Lorsque vous créez des applications de bureau C++ sous Windows, associez les bibliothèques du SDK Windows suivantes à votre projet. Pour en savoir plus, consultez la documentation de votre compilateur.

Bibliothèque Firebase C++ Dépendances des bibliothèques du SDK Windows
App Check advapi32, ws2_32, crypt32
Authentication advapi32, ws2_32, crypt32
Cloud Firestore advapi32, ws2_32, crypt32, rpcrt4, ole32, shell32
Cloud Functions advapi32, ws2_32, crypt32, rpcrt4, ole32
Cloud Storage advapi32, ws2_32, crypt32
Realtime Database advapi32, ws2_32, crypt32, iphlpapi, psapi, userenv
Remote Config advapi32, ws2_32, crypt32, rpcrt4, ole32

Bibliothèques macOS

Pour macOS (Darwin), des versions de bibliothèques sont fournies pour la plate-forme 64 bits (x86_64). Des frameworks sont également fournis pour plus de commodité.

Notez que les bibliothèques macOS ont été testées à l'aide de Xcode 13.3.1.

Lorsque vous créez des applications de bureau C++ sur macOS, associez les éléments suivants à votre projet:

  • Bibliothèque système pthread
  • CoreFoundation Framework système macOS
  • Foundation Framework système macOS
  • Security Framework système macOS
  • GSS Framework système macOS
  • Kerberos Framework système macOS
  • SystemConfiguration Framework système macOS

Pour en savoir plus, consultez la documentation de votre compilateur.

Bibliothèques Linux

Pour Linux, des versions de bibliothèques sont fournies pour les plates-formes 32 bits (i386) et 64 bits (x86_64).

Notez que les bibliothèques Linux ont été testées à l'aide de GCC 4.8.0, GCC 7.2.0 et Clang 5.0 sur Ubuntu.

Lorsque vous créez des applications de bureau C++ sur Linux, associez la bibliothèque système pthread à votre projet. Pour en savoir plus, consultez la documentation de votre compilateur. Si vous compilez avec GCC 5 ou une version ultérieure, définissez -D_GLIBCXX_USE_CXX11_ABI=0.

Étapes suivantes