Firebase C++ 开源开发

本仓库包含 Firebase C++ SDK 源代码，支持 Android、iOS 和桌面平台。它包括以下 Firebase 库：


Google Analytics for Firebase
Firebase 身份验证	Firebase 实时数据库
Firebase 动态链接	Cloud Firestore
Cloud Functions for Firebase	Firebase 邀请
Firebase 云消息传递	Firebase 远程配置
Cloud Storage for Firebase

<br>

Firebase 是一个应用开发平台，提供工具帮助你构建、增长和变现你的应用。关于 Firebase 的更多信息可以在这里找到。

关于 Firebase C++ SDK 的更多信息可以在这里找到
如何使用 Firebase C++ SDK 的示例可以在这里找到

<br>

入门

你可以使用以下命令克隆仓库：

git clone https://github.com/firebase/firebase-cpp-sdk.git

以下先决条件适用于所有平台。请确保根据需要将任何目录添加到你的 PATH 中。

CMake，3.7 版本或更新版本
Python，3.7 版本或更新版本
Abseil-py

注意：安装 Python 后，你可以使用以下命令安装所需的包：

python3 -m ensurepip --default-pip
python3 -m pip install --user absl-py

桌面平台的先决条件

在为桌面平台构建库时，需要以下先决条件。

OpenSSL，用于实时数据库和 Cloud Firestore

Windows 的先决条件

可以通过谷歌搜索找到 OpenSSL 的预构建包，如果 CMake 无法找到安装路径，请使用命令行选项 -DOPENSSL_ROOT_DIR=[Open SSL Dir]。

Mac 的先决条件

可以使用 Homebrew 安装所需的依赖项：

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
source $HOME/.rvm/scripts/rvm
brew install cmake python3
sudo chown -R $(whoami) /usr/local

Android 的先决条件

在为 Android 构建库时，需要以下先决条件。

Android SDK、Android NDK 和用于 Android 的 CMake（推荐 3.10.2 版本）
- 在这里下载 sdkmanager（独立或作为 Android Studio 的一部分）
- 按照这些说明安装必要的构建工具
（仅限 Windows）Strings（来自 Microsoft Sysinternals）

重要 - Strings EULA
在构建过程中使用 Strings 之前，你需要先从命令行运行一次 Strings 以接受 EULA。

注意，我们包含了 Gradle 包装器，如果使用它，将为你获取必要版本的 Gradle。

iOS/tvOS 的先决条件

在为 iOS 或 tvOS 构建库时，需要以下先决条件。

Cocoapods

</details> <details><summary><h2>构建</h2></summary>

使用 CMake 构建

构建使用 CMake 生成必要的构建文件，并支持源外构建。以下 CMake 目标可用于构建和链接：

功能	CMake 目标
App（基础库）	firebase_app
Google Analytics for Firebase	firebase_analytics
Firebase 身份验证	firebase_auth
Firebase 实时数据库	firebase_database
Firebase 动态链接	firebase_dynamic_links
Cloud Firestore	firebase_firestore
Cloud Functions for Firebase	firebase_functions
Firebase 邀请	firebase_invites
Firebase 云消息传递	firebase_messaging
Firebase 远程配置	firebase_remote_config
Cloud Storage for Firebase	firebase_storage

例如，要构建 Analytics 库，你可以运行以下命令：

mkdir desktop_build && cd desktop_build
cmake ..
cmake --build . --target firebase_analytics

请注意，你可以在配置步骤中提供不同的生成器，例如，要为 Visual Studio 2017 生成项目，你可以运行：

cmake -G "Visual Studio 15 2017" ..

有关生成器的更多信息，请访问 https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html。

默认情况下，在构建 SDK 时，CMake 过程会下载构建所需的任何第三方依赖项。这个逻辑在 cmake/external_rules.cmake 中，以及随附的 cmake/external/CMakeLists.txt 中。如果你想为这些依赖项提供自己的目录，可以覆盖 [[dependency_name]]_SOURCE_DIR 和 [[dependency_name]]_BINARY_DIR。如果未提供二进制目录，它将默认为给定的源目录，并附加 -build。

例如，要提供自定义的 flatbuffer 目录，你可以运行：

cmake -DFLATBUFFERS_SOURCE_DIR=/tmp/flatbuffers ..

二进制目录将自动设置为 /tmp/flatbuffers-build。

目前，可以通过这种方式提供的第三方库有：

库
CURL
FLATBUFFERS
LIBUV
NANOPB
UWEBSOCKETS
ZLIB

使用 CMake 为 iOS 构建

Firebase C++ SDK 附带了一个 CMake 配置文件，用于为 iOS 平台构建库，cmake/toolchains/ios.cmake。要使用它构建，在运行 CMake 配置时，通过 CMAKE_TOOLCHAIN_FILE 定义传入它。例如，要为 iOS 构建 Auth 库，你可以运行以下命令：

mkdir ios_build && cd ios_build
cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/toolchains/ios.cmake ..
cmake --build . --target firebase_auth

使用 CMake 为 tvOS 构建

Firebase C++ SDK 附带了一个 CMake 配置文件，用于为 tvOS 平台构建库，cmake/toolchains/apple.toolchain.cmake。要使用它构建，在运行 CMake 配置时，通过 CMAKE_TOOLCHAIN_FILE 定义传入它。例如，要为 tvOS 构建 Auth 库，你可以运行以下命令：

mkdir tvos_build && cd tvos_build
cmake -DCMAKE_TOOLCHAIN_FILE=../cmake/toolchains/apple.toolchain.cmake -DPLATFORM=TVOS ..
cmake --build . --target firebase_auth

为 iOS 和 tvOS 构建 XCFrameworks

Firebase C++ SDK 附带了一个辅助 Python 脚本，用于构建同时适用于 iOS 和 tvOS 的 XCFrameworks。这很有帮助，因为我们可以在同一个 Xcode 项目中为 iOS 和 tvOS 目标使用相同的交付物。

# 安装先决条件(如 cocoapods)
./build_scripts/tvos/install_prereqs.sh
python3 scripts/gha/build_ios_tvos.py -s . -b ios_tvos_build

使用 Gradle 构建 Android 版本

在为 Android 构建 Firebase C++ SDK 时,使用 gradle 和 CMake 相结合来生成库文件。每个 Firebase 功能都是根目录下的一个独立 gradle 子项目。构建每个 Firebase 库的发布版本的 gradle 目标如下:

功能	Gradle 目标
App (基础库)	:app:assembleRelease
Google Analytics for Firebase	:analytics:assembleRelease
Firebase Authentication	:auth:assembleRelease
Firebase Realtime Database	:database:assembleRelease
Firebase Dynamic Links	:dynamic_links:assembleRelease
Cloud Firestore	:firestore:assembleRelease
Cloud Functions for Firebase	:functions:assembleRelease
Firebase Invites	:invites:assembleRelease
Firebase Cloud Messaging	:messaging:assembleRelease
Firebase Remote Config	:remote_config:assembleRelease
Cloud Storage for Firebase	:storage:assembleRelease

例如,要构建 Analytics 库的发布版本,你可以在根目录下运行以下命令:

./gradlew :analytics:assembleRelease

Proguard 文件生成

请注意,作为构建过程的一部分,每个库都会生成一个应该包含在你的应用程序中的 proguard 文件。生成的文件位于每个库的构建目录中。例如,Analytics 的 proguard 文件会生成到 analytics/build/analytics.pro。

测试

此仓库中的每个 Firebase SDK 都包含一系列单元测试。这些测试由 CI 系统构建和执行,以验证更改和拉取请求。

提供的 test_windows_x32.bat、test_windows_x64.bat、test_linux.sh 和 test_mac_x64.sh 脚本分别在 Windows32、Windows64、Linux 和 MacOS 主机上通过 ctest 构建 SDK 并执行单元测试。这些脚本位于仓库的基目录中。

已知问题

Mac
- 执行测试时,系统可能会要求你解锁 Mac OS 钥匙串。请输入你的钥匙串密码并选择始终允许。如果你仍然遇到重复的访问请求对话框,则必须手动解锁钥匙串,否则某些测试将失败。
  - 在 Mac 上打开钥匙串访问应用程序。
  - 在钥匙串(左上角)下选择登录钥匙串。
  - 在类别下选择密码作为类别(左下角),找到条目 not_a_real_project_id.{hashcode}。右键点击它。
  - 选择显示简介,选择访问控制并启用允许所有应用程序访问此项目单选按钮。
  - 重新运行测试。