GORM 项目中的条件查询封装实践

背景介绍

在数据库操作中，我们经常会遇到需要重复添加相同查询条件的情况。特别是在多表关联查询时，某些基础条件(如用户ID、员工ID等)需要在多个查询中重复使用。这不仅增加了代码冗余，也降低了代码的可维护性。

问题分析

以GORM项目为例，当我们需要查询不同表但使用相同条件时，传统做法是在每个查询中都显式地添加这些条件。例如：

-- 查询foo表
SELECT * FROM foo WHERE user_id = 1 AND staff_id = 1

-- 查询operations表
SELECT * FROM operations WHERE user_id = 1 AND staff_id = 1

这种写法存在两个主要问题：

1. 条件重复编写，增加维护成本
2. 容易遗漏必要条件，导致数据安全问题

解决方案

GORM提供了灵活的查询构建方式，我们可以利用函数式选项模式(Functional Options Pattern)来封装常用查询条件。

核心实现思路

1. 定义Option类型：创建一个函数类型，用于修改查询构建器

type Option func(*gorm.DB) *gorm.DB

2. 创建条件封装函数：为每个常用条件创建对应的Option生成函数

func WithStaffId(staffId int64) Option {
    return func(db *gorm.DB) *gorm.DB {
        return db.Where("staff_id = ?", staffId)
    }
}

func WithUserId(userId int64) Option {
    return func(db *gorm.DB) *gorm.DB {
        return db.Where("user_id = ?", userId)
    }
}

3. 构建查询方法：在数据访问层实现通用的查询方法

func (d *ModelData) GetList(ctx context.Context, opts ...Option) ([]Model, error) {
    models := make([]Model, 0)
    tx := d.optionDB(ctx, opts...).Find(&models)
    if tx.Error != nil {
        return nil, tx.Error
    }
    return models, nil
}

使用示例

md := new(ModelData)
list, _ := md.GetList(context.Background(),
    md.WithStaffId(1),
    md.WithUserId(2),
    md.WithLimit(3),
    md.WithOffset(4),
)

优势分析

1. 代码复用性：常用查询条件只需定义一次，多处使用
2. 可扩展性：可以轻松添加新的查询条件而不影响现有代码
3. 可读性：方法链式调用使查询意图更加清晰
4. 类型安全：通过Go的类型系统保证参数类型正确

进阶优化

在实际项目中，我们可以进一步优化这种模式：

1. 条件组合：支持AND/OR等逻辑组合
2. 条件缓存：对高频使用的条件进行缓存
3. 条件验证：在Option函数中添加参数验证逻辑
4. 性能监控：在Option中添加查询性能监控逻辑

总结

通过GORM的函数式选项模式，我们可以优雅地解决重复查询条件的问题。这种模式不仅适用于简单的WHERE条件，还可以扩展到排序、分页、字段选择等各种查询场景。在实际项目中，合理使用这种模式可以显著提高代码质量和开发效率。