MyBatis-Plus使用 wrapper.apply() 添加自定义 SQL 片段

在 MyBatis-Plus 中，wrapper.apply() 方法允许你在构建查询条件时插入任意的 SQL 片段。这对于实现一些复杂的查询需求特别有用，比如添加子查询、使用数据库特定函数等；

示例 1: 基本应用

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import java.util.List;

// 假设 User 是你的实体类
public List getUsersOlderThanAverage() {
    QueryWrapper queryWrapper = new QueryWrapper<>();
    
    // 使用 apply 方法添加自定义 SQL 片段
    queryWrapper.apply("age > (select avg(age) from user)");
    
    return userMapper.selectList(queryWrapper);
}

在这个例子中，apply 方法被用来添加一个子查询来计算平均年龄，并选择所有年龄大于平均年龄的用户。

示例 2: 使用占位符

为了提高安全性并避免 SQL 注入，推荐在 apply 方法中使用占位符 {} 来代替直接拼接变量。

Integer minAge = 20;
QueryWrapper queryWrapper = new QueryWrapper<>();

// 使用 apply 方法添加带参数的自定义 SQL 片段
queryWrapper.apply("age > {0}", minAge);

List users = userMapper.selectList(queryWrapper);

这里 {0} 是占位符，它会被 minAge 的值替换。如果有多个参数，可以依次使用 {1}, {2} 等。

示例 3: 结合其他条件

apply 方法可以与其他条件一起使用，比如 eq, gt, lt 等，以构建更复杂的查询逻辑。

String emailDomain = "example.com";
QueryWrapper queryWrapper = new QueryWrapper<>();

// 组合多种查询条件
queryWrapper.gt("age", 20)
            .isNotNull("email")
            .apply("email like {0}", "%"+emailDomain+"%");

List users = userMapper.selectList(queryWrapper);

在这个例子中，我们不仅检查了用户的年龄是否大于20岁以及邮箱是否非空，还添加了一个额外的条件来筛选邮箱包含特定域名的用户。

注意事项

• SQL 注入防护：虽然 apply 方法支持参数化查询，减少了 SQL 注入的风险，但在编写原生 SQL 时仍需小心。
• 字段名准确性：确保你指定的字段名与数据库中的列名完全匹配。如果实体类中的属性名与数据库列名不一致，可能需要使用数据库的实际列名。
• 复杂性管理：对于非常复杂的查询逻辑，尤其是涉及多个表连接的情况，考虑是否更适合直接在 XML 文件中定义 SQL 或者使用注解方式来实现。
• 分页查询：当结合分页查询使用时，请确保正确设置了 Page 对象，以便 MyBatis-Plus 可以为你的查询添加适当的分页信息。

分页查询的例子

如果你想对带有 apply 方法的查询进行分页，可以这样做：

import com.baomidou.mybatisplus.extension.plugins.pagination.Page;

Page page = new Page<>(1, 10); // 第1页，每页10条记录
QueryWrapper queryWrapper = new QueryWrapper<>();

// 添加自定义 SQL 片段
queryWrapper.apply("age > {0}", 20);

IPage resultPage = userMapper.selectPage(page, queryWrapper);

System.out.println("总记录数：" + resultPage.getTotal());
System.out.println("当前页数据：" + resultPage.getRecords());