首页 > 软件编程 > java > MyBatis-Plus Wrapper自定义SQL

MyBatis-Plus中使用Wrapper自定义SQL的详细步骤

2025-07-11 10:55:32 作者：野犬寒鸦

在 MyBatis-Plus 中使用 Wrapper 自定义 SQL 可以灵活组合条件并复用条件逻辑,通过 ${ew.customSqlSegment} 占位符注入 Wrapper 生成的 SQL 片段,本文给大家介绍了详细步骤和示例,需要的朋友可以参考下

核心步骤

Mapper 接口定义方法 使用 @Param("ew") 注解声明 Wrapper 参数，在 SQL 中通过 ${ew.customSqlSegment} 引用条件。
XML 或注解编写 SQL 在 SQL 中嵌入 ${ew.customSqlSegment}，MyBatis-Plus 会自动替换为 Wrapper 生成的 WHERE 语句（包含 WHERE 关键字）。
Wrapper 构建条件 使用 QueryWrapper/LambdaQueryWrapper 组装条件，注意字段名与 SQL 中的别名一致。

示例一：XML 方式实现自定义 SQL

1. Mapper 接口声明

public interface UserMapper extends BaseMapper<User> {
    // 使用 @Param("ew") 定义 Wrapper 参数
    List<User> selectUserList(@Param("ew") Wrapper<User> wrapper);
}

2. XML 映射文件（如 UserMapper.xml）

<select id="selectUserList" resultType="User">
    SELECT id, name, age, email 
    FROM user 
    ${ew.customSqlSegment} <!-- 自动注入 WHERE 及条件 -->
</select>

3. 使用 Wrapper 构建查询

QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.like("name", "张")       // 模糊查询 name 包含"张"
       .gt("age", 20)            // age > 20
       .orderByDesc("create_time"); // 按创建时间倒序
 
List<User> users = userMapper.selectUserList(wrapper);

生成的 SQL：

SELECT id, name, age, email 
FROM user 
WHERE name LIKE '%张%' AND age > 20 
ORDER BY create_time DESC

示例二：注解方式实现自定义 SQL

Mapper 接口直接写 SQL

@Select("SELECT * FROM user ${ew.customSqlSegment}")
List<User> selectByWrapper(@Param("ew") Wrapper<User> wrapper);

示例三：联表查询 + Wrapper

1. Mapper 接口

List<UserVO> selectUserWithRole(@Param("ew") Wrapper<User> wrapper);

2. XML 映射文件

<select id="selectUserWithRole" resultType="UserVO">
    SELECT u.*, r.role_name 
    FROM user u
    LEFT JOIN role r ON u.role_id = r.id
    ${ew.customSqlSegment} <!-- 注入条件 -->
</select>

3. 使用 LambdaWrapper（避免硬编码字段名）

LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<>();
wrapper.like(User::getName, "王")     // 使用实体类方法引用
       .eq(User::getStatus, 1)        // status = 1
       .nested(i -> i.gt(User::getAge, 18).or().isNotNull(User::getEmail)); // 嵌套条件
 
List<UserVO> list = userMapper.selectUserWithRole(wrapper);