如何手动监听SwiftData @Model对象的数据库更新？

问题场景 #

我定义了如下SwiftData模型类：

@Model
final class MyItem: Identifiable {
    @Attribute(.unique) var id: String
    var name: String
    
    init(id: String, name: String) {
        self.id = id
        self.name = name
    }
}

想要监听该对象在数据库层面的变化（而非仅本地实例的修改），尝试过以下方法但都无效：

• 让MyItem遵循ObservableObject协议，监听objectWillChange：修改并保存到数据库后，收不到变更通知（但确认变更已持久化）
• 给name属性添加@Published：编译报错，因为@Model不允许使用额外属性包装器

之前尝试的ViewModel写法类似这样：

class ViewModel {
    private var cancellables = Set<AnyCancellable>()
    
    init(myItem: MyItem) {
        myItem.objectWillChange.sink { completion in
            print("something")
        } receiveValue: { _ in
            print("something new")
        }
        .store(in: &cancellables)
    }
}

解决方案 #

SwiftData的@Model类本身具备可观察性，但单个实例的objectWillChange仅能捕获本地内存实例的修改，无法感知数据库层面的跨上下文变更（比如其他ViewModel、后台进程修改了数据库中的数据）。要监听数据库级别的变更，需要通过订阅查询结果的方式实现：

正确的ViewModel实现 #

class ViewModel: ObservableObject {
    private var cancellables = Set<AnyCancellable>()
    // 用@Published包装最新的对象实例，供View绑定
    @Published var currentItem: MyItem?
    
    init(itemId: String, context: ModelContext) {
        // 创建针对目标对象的查询描述符，通过唯一id定位
        let fetchDescriptor = FetchDescriptor<MyItem>(
            predicate: #Predicate { $0.id == itemId }
        )
        
        // 订阅查询结果的变化
        context.fetch(fetchDescriptor)
            .sink(
                receiveCompletion: { completion in
                    if case .failure(let error) = completion {
                        print("查询失败：\(error.localizedDescription)")
                    }
                },
                receiveValue: { [weak self] items in
                    // 数据库中目标对象发生任何变更时，都会收到最新实例
                    self?.currentItem = items.first
                    print("对象已更新：\(self?.currentItem?.name ?? "无名称")")
                }
            )
            .store(in: &cancellables)
    }
}

原理说明 #

1. 查询订阅的优势：通过ModelContext.fetch(_:)返回的AsyncThrowingStream，可以监听符合查询条件的所有数据库变更——不管是当前上下文还是其他上下文修改的数据，都会触发回调并返回最新的实例。
2. 无需额外协议：@Model类已经被SwiftData自动处理为可观察类型，不需要手动遵循ObservableObject。
3. View自动刷新：ViewModel中的@Published var currentItem会在对象更新时自动通知View刷新，直接绑定即可。

补充：如果需要传入初始MyItem实例 #

如果必须在初始化时传入MyItem实例，也可以通过它的id和关联的ModelContext来构建查询：

init(myItem: MyItem) {
    guard let context = myItem.modelContext else {
        print("无法获取对象关联的ModelContext")
        return
    }
    let itemId = myItem.id
    // 后续逻辑和上面的ViewModel一致，用itemId和context创建查询并订阅
    let fetchDescriptor = FetchDescriptor<MyItem>(predicate: #Predicate { $0.id == itemId })
    
    context.fetch(fetchDescriptor)
        .sink(
            receiveCompletion: { completion in
                if case .failure(let error) = completion {
                    print("查询失败：\(error.localizedDescription)")
                }
            },
            receiveValue: { [weak self] items in
                self?.currentItem = items.first
                print("对象已更新：\(self?.currentItem?.name ?? "无名称")")
            }
        )
        .store(in: &cancellables)
}

内容的提问来源于stack exchange，提问作者SirRupertIII