Spezi Firebase

Build and Test codecov DOI

将 Google Firebase 服务集成到您的 Spezi 应用程序中。

概述

此模块允许您使用 Google Firebase 平台作为托管后端,用于在使用 Spezi 框架 构建的应用程序中进行身份验证和数据存储。

我们目前实现了对身份验证、存储和 Firestore 服务的支持。

设置

您需要将 Spezi Firebase Swift 包添加到 Xcode 中的应用程序Swift 包

重要提示

如果您的应用程序尚未配置为使用 Spezi,请按照 Spezi 设置文章# 设置核心 Spezi 基础设施。

示例

以下部分将引导您完成为应用程序设置 Spezi Firebase 模块的必要步骤。

1. 设置您的 Firebase 帐户

要将您的应用程序连接到 Firebase 云平台,您首先需要在 firebase.google.com 上创建一个帐户,然后开始 注册新的 iOS 应用程序 的过程。

在 Firebase 中注册 Spezi 应用程序后,将生成的 GoogleService-Info.plist 配置文件放入 Xcode 项目的根目录。 您无需将 Firebase SDK 添加到您的应用程序或在您的应用程序中初始化 Firebase,因为 Spezi Firebase 模块将为您处理这些任务。

您还可以安装和运行 Firebase Local Emulator Suite 进行本地开发。为此,请按照 安装说明 进行操作。

2. 添加 Spezi Firebase 作为依赖项

首先,您需要将 SpeziFirebase Swift 包添加到 Xcode 中的应用程序Swift 包

3. 注册 Spezi Firebase 模块

在下面的示例中,我们配置 Spezi 应用程序以使用 Firebase Authentication,包括电子邮件和密码登录以及使用 Apple 登录,以及 Cloud Firestore 进行数据存储。

import Spezi
import SpeziAccount
import SpeziFirebaseAccount
import SpeziFirebaseStorage
import SpeziFirestore
import SwiftUI


class ExampleDelegate: SpeziAppDelegate {
    override var configuration: Configuration {
        Configuration {
            AccountConfiguration(configuration: [
                .requires(\.userId),
                .collects(\.name)
            ])
            Firestore()
            FirebaseAccountConfiguration[
                authenticationMethods: [.emailAndPassword, .signInWithApple]
            ]
        }
    }
}

有关更多信息,请参阅 API 文档

Spezi 模板应用程序

Spezi Firebase 模块已在 Spezi 模板应用程序 中预先配置,这是开始 Spezi 应用程序的好方法。

贡献

欢迎对此项目做出贡献。请务必先阅读 贡献指南贡献者盟约行为准则

许可证

此项目根据 MIT 许可证获得许可。有关更多信息,请参见 许可证

Spezi Footer Spezi Footer