FirebaseMLModelDownloader 11.0.0-beta

FirebaseMLModelDownloader 11.0.0-beta

Google维护。



 
依赖项
FirebaseCore~> 11.0
FirebaseCoreExtension~> 11.0
FirebaseInstallations~> 11.0
GoogleDataTransport~> 10.0
GoogleUtilities/UserDefaults~> 8.0
SwiftProtobuf~> 1.19
 


Firebase Apple Open Source Development

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

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

安装

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

  1. 标准pod安装
  2. Swift Package Manager
  3. 从GitHub仓库安装
  4. 实验性Carthage

标准pod安装

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

Swift Package Manager

关于支持 Swift Package Manager 的说明可以在这个 Markdown 文件 SwiftPackageManager 中找到。

从 GitHub 安装

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

背景

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

访问 Firebase 源快照

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

要通过分支访问 Firebase 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选项设置为macostvos以针对这些平台进行开发/测试。从10.2开始,Xcode无法正确处理多平台CocoaPods工作区。

Firestore有一个自包含的Xcode项目。请参阅Firestore/README Markdown文件。

Catalyst 开发

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

或者为每个目标禁用签名

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

Swift Package Manager

  • 要启用测试方案:运行 ./scripts/setup_spm_tests.sh
  • 在 Finder 中打开 Package.swift 或双击 Package.swift
  • Xcode 将打开项目
    • 选择要构建或测试的库的方案
    • 通过选择运行目标并选择方案来选择目标平台

添加新的 Firebase Pods

参阅 AddNewPod Markdown 文件。

管理头文件和导入

参阅 HeadersImports Markdown 文件。

代码格式化

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

GitHub Actions 会验证代码更改是否符合风格规范。安装clang-formatmint

brew install clang-format@16
brew install mint

运行单元测试

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

运行示例应用

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

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

生成覆盖率报告

参见scripts/code_coverage_report/README 的 Markdown 文件。

特定组件说明

查看下面章节中针对这些组件的特殊说明。

Firebase Auth

如果您正在进行特定的Firebase Auth开发,请参阅Auth Sample README,了解有关构建和运行FirebaseAuth pod以及各种示例和测试的说明。

Firebase Database

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

要针对本地模拟器实例运行,在运行集成测试之前,调用./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. 将示例应用的包标识符更改为您在 Apple 开发者账户中拥有的标识符,并启用该 App ID 的推送通知。
  2. 您还需要把您的 APNs 提供商身份验证密钥或证书上传到 Firebase 控制台的“项目设置 > 云消息 > [您的 Firebase 应用]”
  3. 确保您的 iOS 设备已作为测试设备添加到您的 Apple 开发者门户。

在 iOS 模拟器中构建

iOS 模拟器无法注册远程通知,并且不会接收推送通知。为了接收推送通知,您必须遵循上述步骤并在物理设备上运行应用。

在 Apple 平台上使用 Firebase 构建

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

截至目前,Firebase的大多数产品都可在Apple平台上使用。仍有少量差距,尤其在watchOS上。关于当前支持的矩阵详情,请参阅Firebase文档中的此图表

watchOS

得益于社区的贡献,许多Firebase SDKs现在可以编译、运行单元测试,并在watchOS上工作。请参阅独立手表应用示例

请注意,Firebase并未官方支持watchOS。虽然我们可以通过GitHub Actions捕获基本单元测试问题,但SDK在watchOS上的某些更改可能会导致其不再按预期工作。如果您遇到这种情况,请提交问题

在控制台中设置应用时,您可能会到达一个提及“检查应用是否与我们的服务器通信”的步骤。这依赖于分析功能,在watchOS上无法工作。

额外的Crashlytics说明

  • watchOS支持有限。由于watchOS限制,不会记录mach异常和信号崩溃。(SwiftUI中的崩溃被生成为mach异常,因此也不会被记录)

Combine

得益于社区的贡献,FirebaseCombineSwift 包含了支持Apple的Combine框架。此模块目前正在开发中,尚未支持用于生产环境。更多详情请参阅文档

路线图

请参阅路线图,了解Firebase Apple SDK开源计划及方向。

贡献

请参阅贡献,了解对Firebase Apple SDK做出贡献的相关信息。

许可证

本仓库的内容受Apache许可证版本2.0的许可。

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