Firebase Apple 开源开发

本仓库包含除 FirebaseAnalytics 外所有 Apple 平台 Firebase SDK 的源代码。

Firebase 是一个应用开发平台，提供工具帮助你构建、发展和变现你的应用。关于 Firebase 的更多信息可以在官方 Firebase 网站上找到。

安装

请参阅以下小节了解不同安装方法的详细信息。在可用的情况下，建议安装带有 Swift 后缀的库，以获得在 Swift 中编写应用程序时的最佳体验。

标准 pod 安装
Swift 包管理器
从 GitHub 仓库安装
实验性 Carthage

标准 pod 安装

有关标准 pod 安装的说明，请访问： https://firebase.google.com/docs/ios/setup。

Swift 包管理器

有关 Swift 包管理器支持的说明可以在 SwiftPackageManager.md Markdown 文件中找到。

从 GitHub 安装

这些说明可用于访问 Firebase 仓库的其他分支、标签或提交。

背景

有关覆盖 pod 源位置的说明和选项，请参阅 Podfile 语法参考。

访问 Firebase 源快照

所有官方版本都在此仓库中标记并可通过 CocoaPods 获得。要访问本地源快照或未发布的分支，请使用如下 Podfile 指令：

要通过分支访问 FirebaseFirestore：

pod 'FirebaseCore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :branch => 'main'
pod 'FirebaseFirestore', :git => 'https://github.com/firebase/firebase-ios-sdk.git', :branch => 'main'

要通过已检出版本的 firebase-ios-sdk 仓库访问 FirebaseMessaging：

pod 'FirebaseCore', :path => '/path/to/firebase-ios-sdk'
pod 'FirebaseMessaging', :path => '/path/to/firebase-ios-sdk'

Carthage（仅限 iOS）

有关实验性 Carthage 分发的说明可以在 Carthage.md 中找到。

在框架或库中使用 Firebase

有关在框架或库中使用 Firebase 的详细信息，请参阅 firebase_in_libraries.md。

开发

要在此仓库中开发 Firebase 软件，请确保你至少具有以下软件：

Xcode 15.2（或更高版本）

CocoaPods 仍然是规范的开发方式，但现在仓库的大部分内容都支持使用 Swift 包管理器进行开发。

CocoaPods

安装以下内容：

CocoaPods 1.12.0（或更高版本）
CocoaPods generate

对于你想开发的 pod：

pod gen Firebase{name here}.podspec --local-sources=./ --auto-open --platforms=ios

注意：如果 CocoaPods 缓存过期，你可能需要在 pod gen 命令之前运行 pod repo update。

注意：将 --platforms 选项设置为 macos 或 tvos 以进行这些平台的开发/测试。自 10.2 版本以来，Xcode 无法正确处理多平台 CocoaPods 工作区。

Firestore 有一个独立的 Xcode 项目。请参阅 Firestore/README Markdown 文件。

Catalyst 开发

pod gen {name here}.podspec --local-sources=./ --auto-open --platforms=ios
在 App-iOS 构建设置中选中 Mac 复选框
在设置签名和功能选项卡中签署应用程序
在项目管理器中点击 Pods
为 iOS 主应用程序和单元测试目标添加签名
选择 Unit-unit 方案
运行以构建和测试

或者，禁用每个目标的签名：

转到构建设置选项卡
点击 +
选择 添加用户定义设置
添加 CODE_SIGNING_REQUIRED 设置，值为 NO

Swift 包管理器

要启用测试方案：./scripts/setup_spm_tests.sh
open Package.swift 或在 Finder 中双击 Package.swift。
Xcode 将打开项目
- 选择要构建的库的方案或要运行的测试套件
- 通过选择运行目标以及方案来选择目标平台

添加新的 Firebase Pod

有关详细信息，请参阅 AddNewPod Markdown 文件。

管理头文件和导入

有关管理头文件和导入的信息，请参阅 HeadersImports Markdown 文件。

代码格式化

为确保代码格式一致，在创建拉取请求（PR）之前，请运行脚本 ./scripts/check.sh。

GitHub Actions 将验证任何代码更改是否以符合样式的方式完成。安装 clang-format 和 mint：

brew install clang-format@18
brew install mint

运行单元测试

选择一个方案并按 Command-u 键构建组件并运行其单元测试。

运行示例应用程序

要运行示例应用程序和集成测试，你需要一个有效的 GoogleService-Info.plist 文件。Firebase Xcode 项目包含没有真实值的虚拟 plist 文件，但可以用真实的 plist 文件替换它们。要获取你自己的 GoogleService-Info.plist 文件：

前往 Firebase 控制台
如果你还没有，请创建一个新的 Firebase 项目
对于你想测试的每个示例应用程序，使用示例应用程序的包标识符（例如，com.google.Database-Example）创建一个新的 Firebase 应用程序
下载生成的 GoogleService-Info.plist 并将其添加到 Xcode 项目中。

生成覆盖率报告

有关覆盖率报告生成说明，请参阅 scripts/code_coverage_report/README Markdown 文件。

特定组件说明

请参阅下面的章节了解这些组件的任何特殊说明。

Firebase Auth

对于特定的 Firebase Auth 开发，请参阅 Auth Sample README 了解有关构建和运行 FirebaseAuth pod 以及各种示例和测试的说明。

Firebase Database

Firebase Database 集成测试可以针对本地运行的 Database 模拟器或生产实例运行。

要针对本地模拟器实例运行，请在运行集成测试之前调用 ./scripts/run_database_emulator.sh start。要在生产实例上运行，请提供有效的 GoogleServices-Info.plist 并将其复制到 FirebaseDatabase/Tests/Resources/GoogleService-Info.plist。在运行测试时，您的安全规则必须设置为公开。

Firebase 动态链接

Firebase 动态链接已弃用，不应在新项目中使用。该服务将于 2025 年 8 月 25 日关闭。

请查看我们的动态链接弃用常见问题文档以获取更多指导。

Firebase 性能监控

对于特定的 Firebase 性能监控开发，请参阅性能 README了解构建 SDK 的说明，以及性能测试应用 README了解将性能集成到开发测试应用的说明。

Firebase 存储

要运行存储集成测试，请按照StorageIntegration.swift中的说明进行操作。

推送通知

推送通知只能发送到开发者门户中特别配置的应用 ID。要测试接收推送通知，您需要：

将示例应用的包标识符更改为您在 Apple 开发者账户中拥有的标识符，并为该应用 ID 启用推送通知。
您还需要将 APNs 提供商身份验证密钥或证书上传到 Firebase 控制台，位置在项目设置 > 云消息传递 > [您的 Firebase 应用]。
确保您的 iOS 设备已添加到 Apple 开发者门户中作为测试设备。

iOS 模拟器

iOS 模拟器无法注册远程通知，也无法接收推送通知。要接收推送通知，请按照上述步骤操作，并在物理设备上运行应用。

Firebase 的 Vertex AI

有关构建和测试 SDK 的说明，请参阅 Vertex AI for Firebase README。

在 Apple 平台上构建 Firebase

Firebase 为 macOS、Catalyst 和 tvOS 提供官方测试支持。visionOS 和 watchOS 由社区支持。感谢社区贡献的许多多平台 PR。

目前，Firebase 的大多数产品都可在 Apple 平台上使用。在 visionOS 和 watchOS 上仍有一些差距。有关当前支持矩阵的详细信息，请参阅 Firebase 文档中的此图表。

visionOS

在支持的情况下，visionOS 可按预期工作，但通过 Swift Package Manager 使用 Firestore 时除外，在这种情况下需要使用源代码分发。

要启用 Firestore 源代码分发，请退出 Xcode 并使用 FIREBASE_SOURCE_FIRESTORE 环境变量从命令行打开所需的项目：open --env FIREBASE_SOURCE_FIRESTORE /path/to/project.xcodeproj。要返回使用 Firestore 的二进制分发，请退出 Xcode 并像平常一样打开 Xcode，不使用环境变量。