概述
WWDC 24 一声炮响为我们送来 Swift 6.0 的同时，也颇为"低调"的推出了 SwiftData 2.0。在新版本的 SwiftData 中，苹果为其新增了多个激动人心的新特性，其中就包括历史记录追踪（History Trace）。
不过，历史记录追踪目前看起来似乎有些"白璧微瑕"，略微让人有些不爽。在这里就让我们看看如何利用 Swift 结构化并发中的异步序列（AsyncSequence）来"补苴罅漏"吧。
在本篇博文中，您将学到如下内容：
- SwiftData 2.0 中的历史记录追踪
- 一个小小的美中不足...
- 异步序列的"将伯之助"
相信通过本篇的学习，小伙伴们在精进 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 消息来实现：
swift
.onReceive(NotificationCenter.default.publisher(for: .NSPersistentStoreRemoteChange).receive(on: DispatchQueue.main)) { _ in
NSLog("数据库发生了变动！")
}在得知数据库发生变化之后，我们随即就可以利用 History Trace 来"恣意"读取具体的历史 Change 记录了：
swift
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）引起的改变。
2. 一个小小的美中不足...
不知小伙伴们发现了没有，虽说利用 NSPersistentStoreRemoteChange 可以圆满的监听到 SwiftData 数据库的改变，但这种方式感觉把"监听"和"处理"操作隔离开了，无法从逻辑上体现出 Swift 语言的简洁和优雅。
参考苹果对于监听设备位置坐标改变实现的升级，我们希望在 SwiftData 2.0 的 History Trace 里也能用类似下面的代码来"抽丁拔楔"：
swift
for await change in modelContext.persistentStoreChanges {
// 对数据库中的改变进行处理...
}看到这么熟悉且散发着 Swifty 范儿的"美味"代码，小伙伴们想必都会有一个似曾相识的"身影"映入脑海。别犹豫，大声说出来！它就是：异步序列。
3. 异步序列的"将伯之助"
异步序列是 Swift 5.5+ 中跟随结构化异步模型推出的一种数据类型。系统内置框架本身就包含了海量异步序列，我们也可以遵守 AsyncSequence 协议来实现自己的异步序列。
从之前的代码可以发现，我们对于历史记录的查询是在模型上下文对象上进行的。所以我们可以进一步扩展 ModelContext 类型来实现我们对应的异步序列：
swift
extension ModelContext {
var historyChanges: any AsyncSequence<(changes: [HistoryChange], token: DefaultHistoryToken?), Error> {
NotificationCenter.default.publisher(for: .NSPersistentStoreRemoteChange).tryMap { _ in
var changes = [HistoryChange]()
let context = self
var historyDesc = HistoryDescriptor<DefaultHistoryTransaction>()
if let author = context.author {
historyDesc.predicate = #Predicate { trans in
trans.author != author
}
}
let transactions = try context.fetchHistory(historyDesc)
for trans in transactions {
for change in trans.changes {
changes.append(change)
}
}
let token = transactions.last?.token
return (changes, token)
}
.values
}
}如上代码所示，我们为 ModelContext 扩展了一个 historyChanges 实例属性，它的类型即为一个异步序列：any AsyncSequence<(changes: [HistoryChange], token: DefaultHistoryToken?), Error>。
现在，我们可以这样抓取 historyChanges 属性中的历史变更记录了：
swift
.task {
do {
for try await result in modelContext.historyChanges {
for change in result.changes {
// 处理历史追踪记录
}
if let token = result.token {
// 删除已处理到历史记录
}
}
} catch {
print(error.localizedDescription)
}
}注意，目前我们 historyChanges 异步序列的元素（Element）类型为 [HistoryChange]，这是利用发布器（Publisher）实例的 values 属性本身就是一个异步序列这个特性来实现的 。
我们还可以按单个 HistoryChange 来捕获历史的更改记录，这可以通过 AsyncStream 辅助类型来完成：
swift
typealias ChangeSequenceElement = (change: HistoryChange?, token: DefaultHistoryToken?)
private static var cancel = Set<AnyCancellable>()
var historyChanges: any AsyncSequence<ChangeSequenceElement, Error> {
AsyncThrowingStream { c in
NotificationCenter.default.publisher(for: .NSPersistentStoreRemoteChange)
.receive(on: DispatchQueue.main)
.sink(receiveCompletion: { result in
switch result {
case .finished:
c.finish()
case .failure(let failure):
c.finish(throwing: failure)
}
}, receiveValue: {[unowned self] _ in
let context = self
var historyDesc = HistoryDescriptor<DefaultHistoryTransaction>()
if let author = context.author {
historyDesc.predicate = #Predicate { trans in
trans.author != author
}
}
do {
let transactions = try context.fetchHistory(historyDesc)
for trans in transactions {
for change in trans.changes {
c.yield((change, nil))
}
}
let token = transactions.last?.token
c.yield((nil, token))
} catch {
c.yield(with: .failure(error))
}
})
.store(in: &Self.cancel)
}
}如上代码所示，我们通过 AsyncThrowingStream 类型将 NSPersistentStoreRemoteChange 消息的监听以及数据库历史变更记录查询这两种操作，行云流水般一气呵成。
但是，这种实现需要一个静态的 Set<AnyCancellable>() 集合来保存订阅，而且不能细粒度控制监控的取消。这时，我们可以通过返回可取消对象（Cancellable）来解决：
swift
typealias ChangeSequenceElement = (change: HistoryChange?, token: DefaultHistoryToken?)
func getHistoryChanges() -> (changes: any AsyncSequence<ChangeSequenceElement, Error>, cancel: AnyCancellable) {
var cancel: AnyCancellable = AnyCancellable({})
let stream = AsyncThrowingStream<ChangeSequenceElement, Error> { c in
cancel = NotificationCenter.default.publisher(for: .NSPersistentStoreRemoteChange)
.receive(on: DispatchQueue.main)
.sink(receiveCompletion: { result in
switch result {
case .finished:
c.finish()
case .failure(let failure):
c.finish(throwing: failure)
}
}, receiveValue: {[unowned self] _ in
let context = self
var historyDesc = HistoryDescriptor<DefaultHistoryTransaction>()
if let author = context.author {
historyDesc.predicate = #Predicate { trans in
trans.author != author
}
}
do {
let transactions = try context.fetchHistory(historyDesc)
for trans in transactions {
for change in trans.changes {
c.yield((change, nil))
}
}
let token = transactions.last?.token
c.yield((nil, token))
} catch {
c.yield(with: .failure(error))
}
})
}
return (stream, cancel)
}这样一来，我们就可以在适当的时候取消历史追踪记录的监听了：
swift
struct ContentView: View {
@Environment(\.modelContext) var modelContext
@Query var items: [Item]
@State var cancel: AnyCancellable?
var body: some View {
NavigationStack {
VStack {
// 视图界面逻辑从略...
}
.onDisappear {
// 在视图"消失"时取消监听
cancel?.cancel()
}
.task {
let (stream, cancel) = modelContext.getHistoryChanges()
self.cancel = cancel
do {
for try await result in stream {
if let change = result.change {
switch change {
case .insert(_):
print("插入一个新 Item")
case .update(_):
print("一个 Item 被更新")
case .delete(let historyDelete):
if let history = historyDelete as? DefaultHistoryDelete<Item> {
print("\(history.tombstone[\Item.name] ?? "null") 已被删除！")
}
@unknown default:
fatalError()
}
}
if let token = result.token {
try! modelContext.deleteTransactions(before: token)
}
}
} catch {
print(error.localizedDescription)
}
}
}
}
}从上面的代码可以看到，我们在视图退出渲染树时取消了历史记录的监听。其中部分代码的实现出自于《由一个 SwiftData "诡异"运行时崩溃而引发的钩深索隐》这一系列 6 篇博文中，想要进一步了解的小伙伴们可以移步观看。
至此，我们利用 Swift 5.5+ 新并发模型中的异步序列成功的改造了 SwiftData 2.0 中历史记录追踪的监听实现，小伙伴们还不赶紧自己一个大大的赞！棒棒哒💯
总结
在本篇博文中，我们讨论了如何利用 Swift 5.5+ 新并发模型中的异步序列更优雅的监听 SwiftData 2.0 中历史追踪记录（History Trace）的变化，颇具 Swifty 范儿，你值得拥有！
感谢观赏，再会啦！8-)