解决go-gorm/gen中ORDER BY子句被禁用的问题

在使用go-gorm/gen进行数据库查询时，开发者可能会遇到"clause ORDER BY is banned"的错误。这个问题通常出现在尝试使用自定义排序规则时，特别是当使用FIELD函数进行特定值排序的场景。

问题背景

在数据库查询中，我们经常需要对结果进行自定义排序。例如，我们可能希望按照特定字段值的固定顺序（如角色字段按DNS、管理、控制器等特定顺序）而不是字母或数字顺序来排序结果。在原生SQL中，我们可以使用MySQL的FIELD函数来实现这种需求。

错误原因

当开发者尝试使用clause.OrderBy配合FIELD函数表达式时，可能会遇到"clause ORDER BY is banned"的错误。这是因为在go-gorm/gen框架中，某些高级排序功能需要特定的语法来实现。

解决方案

go-gorm/gen提供了更简洁的方式来实现FIELD函数排序。开发者可以使用模型字段的Field方法来构建这种特殊排序条件，而不需要直接使用clause.OrderBy和复杂的表达式构造。

正确的实现方式如下：

.Order(u.Role.Field("r1", "r2"))

其中：

• u是模型实例
• Role是要排序的字段
• "r1", "r2"等是希望按照特定顺序排列的字段值

实际应用示例

假设我们有一个设备模型，需要按照角色字段的特定顺序排序（DNS、管理、控制器等），可以这样实现：

pods, total, err := d.Debug().
    Joins(d.DeviceGroup).
    Scopes(
        scope.WhereIf(req.Keyword != "", d.Name.Like("%"+req.Keyword+"%")),
        scope.WhereIf(len(req.Names) > 0, d.Name.In(req.Names...)),
    ).
    Order(d.Role.Field(
        consts.PodDns, 
        consts.PodMgmt, 
        consts.PodController,
        consts.PodMariaDBGalera, 
        consts.PodTelemetry, 
        consts.PodDoris,
    )).
    FindByPage(req.OffsetLimit())

这种方法不仅解决了"ORDER BY is banned"的错误，而且代码更加简洁易读。

总结

在go-gorm/gen框架中，当需要进行复杂的自定义排序时，特别是使用类似MySQL FIELD函数的功能时，应该优先使用模型字段的Field方法，而不是直接构造SQL表达式。这种方法既保持了类型安全，又避免了底层SQL构造的复杂性，是框架推荐的实践方式。