Firebase Android 开源开发

本仓库包含除 Analytics 和 Auth 之外的所有 Android Firebase SDK 的源代码。

Firebase 是一个应用开发平台，提供各种工具帮助您构建、发展和变现您的应用。有关 Firebase 的更多信息，请访问 https://firebase.google.com。

目录

1. 入门
2. 测试
   1. 单元测试
   2. 集成测试
3. 混淆
   1. 通过反射使用的 API
   2. 面向开发者使用的 API
   3. 面向其他 Firebase SDK 使用的 API
4. 发布
   1. 依赖项
   2. 命令
5. 代码格式化
6. 贡献

入门

• 安装最新版本的 Android Studio（应为 3.0.1 或更高版本）
• 克隆仓库（git clone --recurse-submodules git@github.com:firebase/firebase-android-sdk.git）
  • 克隆仓库时，获取子模块很重要。如果您已经克隆了仓库但没有子模块，可以通过运行 git submodule update --init --recursive 来更新子模块。
• 使用 导入项目（Gradle、Eclipse ADT 等） 选项将 firebase-android-sdk gradle 项目导入 Android Studio。
• firebase-crashlytics-ndk 必须使用 NDK 21 构建。更多详情请参阅 firebase-crashlytics-ndk。

测试

Firebase Android 库采用 Android 测试金字塔 推荐的三种测试类型。根据特定项目的要求，可能会使用部分或全部这些测试来支持变更。

:警告: 使用 errorprone 运行测试

要使用 errorprone 运行，请在命令行中添加 withErrorProne，例如：

./gradlew :<firebase-project>:check withErrorProne。

单元测试

这些测试在本地计算机的 Java 虚拟机 (JVM) 上运行。在运行时，这些测试针对 android.jar 的修改版本执行，其中所有 final 修饰符都被移除。这使我们能够在所需位置沙箱化行为，并使用流行的模拟库。

可以通过在命令行运行以下命令来执行单元测试：

./gradlew :<firebase-project>:check

Firebase 的 Vertex AI

有关该项目特定的设置说明，请参阅 Vertex AI for Firebase 的 README。

集成测试

这些测试在硬件设备或模拟器上运行。这些测试可以访问 Instrumentation API，让您能够访问诸如 Android Context 等信息。在 Firebase 中，不同项目以不同的方式使用仪器测试。一些测试可能会测试设备功能，同时存根对后端的任何调用，而另一些测试可能会调用每晚构建的后端，以确保分布式 API 的兼容性。

除了 Espresso 之外，它们还用于测试具有 UI 组件的项目。

项目设置

在运行集成测试之前，您需要将 google-services.json 文件添加到检出的根目录。您可以使用包含 Android 应用的任何项目的 google-services.json，但您可能希望使用一个与您的任何生产数据分开的项目，因为我们的测试会写入随机数据。

如果您还没有合适的测试项目：

• 打开 Firebase 控制台
• 如果您还没有想要用于测试的项目，请创建一个。
• 向项目添加一个 Android 应用
• 为应用提供任何您喜欢的包名。
• 下载生成的 google-services.json 文件，并将其放在检出的根目录中。

在本地模拟器上运行集成测试

可以通过在命令行运行以下命令来执行集成测试：

./gradlew :<firebase-project>:connectedCheck

在 Firebase Test Lab 上运行集成测试

为了使其正常工作，你需要进行额外的设置：

• 需要在本地机器上安装 gcloud
• 需要将 gcloud 配置为启用了计费的项目
• 需要使用具有"Firebase Test Lab 管理员"角色的凭据来认证 gcloud

可以通过在命令行运行以下命令来执行集成测试：

./gradlew :<firebase-project>:deviceCheck

这将在每个项目配置的设备上执行测试，如果项目未配置任何设备，测试将在 model=panther,version=33,locale=en,orientation=portrait 上运行。

可以按以下方式配置项目：

firebaseTestLab {
  // 要获取可用设备列表，执行 `gcloud firebase test android models list`
  devices = [
    '<device1>',
    '<device2>',
  ]
}

注解

Firebase SDK 出于工具目的使用一些特殊注解。

@Keep

需要在应用运行时保留的 API 可以使用 @Keep 注解。@Keep 注解被 Android 的默认 ProGuard 配置认可。这个注解的常见用途是因为反射。这些 API 通常应该被discouraged，因为它们不能被混淆。

@KeepForSdk

intended 供 Firebase SDK 使用的 API 应该用 @KeepForSdk 注解。这里的主要好处是，如果开发者从非 Firebase 包中使用它，注解会在 Android Studio 中抛出 linter 错误，从而提供有价值的保护机制。

@PublicApi

我们使用 @PublicAPI 注解 intended 供开发者使用的 API。这个注解将被工具用来帮助确定下一个版本所需的版本升级（主版本、次版本、补丁版本）。

混淆

Firebase SDK 本身不进行混淆，但支持混淆。Firebase SDK 本身是混淆友好的，但 Firebase SDK 的依赖项可能不是。

混淆配置

除了 preguard.txt 之外，项目还在 proguard.txt 中声明了一组额外的混淆规则，这些规则在构建应用的混淆 APK 时会被遵守。这个文件通常包含在应用混淆阶段需要遵守的保留规则。

作为最佳实践，这些显式规则应该仅限于源代码在 firebase-android-sdk 代码库之外的库，使基于注解的方法不足够。注解产生的保留规则、preguard.txt 和 proguard.txt 的组合共同决定了在运行时保留的 API。

发布

Firebase 作为一个库集合发布，每个库要么代表一个顶级产品，要么包含一个或多个项目使用的共享功能。这些项目作为托管的 Maven 工件发布，可在 Google 的 Maven 仓库获得。本节帮助理解开发者如何对 Firebase 项目进行更改，并让他们的应用依赖于修改后的 Firebase 版本。

依赖

项目内部或 Firebase 外部的任何依赖都被编码为 Maven 依赖，并包含在随发布工件一起的 pom 文件中。这允许开发者的构建系统（通常是 Gradle）构建依赖图，并使用自己的解析策略选择依赖。

命令

对于希望对项目进行更改但让传递依赖指向公开发布版本的更高级用例，可以按以下方式发布单个项目：

# 例如，发布 Firestore 和 Functions
./gradlew -PprojectsToPublish="firebase-firestore,firebase-functions" \
    publishReleasingLibrariesToMavenLocal

开发者可以通过在应用模块的 build.gradle 中的 repositories 块中添加 mavenLocal() 仓库来依赖这些本地发布的版本。

代码格式化

Java 和 Kotlin 都使用 spotless 进行格式化。 要对项目进行格式化，请运行

./gradlew :<firebase-project>:spotlessApply

贡献

我们欢迎贡献！请阅读我们的 贡献指南以开始。