SwiftDataSugar 🌯

.package(url: "https://github.com/mesqueeb/SwiftDataSugar", from: "0.1.0")

一个实用工具集合，旨在简化在 SwiftUI 环境中使用 SwiftData 的操作。

• DbCollection 是一个 Actor，专为在后台线程对 SwiftData 进行 CRUD 操作而设计（避免了阻止 UI 响应的陷阱）。
• DbQuery 是一个 SwiftUI 视图，它使用 @Query，但使其更容易与动态谓词/排序方式一起使用。
• MigrationStep 是一个协议，用于组织你的迁移逻辑，以便进行迁移测试。
• initModelContainer 封装了 ModelContainer 的初始化，以便更轻松地编写迁移单元测试。

渲染后的文档可以在这里找到：swiftpackageindex.com/mesqueeb/SwiftDataSugar/documentation

一个关于如何在所有 Apple 平台上通过 SwiftData 实现 CRUD 的参考示例。

此概念验证的特点

1. 写入操作使用后台线程（使用 @ModelActor 宏）。
2. 读取操作使用 MainActor 线程（使用 SwiftUI 的 @Query 宏）。
3. 包含单元测试的迁移设置。
4. 完整的跨平台支持。

• 将数据写入 SwiftData 模型是在后台线程中完成的。
• 一个符合 ModelActor 的 actor 已被设置为具有类似 CRUD 的方法，可以轻松地将数据写入模型。
• 这个 actor 被称为 DbCollection。
• 必须在 @MainActor 上实例化 DbCollection，以防止在 SwiftUI 中写入数据时没有反应的问题。（请参阅 A New Issue: The View Does Not Refresh After Data Update 中的详细解释，我已向 Fatbobman 报告此问题，并促使他撰写了一篇文章）。
• DbCollection 可以用于多个模型。
• 在这个应用程序中，DbCollection 的用法展示了一个 Todo 模型。

// example instantiating multiple collections in the `@main` swift file
@MainActor public let dbTodos = DbCollection<TodoItem>(modelContainer: modelContainer)
@MainActor public let dbUsers = DbCollection<User>(modelContainer: modelContainer)

• 从 SwiftData 模型读取数据是在 MainActor 线程中完成的。
• SwiftUI 的 @Query 可用于需要查询数据而没有动态要求的简单视图。
• @Query 的用法被封装在一个名为 DbQuery 的新视图中，你可以在其中传递动态 *predicate* 和 *sortBy* 实例来查询数据。
• 在这个应用程序中，DbQuery 的用法展示了一个可以动态过滤和排序的列表。

DbQuery(predicate: activePredicate, sortBy: activeSort) { items in
  ForEach(items, id: \.id) { item in
    TodoListItemView(item: item)
      .id(item.id) // Use ID for List reordering and animations
    }
  }
}

• SwiftData 中的自定义迁移很难正确实现，这个应用程序展示了包含 3 个版本和 2 个迁移的自定义迁移。
• 最新的 schema 具有所有结构体和模型类型别名，以便在整个代码库中更易于使用。
• 只有对迁移至关重要的数据才被限定在版本化的 schema 内部，其他有用的方法和方便的初始化程序仅在最新的 schema 上扩展。
• 实际的迁移逻辑按版本整齐地组织：它将升级到相关版本的逻辑与该版本的 schema 捆绑在同一文件中。
• 最终组合的迁移计划组合了每个版本的每个迁移步骤。
• 每个迁移阶段都进行了完整的单元测试（使用现代 Swift Testing），以确保最新的迁移不会在启动时崩溃用户的应用程序。
• 单元测试展示了 *如何* 在 SwiftData 中测试迁移。

• 此概念验证中使用的所有代码都与所有 Apple 平台兼容。