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);

生成的 SQL:

SELECT u.*, r.role_name 
FROM user u 
LEFT JOIN role r ON u.role_id = r.id 
WHERE (
    name LIKE '%王%' 
    AND status = 1 
    AND (age > 18 OR email IS NOT NULL)
)

注意事项

  • 防止 SQL 注入 ${ew.customSqlSegment} 内部使用预编译安全处理,但避免在 SQL 中直接拼接 ${xxx}(除 MyBatis-Plus 官方占位符外)。
  • 表别名问题 若 SQL 中使用别名(如 u.name),Wrapper 条件需同步声明别名:
wrapper.like("u.name", "张"); // XML 中表别名为 u
  • 空 Wrapper 处理 若 Wrapper 无条件,${ew.customSqlSegment} 生成空字符串,SQL 仍合法。
  • 复杂 SQL 场景 如需分组、聚合函数等,直接在 SQL 中编写,Wrapper 仅负责 WHERE 条件部分。

总结

  • 核心占位符${ew.customSqlSegment} 注入动态条件。
  • 条件构造:通过 QueryWrapper 或 LambdaWrapper 构建树状条件(支持 and/or 嵌套)。
  • 安全机制:MyBatis-Plus 自动处理参数预编译,防止注入风险。

此方案完美契合 MyBatis-Plus 设计哲学,在保留原生 MyBatis 灵活性的同时,极大简化动态 SQL 编写。

以上就是MyBatis-Plus中使用Wrapper自定义SQL的详细步骤的详细内容,更多关于MyBatis-Plus Wrapper自定义SQL的资料请关注脚本之家其它相关文章!

相关文章

  • java的前期绑定和后期绑定使用示例

    java的前期绑定和后期绑定使用示例

    java的前期绑定在程序执行前根据编译时类型绑定,调用开销较小,如C语言只有前期绑定这种方法调用
    2014-02-02
  • SpringBoot后台使用EasyExcel实现数据报表导出(含模板、样式、美化)

    SpringBoot后台使用EasyExcel实现数据报表导出(含模板、样式、美化)

    在企业级系统中,数据导出 Excel 是非常常见的需求,本文基于实际项目经验,分享如何使用 EasyExcel 实现复杂报表导出,包含支持按天/按小时导出数据、支持多 Sheet、多段写入等,下面小编给大家详细说说,需要的朋友可以参考下
    2025-05-05
  • java实现打砖块游戏算法

    java实现打砖块游戏算法

    这篇文章主要为大家详细介绍了java实现打砖块游戏算法,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-05-05
  • java类比C++的STL库详解

    java类比C++的STL库详解

    这篇文章主要介绍了java类比C++的STL库详解,标准模板库,是C++标准库的重要组成部分,中文可译为标准模板库或者泛型库,其包含有大量的模板类和模板函数,STL 是一些容器、算法和其他一些组件的集合,需要的朋友可以参考下
    2023-08-08
  • SpringMVC注解之@ResponseBody注解原理

    SpringMVC注解之@ResponseBody注解原理

    今天带大家分析一下@ResponseBody注解原理,文中有非常详细的介绍及代码示例,对正在学习java的小伙伴们很有帮助,需要的朋友可以参考下
    2021-05-05
  • Spring Security登录接口兼容JSON格式登录实现示例

    Spring Security登录接口兼容JSON格式登录实现示例

    前后端分离中,前端和后端的数据交互通常是JSON格式,本文主要介绍了Spring Security登录接口兼容JSON格式登录实现示例,具有一定的参考价值,感兴趣的可以了解一下
    2024-01-01
  • Springboot中集成Swagger2框架的方法

    Springboot中集成Swagger2框架的方法

    这篇文章主要介绍了Springboot中集成Swagger2框架的方法,非常不错,具有参考借鉴价值,需要的朋友可以参考下
    2017-12-12
  • 解决mybatis映射结果集失效的问题

    解决mybatis映射结果集失效的问题

    这篇文章主要介绍了解决mybatis映射结果集失效的问题,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-11-11
  • Java中i++的一些问题总结

    Java中i++的一些问题总结

    这篇文章主要给大家介绍了关于Java中i++的一些问题,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-12-12
  • Java实现DES加密与解密,md5加密以及Java实现MD5加密解密类

    Java实现DES加密与解密,md5加密以及Java实现MD5加密解密类

    这篇文章主要介绍了Java实现DES加密与解密,md5加密以及Java实现MD5加密解密类 ,需要的朋友可以参考下
    2015-11-11

最新评论