用异步序列优雅的监听 SwiftData 2.0 中历史追踪记录（History Trace）的变化

概述

WWDC 24 一声炮响为我们送来 Swift 6.0 的同时，也颇为“低调”的推出了 SwiftData 2.0。在新版本的 SwiftData 中，苹果为其新增了多个激动人心的新特性，其中就包括历史记录追踪（History Trace）。

不过，历史记录追踪目前看起来似乎有些“白璧微瑕”，略微让人有些不爽。在这里就让我们看看如何利用 Swift 结构化并发中的异步序列（AsyncSequence）来“补苴罅漏”吧。

相信通过本篇的学习，小伙伴们在精进 Swift 异步序列技艺的同时又能了然 SwiftData 2.0 的新“脾性”，何乐而不为呢？

闲言少叙，让我们马上开始吧！Let‘s go！！！😉

---

1. SwiftData 2.0 中的历史记录追踪

历史记录追踪（History Trace）是 SwiftData 2.0 中新推出的一种查询 SwiftData 数据库内容变化的机制。

History Trace “降生”的意义在于：利用它我们现在可以观察到不同模型上下文、不同进程以及系统不同组件对数据库内容的更改行为了。

举个例子：比如在 WatchOS 系统中包含共享同一个数据库（通过 App Groups）的 App 和 Widget。当 Widget 添加了一条记录后，我们的 App 如何能够知晓呢？

一种方法是在 App 进入前台时（active）被动读取数据库来发现变化。不过，更好的方法是让数据库自己主动告诉我们：底层数据发生了改变，需要秃头码农们的及时处理。

这可以通过在界面中监听 NSPersistentStoreRemoteChange 消息来实现：

.onReceive(NotificationCenter.default.publisher(for: .NSPersistentStoreRemoteChange).receive(on: DispatchQueue.main)) {
    _ in
    NSLog("数据库发生了变动！")
}

在得知数据库发生变化之后，我们随即就可以利用 History Trace 来“恣意”读取具体的历史 Change 记录了：

private func handleChangeInMainContext() {
   
    let mainContext = modelContext
    var historyDesc = HistoryDescriptor<DefaultHistoryTransaction>()
    historyDesc.predicate = #Predicate {
    trans in
        trans.author == "Widgets"
    }
    
    let transactions = try! mainContext.fetchHistory(historyDesc)
    for trans in transactions {
   
        for change in trans.changes {
   
            // 具体处理实现从略...
        }
    }
}

如上代码所示，当监听到底层数据库发生变动时我们可以调用 handleChangeInMainContext() 方法来查询所有实际变更的记录。从中我们还可以发现，我们利用了 #Predicate 宏来进行结果过滤从而只关注小组件（Widgets）引起的改变。

---

更多 SwiftData 2.0 中历史记录追踪和“墓碑”机制的详细介绍，请小伙伴们移步如下链接观赏系列文章（共 6 篇）：

• 由一个 SwiftData “诡异”运行时崩溃而引发的钩深索隐（一）
• 由一个 SwiftData “诡异”运行时崩溃而引发的钩深索隐（二）
• 由一个 SwiftData “诡异”运行时崩溃而引发的钩深索隐（三）

---

2. 一个小小的美中不足…

不知小伙伴们发现了没有，虽说利用 NSPersistentStoreRemoteChange 可以圆满的监听到 SwiftData 数据库的改变，但这种方式感觉把“监听”和“处理”操作隔离开了，无法从逻辑上体现出 Swift 语言的简洁和优雅。

参考苹果对于监听设备位置坐标改变实现的升级，我们希望在 SwiftData 2.0 的 History Trace 里也能用类似下面的代码来“抽丁拔楔”：

for await change in modelContext.persistentStoreChanges {
   
    // 对数据库中的改变进行处理...
}

看到这么熟悉且散发着 Swifty 范儿的“美味”代码，小伙伴们想必都会有一个似曾相识的“身影”映入脑海。别犹豫，大声说出来！它就是：异步序列。

3. 异步序列的“将伯之助”

异步序列是 Swift 5.5+ 中跟随结构化异步模型推出的一种数据类型。系统内置框架本身就包含了海量异步序列，我们也可以遵守 AsyncSequence 协议来实现自己的异步序列。

更多关于异步序列的进一步精彩介绍，请小伙伴们移步如下链接观赏：

• Swift 异步序列 AsyncStream 新“玩法”以及内存泄漏、死循环那些事儿(上)
• Swift 异步序列 AsyncStream 新“玩法”以及内存泄漏、死循环那些事儿(下)
• 『番外篇三』Swift “乱弹”之带索引遍历异步序列（AsyncSequence）
• Swift async/await 并发中如何将任务组（TaskGroup）转换为异步序列（AsyncSequence）
• Swift异步序列构造器AsyncStream内部定时器(Timer)无法被触发的解决

从之前的代码可以发现，我们对于历史记录的查询是在模型上下文对象上进行的。所以我们可以进一步扩展 ModelContext 类型来实现我们对应的异步序列：

extension ModelContext {
   
    var historyChanges: any AsyncSequence<(