MyBatis动态SQL

最新推荐文章于 2025-05-21 13:14:36 发布
最新推荐文章于 2025-05-21 13:14:36 发布
阅读量323 收藏
点赞数
文章标签： mybatis sql mysql
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/Javaer000/article/details/126416241
版权
本文详细介绍了MyBatis的动态SQL功能，包括if、where、trim、choose、when、otherwise、foreach以及SQL片段的用法。通过实例展示了如何在不同场景下使用这些标签来拼接SQL，实现条件过滤、批量操作等功能。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

动态sql，就是MyBatis中有一些标签，可以帮助我们来拼接sql。

一、 if

if标签可通过test属性的表达式进行判断，若表达式的结果为true，则标签中的内容会执行；反之标签中的内容不会执行。
应用场景：表单展示中通过过滤条件展示数据。
比如可以根据年龄或者性别查询员工数据。
输入参数两种取值可能，空字符串和null。
**Example：**根据年龄，部门，或者性别过滤查询。
mapper中查询函数定义：

List<Employee> getEmpByFilter(@Param("filter")Filter filter);

过滤条件Filter定义为：

package com.lucky.mybatis.bean;

public class Filter {
    private String gender;

    private int age;

    private int departmentId;

    public Filter() {
    }

    public Filter(String gender, int age, int departmentId) {
        this.gender = gender;
        this.age = age;
        this.departmentId = departmentId;
    }

    public String getGender() {
        return gender;
    }

    public void setGender(String gender) {
        this.gender = gender;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public int getDepartmentId() {
        return departmentId;
    }

    public void setDepartmentId(int departmentId) {
        this.departmentId = departmentId;
    }

    @Override
    public String toString() {
        return "Filter{" +
                "gender='" + gender + '\'' +
                ", age=" + age +
                ", departmentId=" + departmentId +
                '}';
    }
}

xml文件sql定义为

 <select id="getEmpByFilter" resultMap="emp">
        select * from t_emp where
        <if test="filter.gender != null and filter.gender != '' ">
            gender = #{filter.gender}
        </if>

        <if test="filter.age != null and filter.age != '' ">
            and age = #{filter.age}
        </if>

        <if test="filter.departmentId != null and filter.departmentId != '' ">
            and demp_id = #{filter.departmentId}
        </if>
    </select>

测试类

 @Test
    public void testIf() {
        SqlSession sqlSession = SqlSessionUtils.getSqlSession();
        EmpMapper empMapper = sqlSession.getMapper(EmpMapper.class);
        Filter filter = new Filter("n", 22, 1);
        List<Employee> employees = empMapper.getEmpByFilter(filter);
        employees.forEach(System.out::println);
    }

上面这个测试类中，filter三个属性是全部传入的，那如果只传入两个呢？

 @Test
    public void testIf2() {
        SqlSession sqlSession = SqlSessionUtils.getSqlSession();
        EmpMapper empMapper = sqlSession.getMapper(EmpMapper.class);
        // 只用年龄和部门过滤
        Filter filter = new Filter( 22, 1);
        List<Employee> employees = empMapper.getEmpByFilter(filter);
        employees.forEach(System.out::println);
    }

这里就会出错，看一下Mybatis生成的sql语句为：
在这里插入图片描述where 后面多了一个and关键字。这时候就需要where标签来动态生成where条件了。

二、where

只使用if标签，第一个条件不传入，where后面直接跟了and，会报错。或者条件都不传入，这样生成sql中多了where标签。

方法1： 使用where标签，动态生成where关键字，并且去除生成sql中前多余的and关键字，如果条件都不成立，不生成where标签。
where标签通常和if标签结合使用。

 <select id="getEmpByFilter" resultMap="emp">
        select * from t_emp
        <where>
            <if test="filter.gender != null and filter.gender != '' ">
                gender = #{filter.gender}
            </if>

            <if test="filter.age != null and filter.age != '' ">
                and age = #{filter.age}
            </if>

            <if test="filter.departmentId != null and filter.departmentId != '' ">
                and demp_id = #{filter.departmentId}
            </if>
        </where>

生成sql语句为：
在这里插入图片描述

方法1： where 1=1

<select id="getEmpByFilter" resultMap="emp">
        select * from t_emp where 1=1
        <if test="filter.gender != null and filter.gender != '' ">
            gender = #{filter.gender}
        </if>

        <if test="filter.age != null and filter.age != '' ">
            and age = #{filter.age}
        </if>

        <if test="filter.departmentId != null and filter.departmentId != '' ">
            and demp_id = #{filter.departmentId}
        </if>
    </select>

生成sql语句为：
在这里插入图片描述

三、trim

如下所示，and 关键字放到if标签内容的后面。测试时过滤条件不传入最后一个书香。

 <select id="getEmpByFilter" resultMap="emp">
        select * from t_emp
        <where>
            <if test="filter.gender != null and filter.gender != '' ">
                gender = #{filter.gender} and
            </if>

            <if test="filter.age != null and filter.age != '' ">
                age = #{filter.age} and
            </if>

            <if test="filter.departmentId != null and filter.departmentId != '' ">
                demp_id = #{filter.departmentId}
            </if>
        </where>

    </select>

这样的话，生成sql如下所示。如果最后一个条件为空这样生成sql里面就多了一个and。
![在这里插入图片描述](https://img-blog.csdnimg.cn/1be62d2eaaec4222abd473cd547f8412.png
where无法去除后面and。。这时候就需要trim标签了。
常用属性：
prefix：在trim标签中的内容的前面添加某些内容
prefixOverrides：在trim标签中的内容的前面去掉某些内容
suffix：在trim标签中的内容的后面添加某些内容
suffixOverrides：在trim标签中的内容的后面去掉某些内容
我们需要在标签前加where，并且删除trim标签中后面多余的and。也就是：

 <select id="getEmpByFilter" resultMap="emp">
        select * from t_emp
        <trim prefix="where" suffixOverrides="and">
            <if test="filter.gender != null and filter.gender != '' ">
                gender = #{filter.gender} and
            </if>

            <if test="filter.age != null and filter.age != '' ">
                age = #{filter.age} and
            </if>

            <if test="filter.departmentId != null and filter.departmentId != '' ">
                demp_id = #{filter.departmentId}
            </if>
        </trim>

四、choose、when、otherwise

choose、when、 otherwise相当于if…else if…else
和if标签的区别：if每个条件都判断，choose、when、 otherwise只要有一个条件成立就不判断了。
when 至少一个， otherwise最多一个。

五、foreach

用来进行批量操作的标签
collections属性，如果参数没有使用@param指定参数名称，mybatis会自定将这个参数放到map中，并且key设置为list(假设传入参数类型为List)，array的话key就是array。所以访问的时候，要用list(array).

<foreach collection="list" item="emp" separator=",">

item 循环变量
index 下标
separator forEach循环中分割符
open、close 设置当前循环由什么开始，由什么结束
批量添加

/**
     * 批量插入员工信息
     *
     * @param employees employees
     * @return int
     */
    int insertEmps(@Param("emps") List<Employee> employees);

 <insert id="insertEmps"  useGeneratedKeys="true" keyProperty="id">
      insert into t_emp values
      <foreach collection="emps" item="emp" separator=",">
        (null, #{emp.name},#{emp.age},#{emp.gender}, #{emp.departmentId})
      </foreach>
    </insert>

批量删除
方法1： delete in
delete 的时候 in里面的所有id要被()包围起来，这样就需要close和open属性了。

<delete id="deleteEmpByIds">
        delete from t_emp where emp_id in
        <foreach collection="ids" item="empId" separator="," open="(" close=")">
            #{empId}
        </foreach>
    </delete>

方法2： where id = or id =

<delete id="deleteEmpByIds">
        delete from t_emp where
        <foreach collection="ids" item="empId" separator="or">
            emp_id = #{empId}
        </foreach>
    </delete>

六、SQL片段

sql片段，可以记录一段公共sql片段，在使用的地方通过include标签进行引入。

<sql id="empColumns">
		eid,ename,age,sex,did
</sql>
select <include refid="empColumns"></include> from t_emp
Aiwoniulucky
关注
mybatis 动态sql及参数传递
12-14
在实际开发过程中，我们往往需要编写复杂的SQL语句,拼接稍有不注意就会导致错误，Mybatis给开发者提供了动态SQL，大大降低了拼接SQL导致的错误。 动态标签 if标签 if标签通常用那个胡where语句,update语句,insert...
mybatis动态sql
04-28
MyBatis 提供了强大的动态 SQL 功能，它允许你根据参数的值来动态地构建 SQL 语句。这使得 SQL 语句更加灵活，能够适应不同的业务场景。 以下是一些常用的 MyBatis 动态 SQL 元素： <if>：用于条件判断。 xml ...
Mybatis——动态sql
weixin_45772572的博客
05-12 608
文章目录一、if标签二、where标签三、trim标签四、 choose、otherwize标签五、set标签六、foreach标签七、sql 一、if标签 条件判断标签 <select id="test" resultMap="BaseResultMap" parameterType="map"> select *from user where 1=1 <if test="username != null and username!= ''"> a
mybatisplus添加数据权限过滤（自定义拦截器，sql拦截）
猪之仆的博客
06-02 6174
import com.baomidou.mybatisplus.core.toolkit.PluginUtils; import com.baomidou.mybatisplus.extension.handlers.AbstractSqlParserHandler; import lombok.AllArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.apache.ibatis.executo...
拦截器实现mybatis补充过滤条件
zwrlj527的专栏
08-25 1539
怎么说能，没没这时候不得不夸赞下spring，这里这个拦截器的也是跟spring的生命周期有关。关于数据存库、查询的加密解密也可以用这个思路实现。这里其实也有一定的缺点，比如这里相当于增加了一层子查询，那么就会有性能的损失。其次也会影响数据库优化器的优化，索引的命中。这里除了分享，也是自己备忘。真的有点忙，就不多说，最近写博文都少了，55555。
mybatis拦截器修改SQL
weixin_50117915的博客
05-26 2761
平常我们写项目时应该都会遇到这么一个问题，一些接口需要根据账号权限的不同而展示不同的数据，又或者是SaaS化产品的租户，一般遇到这种情况，我们在写查询语句的时候，会加上相应的SQL来过滤掉不符合的数据，这样当然是可行的，但是基本上SQL都是相同的，所以就会造成会有很多重复的SQL片段，这样看起来也不太雅观，那有什么方法可以不写这么多重复的SQL吗？这一步就比较自由了，主要看大家的需求是怎样的，我这里就稍微弄个简单点的，注解里有一个参数，这个参数会拼接到原来的SQL上。
添加拦截器修改mybatis-plus SQL实现查询出被逻辑删除的数据
J_C_Y的博客
04-18 4113
mybatis-plus 查询被逻辑删除的数据
mybatis动态sql.zip
04-28
mybatis动态sql，动态sql解析引擎，类似mybatis动态sql的功能。 mybatis动态sql，动态sql解析引擎，类似mybatis动态sql的功能。mybatis动态sql，动态sql解析引擎，类似mybatis动态sql的功能。mybatis动态sql，...
mybatis动态SQL语句
04-28
if 、where、set、trim、choose 、foreach等在mybatis中的具体用法，有具体实例可供参考，玩转mybatis
自己动手实现mybatis动态sql的方法
08-28
自己动手实现MyBatis动态SQL的方法 MyBatis是当前最流行的持久化层框架之一，它提供了强大的动态SQL功能，能够根据实际情况生成不同的SQL语句。dynamic SQL是MyBatis的核心功能之一，它能够根据用户的输入参数生成...
Mybatis-plus自定义拦截器实现对查询的某个表增加固定搜索条件
qq_36677358的博客
01-05 3892
Mybatis-plus自定义拦截器实现对查询的某个表增加固定搜索条件
mybatis使用拦截器动态修改sql脚本(更新、插入、查询)
热门推荐
简单简单小白
03-02 1万+
MyBatis拦截器修改SQL语句 背景 最近公司项目想要做成一个云SaaS平台，需要不同用户能看到不同数据，需要做到数据的物理隔离。目前的方案就是在每张业务表中增加一个platform_id字段，来区分不同的租户，这就意味着在原来系统层面需要再增删改查都需要带上platform_id字段作为标识。如果在每个脚本上都手动加上这个字段的话那就太麻烦，太复杂了。所以就想使用mybatis 的拦截器Interceptor来实现。 准备 自定义注解@PlatformTag @PlatformTagIngore
多租户实现（2）mybatis拦截器及其执行顺序，sql全局添加tenantId
qq_42645279的博客
07-26 927
通过调试源码可以看到 xml的sql解析过程在Executor 之后，ParameterHandler之前。所以如果xml有如下形式的写法的时，并且没有使用Executor而只使用ParameterHandler，那么在解析xml时就会解析不到设置的参数。详细讨论mybatis的执行流程和sql的生命周期。ParameterHandler在解析xml的sql之后执行。在查询的时候也一样需要把参数加进去，下面的查询的写法。Executor 在解析xml的sql之前执行。下面是insert的拦截写法。
SQL过滤，防SQL注入
ugo
09-12 570
一般使用#{}，但在使用Mybatis的语法写动态排序时，由于#{}会导致参数带上’'，所以使用${}，但是又怕sql注入的问题，将传入的参数，过滤后再拼接SQL，会更安全一些。
Springboot 自定义 Mybatis拦截器，实现 动态查询条件SQL自动组装拼接（玩具）
默默不代表沉默
08-17 6449
Springboot 封装整活 Mybatis 动态查询条件SQL自动组装拼接
MybatisPlus的LambdaQueryWrapper用法
2301_79693537的博客
08-21 6168
【代码】MybatisPlus的LambdaQueryWrapper用法。
SQL 数值计算全解析：ABS、CEIL、FLOOR与ROUND函数深度精讲
最新发布
Musennn的博客
05-21 674
ABS函数：获取绝对值，处理负数场景CEIL与FLOOR函数：掌握向上/向下取整的方向逻辑ROUND函数：精确控制小数位数，注意进位规则NULL值处理：使用COALESCE函数增强健壮性。
关于 Web 漏洞原理与利用：1. SQL 注入（SQLi）
Triste__chengxi的博客
05-18 1129
在绕过技巧作用原理典型例子备注编码绕过URL/Unicode/Hex编码%27 OR 1=1绕过简单字符串检测注释绕过利用 SQL 注释符截断后续语句截断后续合法语句大小写绕过混合大小写关键字绕过大小写敏感规则双写绕过重复字符、转义利用转义规则混淆检测宽字节绕过利用多字节编码字符重叠针对 GBK 等中文编码环境延时注入利用延时函数判断盲注无需报错，仅靠响应时间判断。
PopSQL：一个支持团队协作的SQL开发工具
Tony.Dong的专栏
05-18 912
PopSQL 是一款专为团队协作设计的现代化 SQL 编辑器，通过通团队过协作编写 SQL 查询、交互式可视化以及共享结果提升数据分析和管理效率。
MyBatis动态SQL语句实践指南
【压缩包子文件的文件名称列表】中的 "mybatis-demo11-动态SQL语句" 表明这是一个关于 MyBatis 动态 SQL 的示例项目或教程。在该项目中，可能会有一个或多个 XML 配置文件，其中展示了如何使用 MyBatis 提供的动态 ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值