GRDB.swift中使用生成列的最佳实践

生成列简介

在SQLite数据库中，生成列(GENERATED COLUMNS)是一种特殊类型的列，其值由其他列的值计算得出。GRDB.swift作为Swift语言的SQLite工具库，支持这种强大的数据库特性。生成列分为两种类型：

• 虚拟列(VIRTUAL)：只在读取时计算，不占用存储空间
• 存储列(STORED)：在写入时计算并存储

问题场景

在使用GRDB.swift时，开发者可能会遇到这样的场景：定义了一个包含生成列的数据表，但在尝试保存记录时遇到"cannot UPDATE generated column"错误。这是因为生成列的值应该由数据库自动计算，而不应该由应用程序直接写入。

解决方案比较

方案一：自定义属性包装器

可以创建一个@EncodingIgnored属性包装器，让特定属性在编码时被忽略：

@propertyWrapper
public struct EncodingIgnored<T: Hashable & Decodable>: Codable, Hashable {
    public var wrappedValue: T?
    
    public init(wrappedValue: T?) {
        self.wrappedValue = wrappedValue
    }
    
    public init(from decoder: Decoder) throws {
        let value = try decoder.singleValueContainer()
        self.wrappedValue = try value.decode(T?.self)
    }
    
    public func encode(to encoder: Encoder) throws {
        // 编码时忽略此属性
    }
}

使用方式：

struct Item: Codable {
    var id: String
    var startDate: Date?
    var duration: Int
    
    @EncodingIgnored
    public let endDate: Date?
}

优点：

• 使用简单，只需添加属性包装器
• 自动处理所有编码逻辑

缺点：

• 将数据库概念混入模型定义
• 依赖于Swift的Codable协议

方案二：自定义encode方法

通过重写encode(to:)方法明确指定需要持久化的字段：

extension Item {
    func encode(to container: inout PersistenceContainer) {
        container["id"] = id
        container["startDate"] = startDate
        container["duration"] = duration
        // 不包含endDate
    }
}

优点：

• 完全控制持久化逻辑
• 不引入额外依赖

缺点：

• 需要手动维护字段列表
• 新增字段时容易遗漏

方案三：分离模型定义

创建两个模型类型：一个用于写入(不包含生成列)，一个用于读取(包含所有列)：

// 写入模型
struct ItemDefinition: Codable, FetchableRecord, PersistableRecord {
    var id: String
    var startDate: Date?
    var duration: Int
}

// 读取模型
struct Item: Decodable, FetchableRecord {
    var id: String
    var startDate: Date?
    var duration: Int
    var endDate: Date?
}

优点：

• 职责分离清晰
• 可以定义更严格的类型约束
• 完全避免生成列写入问题

缺点：

• 需要维护两个模型
• 代码量增加

最佳实践建议

1. 简单场景：如果项目规模较小，使用属性包装器是最快捷的解决方案。

2. 大型项目：考虑采用模型分离方案，虽然代码量增加，但长期维护性更好。

3. 中间路线：对于中等规模项目，自定义encode方法提供了良好的平衡点。

4. 类型安全：如果生成列保证不为NULL，可以在读取模型中定义为非可选类型，增加类型安全性。

总结

GRDB.swift提供了多种方式来处理生成列，开发者可以根据项目规模和复杂度选择最适合的方案。理解这些模式的优缺点有助于做出更明智的架构决策。无论选择哪种方案，关键是要确保生成列的值由数据库计算，而不是由应用程序直接写入。