Добавьте Firebase в свой проект C++

Расширьте возможности своих игр на C++ с помощью наших SDK Firebase C++, которые предоставляют интерфейс C++ поверх SDK Firebase.

Получите полный доступ к Firebase из своего кода на C++, без необходимости писать какой-либо платформенно-ориентированный код. SDK Firebase также переводит многие специфические для языка идиомы, используемые Firebase, в интерфейс, более привычный для разработчиков на C++.

Более подробную информацию о том, как расширить возможности ваших игр с помощью Firebase, вы найдете на нашей странице, посвященной играм Firebase .

Уже добавили Firebase в свой проект на C++? Убедитесь, что используете последнюю версию Firebase C++ SDK .


Предварительные требования

  • Установите предпочитаемый вами редактор или IDE, например Android Studio, IntelliJ или VS Code.

  • Получите Android SDK .

  • Убедитесь, что ваш проект соответствует следующим требованиям:

  • Для запуска приложения подключите физическое устройство или используйте эмулятор.

    • Эмуляторы должны использовать образ эмулятора с Google Play.

    • Для некоторых библиотек C++ на клиентском устройстве требуются сервисы Google Play; ознакомьтесь со списком на этой странице.

  • Войдите в Firebase, используя свою учетную запись Google.

Шаг 2 : Создайте проект Firebase.

Прежде чем добавить Firebase в свой проект C++, необходимо создать проект Firebase для подключения к вашему проекту C++. Подробнее о проектах Firebase можно узнать в разделе «Понимание проектов Firebase».

Шаг 3 : Зарегистрируйте свое приложение в Firebase.

Чтобы использовать Firebase в своем Android-приложении, вам необходимо зарегистрировать его в своем проекте Firebase. Регистрация приложения часто называется «добавлением» приложения в проект.

  1. Перейдите в консоль Firebase .

  2. В центре страницы обзора проекта нажмите на значок Android ( ) или «Добавить приложение» , чтобы запустить процесс настройки.

  3. Введите имя пакета вашего приложения в поле «Имя пакета Android» .

  4. (Необязательно) Введите псевдоним приложения — внутренний, удобный идентификатор, видимый только вам в консоли Firebase .

  5. Нажмите «Зарегистрировать приложение» .

Шаг 4 : Добавьте файл конфигурации Firebase.

  1. Нажмите «Скачать google-services.json» , чтобы получить файл конфигурации Firebase для Android.

  2. Откройте свой проект на C++ в IDE, затем добавьте файл конфигурации в свой проект:

  3. (Только для сборки Gradle) Чтобы включить сервисы Firebase в вашем проекте C++, добавьте плагин google-services в главный файл build.gradle .

    1. Добавьте правила для включения плагина Google Services Gradle. Также убедитесь, что у вас есть репозиторий Maven от 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.4'  // Google Services plugin
      implementation 'com.google.android.gms:18.9.0'
    }
  }

  allprojects {
    // ...

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

    2. Примените плагин Google Services Gradle:

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

  android {
    // ...
  }

  4. Настройка задач в консоли Firebase завершена. Перейдите к разделу «Добавление SDK Firebase C++» ниже.

Шаг 5 : Добавьте SDK Firebase C++

Описанные в этом разделе шаги представляют собой пример того, как добавить поддерживаемые продукты Firebase в ваш проект Firebase C++.

  1. Загрузите Firebase C++ SDK , затем распакуйте его в удобное для вас место.

    SDK Firebase C++ не является платформенно-зависимым, но содержит платформенно-специфичные библиотеки.

  2. В файле gradle.properties вашего проекта укажите расположение распакованного SDK:

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

  3. В файл settings.gradle вашего проекта добавьте следующее содержимое:

    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. В файл Gradle вашего модуля (уровня приложения) (обычно app/build.gradle ) добавьте следующее содержимое.
    Добавьте зависимости библиотек для продуктов Firebase, которые вы хотите использовать в своем приложении.

    Analytics включена 

    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 отключена 

    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. В файл CMakeLists.txt вашего проекта добавьте следующее содержимое.
    Включите библиотеки для продуктов Firebase, которые вы хотите использовать в своем приложении.

    Analytics включена 

    # 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 отключена 

    # 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. Синхронизируйте приложение, чтобы убедиться, что все зависимости имеют необходимые версии.

  7. Если вы добавили Analytics , запустите приложение, чтобы отправить в Firebase подтверждение успешной интеграции. В противном случае, этап подтверждения можно пропустить.

    В журналах вашего устройства отобразится подтверждение Firebase о завершении инициализации. Если вы запускали приложение на эмуляторе с доступом к сети, консоль Firebase уведомит вас о завершении подключения приложения.

Всё готово! Ваше приложение на C++ зарегистрировано и настроено для использования сервисов Firebase.

Доступные библиотеки

Узнайте больше о библиотеках Firebase для C++ в справочной документации и в нашем SDK с открытым исходным кодом на GitHub .

Доступные библиотеки для Android (с использованием CMake)

Обратите внимание, что библиотеки C++ для платформ Apple перечислены в версии этой страницы настроек для платформ Apple (iOS+) .

Продукт Firebase Библиотечные ссылки
( firebaseCpp.dependencies
(для файла build.gradle )		 Библиотечные ссылки
( firebase_libs
(для файла CMakeLists.txt )
AdMob admob firebase_admob
(обязательно) firebase_analytics
(обязательно) firebase_app
Analytics analytics firebase_analytics
(обязательно) firebase_app
App Check appCheck firebase_app_check
(обязательно) firebase_app
Authentication auth firebase_auth
(обязательно) firebase_app
Cloud Firestore firestore firebase_firestore
(обязательно) firebase_auth
(обязательно) firebase_app
Cloud Functions functions firebase_functions
(обязательно) firebase_app
Cloud Messaging messaging firebase_messaging
(рекомендуется) firebase_analytics
(обязательно) firebase_app
Cloud Storage storage firebase_storage
(обязательно) firebase_app
Dynamic Links dynamicLinks firebase_dynamic_links
(рекомендуется) firebase_analytics
(обязательно) firebase_app
Realtime Database database firebase_database
(обязательно) firebase_app
Remote Config remoteConfig firebase_remote_config
(рекомендуется) firebase_analytics
(обязательно) firebase_app

Дополнительная информация по настройке мобильного устройства.

Получайте отчеты о сбоях NDK.

Firebase Crashlytics поддерживает отправку отчетов о сбоях для приложений, использующих нативные библиотеки Android. Для получения дополнительной информации см. раздел «Получение отчетов о сбоях Android NDK» .

Системы, созданные по индивидуальному заказу

Firebase предоставляет скрипт generate_xml_from_google_services_json.py для преобразования файла google-services.json в ресурсы .xml , которые можно включить в ваш проект. Этот скрипт применяет то же преобразование, что и плагин Gradle для сервисов Google Play при сборке приложений Android.

Если вы не используете Gradle для сборки (например, ndk-build, makefiles, Visual Studio и т. д.), вы можете использовать этот скрипт для автоматизации генерации строковых ресурсов Android .

ПроГард

Многие системы сборки Android используют ProGuard для сборки в режиме Release, чтобы уменьшить размер приложений и защитить исходный код Java.

Если вы используете ProGuard, вам потребуется добавить в конфигурацию ProGuard файлы из libs/android/*.pro , соответствующие используемым вами библиотекам Firebase C++.

Например, если вы используете Google Analytics в Gradle, ваш файл build.gradle будет выглядеть следующим образом: 

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

Требования к сервисам Google Play

Большинство библиотек Firebase C++ требуют наличия сервисов Google Play на Android-устройстве клиента. Если библиотека Firebase C++ возвращает kInitResultFailedMissingDependency при инициализации, это означает, что сервисы Google Play недоступны на устройстве клиента (то есть их необходимо обновить, повторно активировать, исправить разрешения и т. д.). Библиотека Firebase не может быть использована, пока ситуация на устройстве клиента не будет исправлена.

Вы можете выяснить, почему сервисы Google Play недоступны на устройстве клиента (и попытаться это исправить), используя функции из файла google_play_services/availability.h .

В таблице ниже указано, требуется ли наличие сервисов Google Play на клиентском устройстве для каждого поддерживаемого продукта Firebase.

Библиотека Firebase на C++ Требуются ли сервисы Google Play на клиентском устройстве?
AdMob Не требуется (обычно)
Analytics Не требуется
Authentication Необходимый
Cloud Firestore Необходимый
Cloud Functions Необходимый
Cloud Messaging Необходимый
Cloud Storage Необходимый
Dynamic Links Необходимый
Realtime Database Необходимый
Remote Config Необходимый

Сервисы AdMob и Google Play

Большинство версий Google Mobile Ads SDK для Android могут корректно работать без сервисов Google Play на клиентском устройстве. Однако, если вы используете зависимость com.google.android.gms:play-services-ads-lite вместо стандартной зависимости com.google.firebase:firebase-ads указанной выше, требуются сервисы Google Play .

При инициализации AdMob kInitResultFailedMissingDependency вернет значение только в том случае, если выполняются оба следующих условия:

  • Сервисы Google Play недоступны на клиентском устройстве.
  • Вы используете com.google.android.gms:play-services-ads-lite .

Настройка рабочего процесса на рабочем столе ( бета-версия )

При создании игры зачастую гораздо проще сначала протестировать её на настольных платформах, а затем развернуть и протестировать на мобильных устройствах на более поздних этапах разработки. Для поддержки этого рабочего процесса мы предоставляем подмножество SDK Firebase C++ , которые могут работать на Windows, macOS, Linux и из редактора C++.

  1. Для рабочих процессов на настольных компьютерах необходимо выполнить следующие действия:

    1. Настройте свой проект C++ для работы с CMake.
    2. Создайте проект Firebase.
    3. Зарегистрируйте свое приложение (iOS или Android) в Firebase.
    4. Добавьте файл конфигурации Firebase для мобильной платформы.

  2. Создайте настольную версию файла конфигурации Firebase:

    • Если вы добавили файл google-services.json для Android , то при запуске приложения Firebase найдет этот мобильный файл и автоматически сгенерирует файл конфигурации Firebase для настольных компьютеров ( google-services-desktop.json ).

    • Если вы добавили файл GoogleService-Info.plist для iOS , перед запуском приложения необходимо преобразовать этот мобильный файл в файл конфигурации Firebase для настольных компьютеров . Для преобразования файла выполните следующую команду из той же директории, что и файл GoogleService-Info.plist : 

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

    Этот конфигурационный файл для настольных компьютеров содержит идентификатор проекта C++, который вы указали в процессе настройки консоли Firebase . Подробнее о конфигурационных файлах можно узнать в разделе «Понимание проектов Firebase» .

  3. Добавьте SDK Firebase в свой проект на C++.

    Приведенные ниже шаги служат примером того, как добавить любой поддерживаемый продукт Firebase в ваш проект C++. В этом примере мы рассмотрим добавление Firebase Authentication и Firebase Realtime Database .

    1. Установите переменную среды FIREBASE_CPP_SDK_DIR на путь к распакованному Firebase C++ SDK.

    2. В файл CMakeLists.txt вашего проекта добавьте следующее содержимое, включая библиотеки для продуктов Firebase, которые вы хотите использовать. Например, чтобы использовать Firebase Authentication и 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. Запустите ваше приложение на C++.

Доступные библиотеки (для настольных компьютеров)

В состав Firebase C++ SDK входит поддержка рабочих процессов для настольных приложений, позволяющая использовать определенные части Firebase в автономных сборках для настольных приложений под управлением Windows, macOS и Linux.

Продукт Firebase Ссылки на библиотеки (с использованием CMake)
App Check firebase_app_check
(обязательно) firebase_app
Authentication firebase_auth
(обязательно) firebase_app
Cloud Firestore firebase_firestore
firebase_auth
firebase_app
Cloud Functions firebase_functions
(обязательно) firebase_app
Cloud Storage firebase_storage
(обязательно) firebase_app
Realtime Database firebase_database
(обязательно) firebase_app
Remote Config firebase_remote_config
(обязательно) firebase_app

Firebase предоставляет оставшиеся библиотеки для настольных приложений в виде заглушек (нефункциональных) для удобства сборки под Windows, macOS и Linux. Таким образом, вам не нужно выполнять условную компиляцию кода для целевой платформы настольных приложений.

Настольная версия Realtime Database

SDK Realtime Database для настольных компьютеров использует REST для доступа к вашей базе данных, поэтому вам необходимо объявить индексы, которые вы используете с Query::OrderByChild() на настольной версии, иначе ваши обработчики событий будут работать некорректно.

Дополнительная информация по настройке рабочего стола

библиотеки Windows

Для Windows версии библиотек предоставляются на основе следующих критериев:

  • Платформа сборки: 32-битный (x86) и 64-битный (x64) режимы
  • Среда выполнения Windows: Многопоточность / MT против многопоточной DLL / MD
  • Цель: Релиз против отладки

Обратите внимание, что следующие библиотеки были протестированы с использованием Visual Studio 2015 и 2017.

При разработке настольных приложений на C++ для Windows необходимо подключить к проекту следующие библиотеки Windows SDK. Для получения дополнительной информации обратитесь к документации вашего компилятора.

Библиотека Firebase на C++ Зависимости библиотеки Windows SDK
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

библиотеки macOS

Для macOS (Darwin) предоставляются версии библиотек для 64-битной платформы (x86_64). Для вашего удобства также предоставляются фреймворки.

Обратите внимание, что библиотеки macOS были протестированы с использованием Xcode 16.2.

При разработке настольных приложений на C++ для macOS, подключите к своему проекту следующие компоненты:

  • библиотека системы pthread
  • Системная платформа CoreFoundation для macOS
  • Foundation системной структуры macOS
  • Системная структура Security macOS
  • Системная структура GSS macOS
  • Системная структура Kerberos для macOS
  • SystemConfiguration macOS

Для получения более подробной информации обратитесь к документации вашего компилятора.

библиотеки Linux

Для Linux доступны версии библиотеки для 32-битных (i386) и 64-битных (x86_64) платформ.

Обратите внимание, что тестирование библиотек Linux проводилось с использованием GCC 4.8.0, GCC 7.2.0 и Clang 5.0 на Ubuntu.

При сборке настольных приложений на C++ под Linux необходимо подключить системную библиотеку pthread к вашему проекту. Для получения дополнительной информации обратитесь к документации вашего компилятора. Если вы используете GCC 5 или более позднюю версию, укажите параметр -D_GLIBCXX_USE_CXX11_ABI=0 .

Следующие шаги