GRDB.swift 中枚举类型作为数据库字段的解决方案

在 iOS 开发中使用 GRDB.swift 作为数据库解决方案时，我们经常会遇到需要将 Swift 枚举类型存储到数据库中的场景。本文将以 TicketType 枚举为例，详细介绍如何在 GRDB.swift 中正确处理枚举类型的数据库存储和查询。

问题背景

当开发者尝试将一个包含枚举类型的 Record 通过 filter.fetchAll(db) 方法查询时，可能会遇到类型转换错误。这是因为 GRDB.swift 默认不知道如何将数据库中的原始值转换为 Swift 枚举类型。

解决方案

要使枚举类型能够与 GRDB.swift 无缝协作，需要实现 DatabaseValueConvertible 协议。这个协议定义了如何在 Swift 类型和数据库值之间进行转换。

基础实现

对于简单的字符串枚举，实现非常简单：

enum TicketType: String, Codable, CaseIterable {
    case movieTicket
    case trainTicket
}

extension TicketType: DatabaseValueConvertible { }

这个空扩展就足够了，因为：

1. 枚举已经是 String 类型
2. String 已经实现了 DatabaseValueConvertible
3. GRDB.swift 会自动利用这些特性完成转换

自定义实现

如果枚举的原始值类型不是 DatabaseValueConvertible，或者需要特殊处理，可以完整实现协议：

extension TicketType: DatabaseValueConvertible {
    var databaseValue: DatabaseValue {
        return rawValue.databaseValue
    }
    
    static func fromDatabaseValue(_ dbValue: DatabaseValue) -> TicketType? {
        guard let rawValue = String.fromDatabaseValue(dbValue) else {
            return nil
        }
        return TicketType(rawValue: rawValue)
    }
}

数据库表设计

在创建数据库表时，需要确保列类型与枚举的原始值类型匹配。对于字符串枚举，应使用 .text 类型：

migrator.registerMigration("app_v1_20240711") { db in
    try db.create(table: "ticket") { t in
        t.autoIncrementedPrimaryKey("id")
        t.column("ticketType", .text).notNull()
        t.column("createdTime", .datetime)
        t.column("updatedTime", .datetime)
    }
}

使用示例

实现 DatabaseValueConvertible 后，就可以像使用普通属性一样使用枚举字段：

// 插入记录
var ticket = TicketSchema(ticketType: .movieTicket)
try ticket.insert(db)

// 查询记录
let tickets = try TicketSchema.filter(Column("ticketType") == TicketType.movieTicket).fetchAll(db)

注意事项

1. 确保枚举的原始值类型与数据库列类型匹配
2. 如果修改了枚举的 case，需要考虑数据库迁移策略
3. 对于复杂的枚举类型，可能需要更复杂的转换逻辑

通过正确实现 DatabaseValueConvertible 协议，开发者可以轻松地在 GRDB.swift 中使用枚举类型，使代码更加类型安全和易于维护。