MyBatis-Plus 中自定义 QueryWrapper 实现字段名驼峰转下划线

背景介绍

在使用 MyBatis-Plus 进行数据库操作时，QueryWrapper 是一个非常强大的查询条件构造器。在实际开发中，我们经常会遇到 Java 实体类使用驼峰命名法，而数据库字段使用下划线命名法的场景。虽然 MyBatis-Plus 默认支持这种映射，但有时我们需要在 QueryWrapper 中直接处理这种转换。

问题分析

默认情况下，QueryWrapper 的字段名处理方式是直接使用传入的字段名。当我们需要在 QueryWrapper 中自动将驼峰命名的字段转换为下划线格式时，就需要自定义 QueryWrapper 实现。

解决方案

我们可以通过继承 QueryWrapper 并重写相关方法来实现这一需求：

public class MyQueryWrapper<T> extends QueryWrapper<T> {
    
    @Override
    protected String columnToString(String column) {
        // 驼峰命名转换为下划线命名
        return StringUtils.camelToUnderline(column);
    }
    
    @Override
    protected QueryWrapper<T> instance() {
        return new MyQueryWrapper<>();
    }
}

关键点解析

1. columnToString 方法：这个方法负责将传入的字段名转换为最终的 SQL 字段名。我们在这里实现了驼峰到下滑线的转换逻辑。

2. instance 方法：这个方法非常重要，它决定了在构建嵌套查询条件时（如使用 and 或 or 方法时）创建的新 Wrapper 实例类型。如果不重写此方法，嵌套的 Wrapper 将会是普通的 QueryWrapper 而不是我们的 MyQueryWrapper。

使用示例

MyQueryWrapper<WarehouseInfo> wrapper = new MyQueryWrapper<>()
    .eq("status", 1)
    .and(w -> {
        w.in("provinceCode", areaCodes)
         .or()
         .in("cityCode", areaCodes)
         .or()
         .in("countyCode", areaCodes);
    });

在这个例子中，所有传入的字段名（如"provinceCode"、"cityCode"等）都会自动转换为下划线格式（如"province_code"、"city_code"）。

注意事项

1. 确保 StringUtils.camelToUnderline 方法能够正确处理各种驼峰命名情况
2. 如果字段名已经是下划线格式，转换方法应该能够识别并不做重复转换
3. 对于复杂的嵌套查询，instance 方法的正确实现保证了整个查询链中的字段名转换一致性

扩展思考

这种自定义 Wrapper 的方式不仅适用于字段名转换，还可以用于其他场景，例如：

• 自动添加租户ID过滤条件
• 实现逻辑删除的自动过滤
• 统一添加数据权限控制

通过继承和重写 QueryWrapper 的关键方法，我们可以灵活地扩展 MyBatis-Plus 的查询功能，满足各种业务场景的需求。