Ajouter Firebase à votre projet C++

Améliorez vos jeux C++ avec nos SDK Firebase C++ qui fournissent une interface C++ au-dessus de Firebase pour iOS et pour Android.

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

Découvrez plus d'informations sur la mise sous tension de vos jeux avec Firebase sur notre page de jeux Firebase .

Vous avez déjà ajouté Firebase à votre projet C++ ? Assurez-vous que vous utilisez la dernière version du SDK Firebase C++ .

Conditions préalables

  • Installez votre éditeur ou IDE préféré, tel qu'Android Studio, IntelliJ ou VS Code.

  • Procurez-vous le SDK Android .

  • Assurez-vous que votre projet répond à ces exigences :

  • 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 à l'aide de 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 connecter à votre projet C++. 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 avec votre projet Firebase. L'enregistrement de votre application est souvent appelé "ajouter" 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 Ajouter une application pour lancer le workflow de configuration.

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

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

  5. Cliquez sur Enregistrer l'application .

Étape 4 : Ajouter 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. (Builds 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 plugin Google Services Gradle. Vérifiez que vous disposez également du référentiel 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.3.13'  // Google Services plugin
            implementation 'com.google.android.gms:18.1.0'
          }
        }
      
        allprojects {
          // ...
      
          repositories {
            // Check that you have the following line (if not, add it):
            google()  // Google's Maven repository
            // ...
          }
        }
      
    2. Appliquez le plug-in Google Services Gradle :

        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. Continuez vers Ajouter des SDK Firebase C++ ci-dessous.

Étape 5 : Ajouter des SDK Firebase C++

Les étapes de cette section sont un exemple de la façon d'ajouter des produits Firebase pris en charge à votre projet Firebase C++.

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

    Le SDK Firebase C++ 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. Au fichier settings.gradle de votre projet, ajoutez le contenu suivant :

    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. Dans le fichier Gradle de votre module (au niveau de l'application) (généralement app/build.gradle ), ajoutez le contenu suivant.
    Incluez les dépendances de bibliothèque pour les produits Firebase que vous souhaitez utiliser dans votre application.

    Analyse activée

    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
    }
    

    Analyse non activée

    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. Au fichier CMakeLists.txt de votre projet, ajoutez le contenu suivant.
    Incluez les bibliothèques des produits Firebase que vous souhaitez utiliser dans votre application.

    Analyse activée

    # 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}")
    

    Analyse non activée

    # 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 confirmer à Firebase que vous avez intégré Firebase avec succès. Sinon, vous pouvez ignorer l'étape de vérification.

    Les journaux de votre appareil afficheront la vérification Firebase 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 avertit que la connexion de votre application est terminée.

Vous êtes prêt ! Votre application C++ est enregistrée et configurée pour utiliser les services Firebase.

Bibliothèques disponibles

En savoir plus sur les bibliothèques C++ Firebase dans la documentation de référence et dans notre version SDK open source sur GitHub .

Bibliothèques disponibles pour Android (avec CMake)

Notez que les bibliothèques C++ pour iOS sont répertoriées dans la version iOS de cette page de configuration .

Produit Firebase Références de la bibliothèque
( firebaseCpp.dependencies
pour le fichier build.gradle )
Références de la bibliothèque
( firebase_libs
pour le fichier CMakeLists.txt )
AdMob admob firebase_admob
(obligatoire) firebase_analytics
(obligatoire) firebase_app
Analytique analytics firebase_analytics
(obligatoire) firebase_app
Authentification auth firebase_auth
(obligatoire) firebase_app
Cloud Firestore firestore firebase_firestore
(obligatoire) firebase_auth
(obligatoire) firebase_app
Fonctions cloud functions firebase_functions
(obligatoire) firebase_app
Messagerie en nuage messaging firebase_messaging
(recommandé) firebase_analytics
(obligatoire) firebase_app
Stockage en ligne storage firebase_storage
(obligatoire) firebase_app
Liens dynamiques dynamicLinks firebase_dynamic_links
(recommandé) firebase_analytics
(obligatoire) firebase_app
Base de données en temps réel database firebase_database
(obligatoire) firebase_app
Configuration à distance remoteConfig firebase_remote_config
(recommandé) firebase_analytics
(obligatoire) firebase_app

Informations supplémentaires pour la configuration mobile

Obtenir des rapports de plantage NDK

Firebase Crashlytics prend en charge les rapports de plantage pour les applications utilisant des bibliothèques natives Android. Pour en savoir plus, consultez Obtenir des rapports de plantage Android NDK .

Systèmes de construction 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 effectue lors de la création d'applications Android.

Si vous ne construisez pas à l'aide de Gradle (par exemple, vous utilisez ndk-build, makefiles, Visual Studio, etc.), vous pouvez utiliser ce script pour automatiser la génération d' Android String Resources .

ProGuard

De nombreux systèmes de build 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 devrez ajouter les fichiers dans libs/android/*.pro correspondant aux bibliothèques Firebase C++ que vous utilisez dans votre configuration ProGuard.

Par exemple, avec Gradle, si vous utilisez Google Analytics, votre fichier build.gradle ressemblera à :

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 relatives aux services Google Play

La plupart des bibliothèques Firebase C++ nécessitent que les services Google Play se trouvent sur l'appareil Android du client. Si une bibliothèque Firebase C++ renvoie kInitResultFailedMissingDependency lors de l'initialisation, cela signifie que les services Google Play ne sont pas disponibles sur l'appareil client (ce qui signifie qu'il doit être mis à jour, réactivé, les autorisations 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 savoir pourquoi les services Google Play ne sont pas disponibles sur l'appareil client (et essayer de le réparer) en utilisant les fonctions dans google_play_services/availability.h .

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

Bibliothèque C++ Firebase Services Google Play requis sur l'appareil client ?
AdMob Non requis (généralement)
Analytique Non requis
Authentification Obligatoire
Cloud Firestore Obligatoire
Fonctions cloud Obligatoire
Messagerie en nuage Obligatoire
Stockage en ligne Obligatoire
Liens dynamiques Obligatoire
Base de données en temps réel Obligatoire
Configuration à distance Obligatoire

Services AdMob et 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 standard com.google.firebase:firebase-ads répertoriée ci-dessus, les services Google Play sont requis .

L'initialisation d'AdMob renverra uniquement kInitResultFailedMissingDependency 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 flux de travail de bureau ( bêta )

Lorsque vous créez un jeu, il est souvent beaucoup plus facile de tester d'abord votre jeu sur des 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 flux de travail, nous fournissons un sous- ensemble des SDK Firebase C++ qui peuvent s'exécuter sur Windows, macOS, Linux et depuis l'éditeur C++.

  1. Pour les workflows de bureau, vous devez effectuer les opérations suivantes :

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

    • Si vous avez ajouté le fichier Android google-services.json — Lorsque vous exécutez votre application, Firebase localise ce fichier mobile , puis génère automatiquement un fichier de configuration Firebase de bureau ( google-services-desktop.json ).

    • Si vous avez ajouté le fichier iOS GoogleService-Info.plist - Avant d'exécuter votre application, vous devez convertir ce fichier mobile en un fichier de configuration Firebase de bureau . 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 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 des SDK Firebase à votre projet C++.

    Les étapes ci-dessous servent d'exemple pour ajouter n'importe quel produit Firebase pris en charge à votre projet C++. Dans cet exemple, nous expliquons comment ajouter Firebase Authentication et Firebase Realtime Database.

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

    2. Au fichier CMakeLists.txt de votre projet, ajoutez le contenu suivant, y compris les bibliothèques des 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 (bureau)

Le SDK Firebase C++ inclut la prise en charge du flux de travail de bureau pour un sous-ensemble de fonctionnalités, permettant à certaines parties de Firebase d'être utilisées dans des versions de bureau autonomes sous Windows, macOS et Linux.

Produit Firebase Références de bibliothèque (à l'aide de CMake)
Authentification firebase_auth
(obligatoire) firebase_app
Cloud Firestore firebase_firestore
firebase_auth
firebase_app
Fonctions cloud firebase_functions
(obligatoire) firebase_app
Stockage en ligne firebase_storage
(obligatoire) firebase_app
Base de données en temps réel firebase_database
(obligatoire) firebase_app
Configuration à distance firebase_remote_config
(obligatoire) firebase_app

Firebase fournit les bibliothèques de bureau restantes sous forme d'implémentations stub (non fonctionnelles) pour plus de commodité lors de la création pour Windows, macOS et Linux. Par conséquent, vous n'avez pas besoin de compiler conditionnellement du code pour cibler le bureau.

Bureau de base de données en temps réel

Le SDK de base de données en temps réel 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 ou vos écouteurs échoueront.

Informations supplémentaires pour la configuration du bureau

Bibliothèques Windows

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

  • Plate-forme de construction : mode 32 bits (x86) contre mode 64 bits (x64)
  • Environnement d'exécution Windows : multithread / MT vs multithread DLL / MD
  • Cible : Release vs Debug

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

Lors de la création d'applications de bureau C++ sur Windows, liez les bibliothèques SDK Windows suivantes à votre projet. Consultez la documentation de votre compilateur pour plus d'informations.

Bibliothèque C++ Firebase Dépendances de la bibliothèque du SDK Windows
Authentification advapi32, ws2_32, crypt32
Cloud Firestore advapi32, ws2_32, crypt32, rpcrt4, ole32, shell32
Fonctions cloud advapi32, ws2_32, crypt32, rpcrt4, ole32
Stockage en ligne advapi32, ws2_32, crypt32
Base de données en temps réel advapi32, ws2_32, crypt32, iphlpapi, psapi, userenv
Configuration à distance advapi32, ws2_32, crypt32, rpcrt4, ole32

bibliothèques macOS

Pour macOS (Darwin), les versions de bibliothèque sont fournies pour la plate-forme 64 bits (x86_64). Des cadres sont également fournis pour votre commodité.

Notez que les bibliothèques macOS ont été testées avec Xcode 13.3.1.

Lors de la création d'applications de bureau C++ sur macOS, liez les éléments suivants à votre projet :

  • bibliothèque système pthread
  • Cadre système CoreFoundation macOS
  • Framework du système macOS Foundation
  • Structure du système Security macOS
  • Cadre système GSS macOS
  • Structure du système Kerberos macOS
  • Structure du système macOS SystemConfiguration

Consultez la documentation de votre compilateur pour plus d'informations.

Bibliothèques Linux

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

Notez que les bibliothèques Linux ont été testées avec GCC 4.8.0, GCC 7.2.0 et Clang 5.0 sur Ubuntu.

Lors de la création d'applications de bureau C++ sur Linux, liez la bibliothèque système pthread à votre projet. Consultez la documentation de votre compilateur pour plus d'informations. Si vous construisez avec GCC 5 ou version ultérieure, définissez -D_GLIBCXX_USE_CXX11_ABI=0 .

Prochaines étapes