FirebaseAuth 11.0.0

FirebaseAuth 11.0.0

×

许可证 Apache-2.0
发布最新发布2024年7月

由Google维护。

 
依赖
FirebaseAuthInterop~> 11.0
FirebaseAppCheckInterop~> 11.0
FirebaseCore~> 11.0
FirebaseCoreExtension~> 11.0
GoogleUtilities/AppDelegateSwizzler~> 8.0
GoogleUtilities/Environment~> 8.0
GTMSessionFetcher/Core~> 3.4
RecaptchaInterop~> 100.0
 

FirebaseAuth 11.0.0


Firebase Apple 开源开发

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

Firebase是一个应用开发平台，提供了帮助您构建、增长和盈利应用的各种工具。有关Firebase的更多信息，可在官方Firebase网站上找到。

安装

以下子节详细介绍了不同安装方法。在可用的地方，建议安装任何带有Swift后缀的库，以便在用Swift编写应用时获得最佳体验。

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

标准的Pod安装

请访问 https://firebase.google.com/docs/ios/setup。

Swift 包管理器

有关对Swift包管理器支持的操作指南和选项，请查阅SwiftPackageManager Markdown文件。

从GitHub安装

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

背景

查看Podfile语法参考以获取有关覆盖pod源位置的说明和选项。

访问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'

通过检出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

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 复选框
  • 在设置中签名为 Signing & Capabilities 选项卡中的 App
  • 在项目 manage 中点击 Pods
  • 将签名添加到 iOS 宿主应用和单元测试目标中
  • 选择 Unit-unit 方案
  • 运行以构建和测试

或者在每个目标中禁用签名

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

Swift 包管理器

  • 要启用测试方案： ./scripts/setup_spm_tests.sh
  • 打开 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@16
brew install mint

运行单元测试

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

运行示例应用程序

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

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

覆盖率报告生成

请参阅scripts/code_coverage_report/README Markdown 文件。

特定组件说明

以下部分提供了针对这些组件的特殊说明。

Firebase Auth

如果您正在开发特定的 Firebase Auth，请参阅Auth 示例 README以获取有关构建和运行 FirebaseAuth 存储库以及各种示例和测试的说明。

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中的说明操作。

推送通知

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

  1. 将样本应用的 bundle identifier 更改为您在 Apple 开发者账户中拥有的某个标识符，并启用该应用 ID 以实现推送通知。
  2. 您还需要将您的 APNs 提供商身份验证密钥或证书上传到 Firebase 控制台中的[您的 Firebase 应用]，路径为 **项目设置 > 云消息 > [您的 Firebase App**]。
  3. 确保您的 iOS 设备已添加到您的 Apple 开发者门户中作为测试设备。

iOS 模拟器

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

在苹果平台上使用 Firebase 构建

Firebase 8.9.0 引入了针对 macOS、Catalyst 和 tvOS 的官方Beta支持。watchOS 继续得到社区支持。感谢社区贡献了许多多平台 PR。

目前，Firebase 的大多数产品在苹果平台上都可用。仍有一些空白区域，特别是在 watchOS 上。有关当前支持矩阵的详细信息，请参阅 Firebase 文档中的此图表。

watchOS

感谢社区贡献，许多 Firebase SDK now 编译、运行单元测试，并在 watchOS 上运行。请参阅独立手表 App 示例。

请注意，watchOS 不是 Firebase 的官方支持。虽然我们可以使用 GitHub Actions 捕获基本的单元测试问题，但可能存在一些更改，使得 SDK 在 watchOS 上不再按预期工作。如果您遇到这种情况，请提交一个 Issue。

在控制台中设置应用程序时，您可能会进入一个步骤，其中提到类似“检查应用程序是否已与我们的服务器通信”的内容。这依赖于 Analytics，在 watchOS 上无法工作。可以安全地忽略此消息并继续，其余 SDK 将按预期工作。

附加 Crashlytics 备注

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

Combine

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

路线图

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

贡献

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

许可协议

本仓库内容遵循Apache 许可协议，版本 2.0。

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