GRDB.swift 中实现 hasManyThrough 关联查询的最佳实践

引言

在 iOS 开发中，处理复杂的数据关系是常见的需求。GRDB.swift 作为一个强大的 SQLite 封装库，提供了优雅的方式来处理数据库关系。本文将深入探讨如何使用 GRDB.swift 实现 hasManyThrough 这种多对多关联关系的数据查询。

数据模型设计

我们以一个音乐应用为例，其中包含三种核心数据模型：

1. 歌曲模型(ChordproSong)：表示基本的歌曲信息
2. 歌单模型(CCSet)：用户可以创建的歌单集合
3. 歌单项模型(CCSetItem)：作为关联表，连接歌单和歌曲

这种设计实现了多对多关系：一个歌单可以包含多首歌曲，一首歌曲可以属于多个歌单。此外，CCSetItem 还存储了歌曲在特定歌单中的排序位置和自定义音阶信息。

关联关系定义

在 GRDB.swift 中，我们这样定义模型间的关联：

// 歌单模型扩展
extension CCSet: EncodableRecord, FetchableRecord, MutablePersistableRecord, TableRecord {
    static let items = hasMany(CCSetItem.self).forKey("items")
    static let songs = hasMany(ChordproSong.self, through: items, using: CCSetItem.song).forKey("songs")
}

// 歌单项模型扩展
extension CCSetItem: TableRecord, FetchableRecord, EncodableRecord, MutablePersistableRecord {
    static let song = belongsTo(ChordproSong.self).forKey("song")
    static let ccset = belongsTo(CCSet.self).forKey("ccset")
}

查询实现

要实现查询歌单及其包含的所有歌曲信息，我们需要构建一个复合查询。GRDB.swift 提供了 including 方法来实现这种关联查询。

方法一：嵌套模型查询

struct CCSetWithSongs: FetchableRecord, Decodable, Identifiable {
    struct ItemWithSong: Decodable, Hashable {
        var item: CCSetItem
        var song: ChordproSong
    }
    var ccset: CCSet
    var items: [ItemWithSong]
    var songs: [ChordproSong] { items.map(\.song) }
}

let observation = ValueObservation.tracking { db in
    return try CCSet
        .including(all: CCSet.items
            .including(required: CCSetItem.song)
        )
        .asRequest(of: CCSetWithSongs.self)
        .fetchAll(db)
}

方法二：自定义键名查询

struct CCSetWithSongs: FetchableRecord, Decodable, Identifiable {
    struct ItemWithSong: Decodable, Hashable {
        var item: CCSetItem
        var song: ChordproSong
    }
    var ccset: CCSet
    var itemWithSongs: [ItemWithSong]
    var items: [CCSetItem] { itemWithSongs.map(\.item) }
    var songs: [ChordproSong] { itemWithSongs.map(\.song) }
}

let observation = ValueObservation.tracking { db in
    return try CCSet
        .including(all: CCSet.items
            .including(required: CCSetItem.song)
            .forKey("itemWithSongs")
        )
        .asRequest(of: CCSetWithSongs.self)
        .fetchAll(db)
}

关键点解析

1. 关联查询构建：使用 including(all:) 方法加载所有关联项，再通过 including(required:) 加载更深层次的关联。

2. 结果模型设计：创建专门的结构体来承载查询结果，嵌套结构体能准确反映数据关系。

3. 计算属性：通过计算属性提供便捷访问方式，如直接获取所有歌曲列表。

4. 键名映射：可以使用 forKey 方法自定义结果中的键名，提高代码可读性。

常见问题解决

在实现过程中，开发者可能会遇到以下错误：

DecodingError.keyNotFound(CodingKeys(stringValue: "song", intValue: nil)

这通常是由于查询构建方式与结果模型不匹配导致的。解决方法包括：

1. 确保使用 including(required:) 而不是 joining(required:) 来加载关联模型
2. 检查结果模型中的属性名是否与查询中的键名一致
3. 验证所有必需的关联关系都已正确定义

总结

GRDB.swift 提供了强大的工具来处理复杂的数据关系。通过合理设计数据模型和查询方式，我们可以优雅地实现多对多关系的查询需求。关键在于：

1. 正确定义模型间的关联关系
2. 构建与数据结构匹配的查询请求
3. 设计能够准确反映查询结果的模型结构

掌握这些技巧后，开发者可以高效地处理各种复杂的数据查询场景，为应用提供强大的数据支持。