文档数据

GitHub License GitHub Release

一个类似 SwiftData 的数据持久化库,将所有数据持久化到 Property List 文档中。

设置

首先,您需要使用 Swift Package Manager 将此库添加到您的项目中。打开您的 Xcode,前往 File > Add Package Dependencies... 然后,复制 https://github.com/Plan-V-Studio/DocumentData 到搜索栏,选择第一个库并配置您的更新方式。

如果您使用的是 Swift Package,请将以下代码添加到 Package.swift 文件中的 dependencies 中。

.package(url: "https://github.com/Plan-V-Studio", branch: "main")

快速开始

要使用 Document Data,您需要先创建您的数据模型。这是一个创建模型来存储用户数据的示例。

class UserData {
    var username: String
    var password: Data
    var universalID: UUID
}

然后,在类声明前添加 @PersistedModel 宏。

@PersistedModel
class UserData {
  // ...
}

@PersistedModel 宏将自动将此数据模型转换为持久化数据模型,并将 UserData.storage.plist 文件存储在您 App 的 /Container/Application Support/ 中。

提示

持久化文件的名称将自动使用其数据模型的名称,要自定义您的模型名称,请在发布页面下载文档。

文档

Document Data 使用 DocC 生成文档,您可以在 发布页面 下载编译后的文档。

声明

这是一个 Beta 软件,这意味着该库的任何特性和方法都未经系统测试。Plan-V Studio 对您使用此库造成的任何直接或间接损失概不负责。