FirebaseFirestore 11.0.0

FirebaseFirestore 11.0.0

×

许可证 Apache-2.0
发布日期最新版本2024 年 7 月

由Google 维护。

 
依赖项
FirebaseCore~> 11.0
FirebaseCoreExtension~> 11.0
FirebaseFirestoreInternal= 11.0.0
FirebaseSharedSwift~> 11.0
 

FirebaseFirestore 11.0.0

  • 由
  • Google, Inc.


Firebase Apple 开源开发

此仓库包含所有 Apple 平台 Firebase SDK 源代码，除了 FirebaseAnalytics。

Firebase 是一个应用开发平台，提供了帮助您构建、增长和盈利应用程序的工具。有关 Firebase 的更多信息，请访问官方 Firebase 网站。

安装

请参阅下面的子部分以获取有关不同安装方法的具体信息。如果可用，建议安装任何带有 Swift 后缀的库，以获得在 Swift 中编写应用程序时最佳体验。

  1. 标准 pod install
  2. Swift 包管理器
  3. 从 GitHub 仓库安装
  4. 实验性 Carthage

标准的 pod 安装

前往 https://firebase.google.com/docs/ios/setup。

Swift 包管理器

关于 Swift 包管理器支持的说明和选项，请参阅 Swift Package Manager 文档 中的 SwiftPackageManager 文件。

从 GitHub 安装

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

背景

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

访问 Firebase 源快照

所有官方版本都已在此存储库中标记，并通过 CocoaPods 提供。要访问本地源快照或未发布的分支，请使用以下 Podfile 指令：

通过分支访问 Firestore

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

通过检查 out firebase-ios-sdk 存储库的版本来访问 FirebaseMessaging

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

Carthage （仅限 iOS）

关于实验性 Carthage 分发的说明请参阅 Carthage。

通过框架或库使用 Firebase

通过框架或库使用 Firebase

开发

要在此存储库中开发 Firebase 软件，请确保您至少有如下软件：

  • Xcode 14.1（或更高版本）

CocoaPods 仍然是官方的开发方式，但现在存储库支持使用 Swift Package Manager 进行许多开发。

CocoaPods

安装

您要开发的库

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 {名称} --local-sources=./ --auto-open --platforms=ios
  • 在 App-iOS 建筑设置中勾选 Mac 选项
  • 在设置签名和功能选项卡中为 App 签名
  • 在项目管理器中点击 Pods
  • 将签名添加到 iOS 主应用和单元测试目标中
  • 选择单元单元方案
  • 运行以构建和测试

或者禁用每个目标的签名

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

Swift 包管理器

  • 要启用测试方案：./scripts/setup_spm_tests.sh
  • 在 Finder 中打开 Package.swift 或双击 Package.swift
  • Xcode 将打开项目
    • 选择要构建或测试的库方案
    • 选择目标平台，选择运行目标与方案一起

添加新的 Firebase Pod

请参阅 AddNewPod Markdown 文件。

管理头文件和导入

请参阅 HeadersImports Markdown 文件。

代码格式化

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

GitHub Actions 将验证任何代码更改是否以符合风格的方式进行。安装 clang-format 和 mint

brew install clang-format@16
brew install mint

运行单元测试

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

运行示例应用

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

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

代码覆盖率报告生成

查看 scripts/code_coverage_report/README Markdown文件。

特定组件说明

有关任何特定组件的特殊说明，请查阅下面的部分。

Firebase身份验证

如果您正在进行特定Firebase身份验证开发，请参阅 身份验证样本README 以获取有关构建和运行FirebaseAuth pod以及各种样本和测试的说明。

Firebase 数据库

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

要针对本地模拟器实例运行，在运行集成测试之前，调用 ./scripts/run_database_emulator.sh start。

要针对生产实例运行，提供有效的 GoogleServices-Info.plist 并将其复制到 FirebaseDatabase/Tests/Resources/GoogleService-Info.plist。在测试运行期间，您必须将安全规则设置为 公共。

Firebase 性能监控

如果您正在进行特定的 Firebase 性能监控开发，请参阅 性能 README 了解构建 SDK 的说明，以及 性能 TestApp README 了解如何将性能与开发测试应用集成的说明。

Firebase 存储服务器

要运行存储集成测试，请遵循StorageIntegration.swift中的说明。

推送通知

推送通知只能发送到开发者门户网站中特别配置的应用程序标识符。为了真正测试接收推送通知，您将需要

  1. 将示例应用的捆绑标识符更改为您在苹果开发者账户中拥有的内容，并启用该应用ID用于推送通知。
  2. 您还需要将您的APNs提供程序身份验证密钥或证书上传到Firebase控制台，具体操作方式为：在项目设置 > 云消息 > [您的Firebase应用]。
  3. 请确保您的iOS设备已被添加到苹果开发者门户中作为测试设备。

使用iOS模拟器

iOS模拟器不能为远程通知进行注册，因此不会接收到推送通知。为了接收推送通知，您需要按照上面的步骤操作并在真实设备上运行应用程序。

在苹果平台上构建Firebase

Firebase 8.9.0引入了对macOS、Catalyst和tvOS的官方Beta支持。watchOS将继续由社区支持。感谢社区在多个跨平台PR中的贡献。

目前，Firebase的大部分产品已在苹果平台上可用。仍有一些差距，尤其是在watchOS上。有关当前支持矩阵的详细信息，请参阅Firebase文档中的此图表：此图表。

watchOS

感谢社区的贡献，Firebase许多SDK现在已在watchOS上编译、运行单元测试并正常运行。查看独立的Watch App示例。

请注意，Firebase并没有官方支持watchOS。虽然我们可以通过GitHub Actions捕捉基本的单元测试问题，但在SDK中可能存在一些更改，导致其在watchOS上不再按预期运行。如果您遇到这种情况，请提交一个问题。

在控制台设置应用期间，您可能会遇到一个提及类似于“检查应用是否与我们的服务器通信”的步骤。这依赖于分析功能，在 watchOS 上将无法工作。您可以安全地忽略此消息并继续操作，其他 SDK 将按预期工作。

额外的 Crashlytics 说明

  • watchOS 支持有限。由于 watchOS 的限制，无法记录 mach 异常和信号崩溃。（在 SwiftUI 中的崩溃会被生成为 mach 异常，因此也不会被记录）

Combine

感谢社区的贡献，FirebaseCombineSwift 包含了 Apple 的 Combine 框架支持。此模块目前正在开发中，尚不支持在生产环境中使用。更多详情请参阅相关文档。

路线图

有关 Firebase Apple SDK 开源计划和方向的更多信息，请参见路线图。

贡献指南

有关向 Firebase Apple SDK 贡献的更多信息，请参见贡献指南。

协议

本存储库的内容遵守Apache许可证，版本2.0。

您对Firebase的使用受Firebase服务的服务条款约束。