SwiftData框架属性包装器@ModelContext

ModelContext 是 SwiftData 框架中的一个核心组件，主要用于管理数据操作的上下文环境。它类似于数据库中的“会话”或“事务”，为应用提供了进行数据增删改查的工作区。以下是 ModelContext 的详细作用和用法：

1、ModelContext 的作用

数据操作上下文：ModelContext 允许你插入、删除、更新、和查询数据。每一个数据操作（如新增用户、修改书籍信息等）都在一个 ModelContext 中进行。

事务管理：在 ModelContext 中执行的数据变更通常不会立即被保存到持久层中，需要显式调用 save() 方法将数据提交。这种方式使得在操作数据时可以确保数据一致性，类似于数据库中的事务管理。

跟踪数据变更：ModelContext 能够自动跟踪在上下文中被修改的对象。当对象的属性值被更改时，ModelContext 会标记对象为“已更改”状态，并可以选择性地保存这些更改。

2、如何获取 ModelContext

从 ModelContainer 获取：通常情况下，ModelContext 是从 ModelContainer（数据容器）中获取的。ModelContainer 本身相当于一个数据库管理实例，而 ModelContext 是具体的操作接口。

let container = try ModelContainer(for: [UserProfile.self, Book.self])
let context = container.mainContext // 获取主操作上下文

从 SwiftUI 环境中获取：在 SwiftUI 视图中，ModelContext 可以通过环境变量 @Environment(\.modelContext) 自动注入到视图中。这样可以方便地在视图层直接进行数据操作。

struct ContentView: View {
    @Environment(\.modelContext) private var context
    
    var body: some View {
        // 使用 context 进行数据操作
    }
}

3、ModelContext 的常见用法

以下是 ModelContext 的一些常用操作：

插入数据

let newUser = UserProfile(name: "Alice", age: 25)
context.insert(newUser) // 将对象插入到上下文中

删除数据

context.delete(user) // 从上下文中删除对象

删除所有数据

try? modelContext.delete(model: User.self)

删除现有的User类型的所有数据。

保存数据

do {
    try context.save() // 提交上下文中的所有更改
} catch {
    print("保存失败: \(error)")
}

回滚保存状态

context.rollback()

查询数据

func fetch<T>(_ descriptor: FetchDescriptor<T>) throws -> [T]

fetch方法接收一个 FetchDescriptor 参数来指定查询的目标和条件。

返回值是一个数组，包含查询到的所有结果。

查询所有数据

如果想获取所有 Book 实体：

let books = try context.fetch(FetchDescriptor<Book>())
for book in books {
    print("Title: \(book.title), Author: \(book.author)")
}

使用过滤

可以通过 predicate 参数添加条件，例如查询特定 genre 的书：

let fetchDescriptor = FetchDescriptor<Book>(predicate: #Predicate { $0.genre == "Fiction" })
let fictionBooks = try context.fetch(fetchDescriptor)

这里的 predicate 是 SwiftData 提供的类型安全的筛选器，类似 Core Data 中的 NSPredicate。

添加排序

可以通过 sortBy 参数添加排序规则，例如按评分降序排序：

let fetchDescriptor = FetchDescriptor<Book>(
    sortBy: [SortDescriptor(\.rating, order: .reverse)]
)
let sortedBooks = try context.fetch(fetchDescriptor)

分页（limit 和 offset）

如果需要限制结果数量或跳过部分结果，可以设置分页参数：

let fetchDescriptor = FetchDescriptor<Book>(limit: 10, offset: 5)
let paginatedBooks = try context.fetch(fetchDescriptor)

limit：指定最多返回的记录数量。

offset：指定跳过的记录数量。

数据观察

用于监听上下文或对象的变化：

observe(_:changeHandler:)

监听 ModelContext 的变化，例如对象的插入、删除或修改。

context.observe { changes in
    for change in changes {
        switch change {
        case .inserted(let objects):
            print("Inserted: \(objects)")
        case .updated(let objects):
            print("Updated: \(objects)")
        case .deleted(let objects):
            print("Deleted: \(objects)")
        }
    }
}

生命周期管理

一些辅助功能：

hasChanges

检查上下文中是否存在未保存的更改。

if context.hasChanges {
    try context.save()
}

refresh(_:mergeChanges:)

从数据库中重新加载指定对象的最新状态。

context.refresh(book, mergeChanges: true)

reset()

清空上下文中所有未保存的更改，同时移除所有已加载的对象。

context.reset()

mainContext和ModelContext

let container = try ModelContainer(for: [UserProfile.self, Book.self])
let context = container.mainContext // 获取主操作上下文

这里存在mainContext和ModelContext两个概念。

mainContext 和 ModelContext 是相关但不完全相同的概念。虽然它们都是 SwiftData 中用于数据管理的上下文对象，但它们的作用和使用方式稍有不同：

ModelContext

ModelContext 是 SwiftData 中数据操作的通用上下文，用于处理对数据模型的增删改查操作。它管理数据在内存中的状态，确保数据的变化可以在持久化存储中同步。

ModelContext 的实例通过 @Environment(\.modelContext) 自动获取，适合在 SwiftUI 视图层中使用，便于和视图的绑定。它让你可以直接在视图中操作数据，例如插入、删除、保存等操作。

@Environment(\.modelContext) private var context

每一个视图组件通常会使用当前视图环境下的 modelContext 来确保数据的实时性和一致性。

mainContext

mainContext 是 ModelContainer 的一个属性。它是一个 ModelContext 的实例，通常用于在应用的主线程上执行数据操作。

mainContext 是应用程序的“主上下文”，一般用于在需要同步到主线程的操作中，比如在预览时初始化数据。

当在 ModelContainer 初始化时没有显式提供 ModelContext 时，mainContext 就是 ModelContainer 中的默认上下文。

关系与区别

关系：mainContext 是 ModelContext 的一个实例，通常用于同步主线程上的数据变化。ModelContext 则是一个更通用的上下文类型，可以在不同的线程中使用。

区别：mainContext 仅用于主线程操作，而 ModelContext 可以在不同的线程上下文中操作数据，适应性更强。

什么时候使用 mainContext 与 ModelContext

在 SwiftUI 视图中操作数据时，使用 @Environment(\.modelContext) 绑定到当前的 ModelContext。

在应用的初始化或某些不在视图环境中的代码里，可以使用 mainContext 执行初始数据插入或查询操作。

这样，mainContext 提供了在主线程执行数据管理的入口，而 ModelContext 则提供了灵活的数据管理支持。

不需要显式声明的mainContext

import SwiftUI
import SwiftData

@main
struct hackingwithswiftApp: App {
    @State private var container: ModelContainer
    init() {
        container = try! ModelContainer(for: UserProfile.self)
    }

    var body: some Scene {
        WindowGroup {
            ContentView()
                .modelContainer(container)

        }
    }
}
struct ContentView: View {
    @Environment(\.modelContext) private var context
    @Query var profiles: [UserProfile] // 查询所有用户数据
    
    var body: some View {
        ...
    }
}

在这段代码中，可以看到并没有显式声明一个mainContext，但它仍然通过 @Environment(\.modelContext) 自动获取到了 ModelContext。这是因为在 SwiftUI 中，将 ModelContainer 传递给视图后，SwiftUI 会自动为该视图的环境提供一个 modelContext，对应于 ModelContainer 的 mainContext。

实现步骤

1、modelContainer(container)：在 hackingwithswiftApp 中，通过 modelContainer(container) 将 ModelContainer 传递给 ContentView。这使得 ContentView 和其子视图中可以访问 modelContext 环境变量。

2、@Environment(\.modelContext)：在 ContentView 中，@Environment(\.modelContext) 自动从环境中提取当前的 ModelContext（即 container.mainContext）。

3、数据操作：由于 @Environment(\.modelContext) 已经是一个有效的 ModelContext，因此在 ContentView 中调用 context.insert(usr) 和 try context.save() 都可以直接操作数据，无需手动创建或显式调用 mainContext。这种模式让代码更简洁，不用每次都显式声明 mainContext。

@Query在ModelContext中的使用

@Query var profiles: [UserProfile] // 通过 @Query 注解从 ModelContext 中获取数据

在 SwiftData 中，@Query 属性包装器用于声明要从 ModelContext（数据上下文）中查询的模型数据。使用 @Query 注解后，SwiftData 会自动在视图加载时从当前的 ModelContext 获取并保持这些数据的最新状态。

因此，@Query var profiles: [UserProfile] 可以理解为：

自动查询数据：@Query 会根据上下文（即 ModelContext）中存在的数据类型 UserProfile 自动执行查询，而不需要手动编写查询代码。

数据自动更新：@Query 绑定的数据会随着 ModelContext 中相关数据的增删改而自动更新。当 ModelContext 中的 UserProfile 数据发生变化时，profiles 数组会自动反映最新状态，并重新渲染视图。

这使得 @Query 非常适合用于实时显示或监控来自 ModelContext 的数据集，同时简化了代码。