Mybatis深入了解----动态SQL

最新推荐文章于 2022-01-21 00:46:51 发布
最新推荐文章于 2022-01-21 00:46:51 发布
阅读量287 收藏
点赞数
分类专栏： mybatis 文章标签： Mybatis动态SQL
本文深入探讨MyBatis框架中的动态SQL特性，包括if、where、foreach等元素的使用，以及如何通过定义和引用SQL片段提高代码复用性和开发效率。通过具体实例，展示动态SQL在实际场景中的应用，如条件查询和批量ID查询。

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

 

什么是动态SQL?

    动态sql是mybatis的核心，主要是对sql语句进行灵活操作，通过表达式进行判断，对sql进行灵活的拼接、组装。 
    

实例

    用户信息综合查询列表和用户信息查询列表总数这两个statement的定义使用动态sql。对查询条件进行判断，如果输入参数不为空才进行查询条件拼接。

    

Mapper.xml

<span style="color:#000000"><code><span style="color:#880000"><!-- 用户信息综合查询
    #{userCustom.sex}:取出pojo包装对象中性别值
    ${userCustom.username}：取出pojo包装对象中用户名称
     --></span>
    <span style="color:#006666"><<span style="color:#4f4f4f">select</span> <span style="color:#4f4f4f">id</span>=<span style="color:#009900">"findUserList"</span> <span style="color:#4f4f4f">parameterType</span>=<span style="color:#009900">"cn.itcast.mybatis.po.UserQueryVo"</span> 
            <span style="color:#4f4f4f">resultType</span>=<span style="color:#009900">"cn.itcast.mybatis.po.UserCustom"</span>></span>
    SELECT * FROM USER
    <span style="color:#880000"><!-- 
    where可以自动去掉条件中的第一个and
     --></span>
    <span style="color:#006666"><<span style="color:#4f4f4f">where</span>></span>
        <span style="color:#006666"><<span style="color:#4f4f4f">if</span> <span style="color:#4f4f4f">test</span>=<span style="color:#009900">"userCustom!=null"</span>></span>
            <span style="color:#006666"><<span style="color:#4f4f4f">if</span> <span style="color:#4f4f4f">test</span>=<span style="color:#009900">"userCustom.sex!=null and userCustom.sex!=''"</span>></span>
                and user.sex = #{userCustom.sex}
            <span style="color:#006666"></<span style="color:#4f4f4f">if</span>></span>
            <span style="color:#006666"><<span style="color:#4f4f4f">if</span> <span style="color:#4f4f4f">test</span>=<span style="color:#009900">"userCustom.username!=null and userCustom.username!=''"</span>></span>
                and user.username LIKE '%${userCustom.username}%'
            <span style="color:#006666"></<span style="color:#4f4f4f">if</span>></span>
        <span style="color:#006666"></<span style="color:#4f4f4f">if</span>></span>
    <span style="color:#006666"></<span style="color:#4f4f4f">where</span>></span>


    <span style="color:#006666"></<span style="color:#4f4f4f">select</span>></span></code></span>
<span style="color:#000000"><code><span style="color:#006666"><<span style="color:#4f4f4f">select</span> <span style="color:#4f4f4f">id</span>=<span style="color:#009900">"findUserCount"</span> <span style="color:#4f4f4f">parameterType</span>=<span style="color:#009900">"cn.itcast.mybatis.po.UserQueryVo"</span> <span style="color:#4f4f4f">resultType</span>=<span style="color:#009900">"int"</span>></span>
       SELECT count(*) FROM USER 

      <span style="color:#880000"><!-- 
    where可以自动去掉条件中的第一个and
     --></span>
    <span style="color:#006666"><<span style="color:#4f4f4f">where</span>></span>
        <span style="color:#006666"><<span style="color:#4f4f4f">if</span> <span style="color:#4f4f4f">test</span>=<span style="color:#009900">"userCustom!=null"</span>></span>
            <span style="color:#006666"><<span style="color:#4f4f4f">if</span> <span style="color:#4f4f4f">test</span>=<span style="color:#009900">"userCustom.sex!=null and userCustom.sex!=''"</span>></span>
                and user.sex = #{userCustom.sex}
            <span style="color:#006666"></<span style="color:#4f4f4f">if</span>></span>
            <span style="color:#006666"><<span style="color:#4f4f4f">if</span> <span style="color:#4f4f4f">test</span>=<span style="color:#009900">"userCustom.username!=null and userCustom.username!=''"</span>></span>
                and user.username LIKE '%${userCustom.username}%'
            <span style="color:#006666"></<span style="color:#4f4f4f">if</span>></span>
        <span style="color:#006666"></<span style="color:#4f4f4f">if</span>></span>
    <span style="color:#006666"></<span style="color:#4f4f4f">where</span>></span>


    <span style="color:#006666"></<span style="color:#4f4f4f">select</span>></span></code></span>

    

测试代码

<span style="color:#000000"><code><span style="color:#880000">//用户信息的综合 查询</span>
    <span style="color:#9b859d">@Test</span>
    <span style="color:#000088">public</span> <span style="color:#000088">void</span> <span style="color:#009900">testFindUserList</span>() <span style="color:#000088">throws</span> Exception {

        SqlSession sqlSession = sqlSessionFactory.openSession();

        <span style="color:#880000">//创建UserMapper对象，mybatis自动生成mapper代理对象</span>
        UserMapper userMapper = sqlSession.getMapper(UserMapper.class);

        <span style="color:#880000">//创建包装对象，设置查询条件</span>
        UserQueryVo userQueryVo = <span style="color:#000088">new</span> UserQueryVo();
        UserCustom userCustom = <span style="color:#000088">new</span> UserCustom();
        <span style="color:#880000">//由于这里使用动态sql，如果不设置某个值，条件不会拼接在sql中</span>
        <span style="color:#880000">//userCustom.setSex("1");</span>
        userCustom.setUsername(<span style="color:#009900">"小明"</span>);
        userQueryVo.setUserCustom(userCustom);
        <span style="color:#880000">//调用userMapper的方法</span>

        List<UserCustom> list = userMapper.findUserList(userQueryVo);

        System.out.println(list);
    }</code></span>

    

sql片段

    将上边实现的动态sql判断代码块抽取出来，组成一个sql片段。其它的statement中就可以引用sql片段。方便程序员进行开发。 

定义sql片段

<span style="color:#000000"><code><span style="color:#880000"><!-- 定义sql片段
    id：sql片段的唯 一标识

    经验：是基于单表来定义sql片段，这样话这个sql片段可重用性才高
    在sql片段中不要包括 where
     --></span>
    <span style="color:#006666"><<span style="color:#4f4f4f">sql</span> <span style="color:#4f4f4f">id</span>=<span style="color:#009900">"query_user_where"</span>></span>
        <span style="color:#006666"><<span style="color:#4f4f4f">if</span> <span style="color:#4f4f4f">test</span>=<span style="color:#009900">"userCustom!=null"</span>></span>
            <span style="color:#006666"><<span style="color:#4f4f4f">if</span> <span style="color:#4f4f4f">test</span>=<span style="color:#009900">"userCustom.sex!=null and userCustom.sex!=''"</span>></span>
                and user.sex = #{userCustom.sex}
            <span style="color:#006666"></<span style="color:#4f4f4f">if</span>></span>
            <span style="color:#006666"><<span style="color:#4f4f4f">if</span> <span style="color:#4f4f4f">test</span>=<span style="color:#009900">"userCustom.username!=null and userCustom.username!=''"</span>></span>
                and user.username LIKE '%${userCustom.username}%'
            <span style="color:#006666"></<span style="color:#4f4f4f">if</span>></span>
        <span style="color:#006666"></<span style="color:#4f4f4f">if</span>></span>
    <span style="color:#006666"></<span style="color:#4f4f4f">sql</span>></span></code></span>

引用sql片段

<span style="color:#000000"><code><span style="color:#880000"><!-- 用户信息综合查询
    #{userCustom.sex}:取出pojo包装对象中性别值
    ${userCustom.username}：取出pojo包装对象中用户名称
     --></span>
    <span style="color:#006666"><<span style="color:#4f4f4f">select</span> <span style="color:#4f4f4f">id</span>=<span style="color:#009900">"findUserList"</span> <span style="color:#4f4f4f">parameterType</span>=<span style="color:#009900">"cn.itcast.mybatis.po.UserQueryVo"</span> 
            <span style="color:#4f4f4f">resultType</span>=<span style="color:#009900">"cn.itcast.mybatis.po.UserCustom"</span>></span>
    SELECT * FROM USER
    <span style="color:#880000"><!-- 
    where可以自动去掉条件中的第一个and
     --></span>
    <span style="color:#006666"><<span style="color:#4f4f4f">where</span>></span>
        <span style="color:#880000"><!-- 引用sql片段 的id，如果refid指定的id不在本mapper文件中，需要前边加namespace --></span>
        <span style="color:#006666"><<span style="color:#4f4f4f">include</span> <span style="color:#4f4f4f">refid</span>=<span style="color:#009900">"query_user_where"</span>></span><span style="color:#006666"></<span style="color:#4f4f4f">include</span>></span>
        <span style="color:#880000"><!-- 在这里还要引用其它的sql片段  --></span>
    <span style="color:#006666"></<span style="color:#4f4f4f">where</span>></span>


    <span style="color:#006666"></<span style="color:#4f4f4f">select</span>></span></code></span>

    其中的关键是这一句引用：

<span style="color:#000000"><code><span style="color:#880000"><!-- 引用sql片段 的id，如果refid指定的id不在本mapper文件中，需要前边加namespace --></span>
<span style="color:#006666"><<span style="color:#4f4f4f">include</span> <span style="color:#4f4f4f">refid</span>=<span style="color:#009900">"query_user_where"</span>></span><span style="color:#006666"></<span style="color:#4f4f4f">include</span>></span></code></span>

    

foreach

     
向sql传递数组或List，mybatis使用foreach解析 

应用场景

    在用户查询列表和查询总数的statement中增加多个id输入查询。 
    类似下面的sql语句：

<span style="color:#000000"><code><span style="color:#000088">SELECT</span> * <span style="color:#000088">FROM</span> <span style="color:#000088">USER</span> <span style="color:#000088">WHERE</span> id=<span style="color:#006666">1</span> <span style="color:#000088">OR</span> id=<span style="color:#006666">10</span> <span style="color:#000088">OR</span> id=<span style="color:#006666">16</span>

<span style="color:#000088">SELECT</span> * <span style="color:#000088">FROM</span> <span style="color:#000088">USER</span> <span style="color:#000088">WHERE</span> id <span style="color:#000088">IN</span>(<span style="color:#006666">1</span>,<span style="color:#006666">10</span>,<span style="color:#006666">16</span>)
</code></span>

在输入参数类型中添加List ids传入多个id

<span style="color:#000000"><code><span style="color:#000088">public</span> <span style="color:#000088">class</span> UserQueryVo {

    <span style="color:#880000">//传入多个id</span>
    <span style="color:#000088">private</span> List<Integer> ids;
</code></span>

修改Mapper.xml

    WHERE id=1 OR id=10 OR id=16，在查询条件中，查询条件定义成一个sql片段，需要修改sql片段。

<span style="color:#000000"><code><span style="color:#006666"><<span style="color:#4f4f4f">if</span> <span style="color:#4f4f4f">test</span>=<span style="color:#009900">"ids!=null"</span>></span>
            <span style="color:#880000"><!-- 使用 foreach遍历传入ids
            collection：指定输入 对象中集合属性
            item：每个遍历生成对象中
            open：开始遍历时拼接的串
            close：结束遍历时拼接的串
            separator：遍历的两个对象中需要拼接的串
             --></span>
             <span style="color:#880000"><!-- 使用实现下边的sql拼接：
              AND (id=1 OR id=10 OR id=16) 
              --></span>
            <span style="color:#006666"><<span style="color:#4f4f4f">foreach</span> <span style="color:#4f4f4f">collection</span>=<span style="color:#009900">"ids"</span> <span style="color:#4f4f4f">item</span>=<span style="color:#009900">"user_id"</span> <span style="color:#4f4f4f">open</span>=<span style="color:#009900">"AND ("</span> <span style="color:#4f4f4f">close</span>=<span style="color:#009900">")"</span> <span style="color:#4f4f4f">separator</span>=<span style="color:#009900">"or"</span>></span>
                <span style="color:#880000"><!-- 每个遍历需要拼接的串 --></span>
                id=#{user_id}
            <span style="color:#006666"></<span style="color:#4f4f4f">foreach</span>></span>
</code></span>

测试代码

    修改上面的测试方法，传入多个id进行测试。

<span style="color:#000000"><code>    <span style="color:#880000">//创建包装对象，设置查询条件</span>
    UserQueryVo userQueryVo <span style="color:#4f4f4f">=</span> <span style="color:#006666">new</span> UserQueryVo();
    UserCustom userCustom <span style="color:#4f4f4f">=</span> <span style="color:#006666">new</span> UserCustom();
    <span style="color:#880000">//由于这里使用动态sql，如果不设置某个值，条件不会拼接在sql中</span>
    <span style="color:#880000">//userCustom.setSex("1");</span>
    userCustom<span style="color:#4f4f4f">.</span>setUsername(<span style="color:#009900">"小明"</span>);
    <span style="color:#880000">//传入多个id</span>
    <span style="color:#4f4f4f">List</span><span style="color:#4f4f4f"><</span><span style="color:#4f4f4f">Integer</span><span style="color:#4f4f4f">></span> ids <span style="color:#4f4f4f">=</span> <span style="color:#006666">new</span> ArrayList<span style="color:#4f4f4f"><</span><span style="color:#4f4f4f">Integer</span><span style="color:#4f4f4f">></span>();
    ids<span style="color:#4f4f4f">.</span>add(<span style="color:#006666">1</span>);
    ids<span style="color:#4f4f4f">.</span>add(<span style="color:#006666">10</span>);
    ids<span style="color:#4f4f4f">.</span>add(<span style="color:#006666">16</span>);
    <span style="color:#880000">//将ids通过userQueryVo传入statement中</span>
    userQueryVo<span style="color:#4f4f4f">.</span>setIds(ids);
    userQueryVo<span style="color:#4f4f4f">.</span>setUserCustom(userCustom);
    <span style="color:#880000">//调用userMapper的方法</span>

    <span style="color:#4f4f4f">List</span><span style="color:#4f4f4f"><</span>UserCustom<span style="color:#4f4f4f">></span> <span style="color:#4f4f4f">list</span> <span style="color:#4f4f4f">=</span> userMapper<span style="color:#4f4f4f">.</span>findUserList(userQueryVo);

    System<span style="color:#4f4f4f">.</span>out<span style="color:#4f4f4f">.</span>println(<span style="color:#4f4f4f">list</span>);</code></span>
MyBatis学习 - 动态 sql
TyuIn的博客
12-11 660
动态 SQL 是 MyBatis 的强大特性之一。如果你使用过 JDBC 或其它类似的框架，你应该能理解根据不同条件拼接 SQL 语句有多痛苦，例如拼接时要确保不能忘记添加必要的空格，还要注意去掉列表最后一个列名的逗号。利用动态 SQL，可以彻底摆脱这种痛苦。 如果你之前用过 JSTL 或任何基于类 XML 语言的文本处理器，你对动态 SQL 元素可能会感觉似曾相识。在 MyBatis 之前的版本中，需要花时间了解大量的元素。借助功能强大的基于 OGNL 的表达式，MyBatis 3 替换了之前的大部分元素
mybatis框架之动态sql的详细说明
刘小爱的博客
08-10 777
刘小爱学习Java的第117天
Mybatis框架-----动态SQL
qq_48788523的博客
01-21 1031
Mybatis的动态SQL，有你想要的
【源码解析】谈谈你对 MyBatis动态SQL 的理解
小明的Java问道之路
09-25 1110
你知道Mybatis动态sql是做什么，都有哪些？动态sql的执行原理吗？
对Mybatis的深入了解
疯人愿
09-12 334
Mybatis 什么是Mybatis MyBatis 是一款优秀的持久层框架，它支持定制化 SQL、存储过程、高级映射以及动态SQL。MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。MyBatis 可以对配置和原生Map使用简单的 XML 、半XML半注解和全注解的方式，将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java...
Mybatis 深入理解
zzqtty的博客
04-23 229
1. 新增返回主键 1.1 在自增主键使用 useGenerateKeys 1.2 使用函数LAST_INSERT_ID 使用于主键不能自增 2.bind用法 bind标签可以使用 OGNL 表达式创建一个变量并将其绑定到上下文中。在前面的例子中，UserMapper.xml 有一个selectByUser方法，这个方法用到了like查询条件，部分代码如下。 <if test="userName != null and userName != ''"&g...
Mybatis框架-----＞(6) 深入理解Mybatis的动态SQL语句
hcz666的博客
01-25 636
一、动态SQL语句 何为动态SQL语句： 通过mybatis提供的< if > ,< where >,< foreach >标签对条件做出判断以实现动态拼接SQL语句，主要用于解决查询条件不确定的情况，它会根据用户提交的查询条件进行查询。其主要是SQL语句where关键字后面部分发生变化。 注意事项： 在映射文件中的动态 SQL 中若出现大于号（>）、小于号（<）、大于等于号（>=），小于等于号（<=）等符号，最好将其转换为实体符
mybatis-3-config.dtd mybatis-3-mapper.dtd
06-04
`parameterMap`元素则用来处理参数，尽管在MyBatis 3.2版本后已被动态SQL替代，但了解其历史用法仍然有所帮助。 在MyBatis中，这两个DTD文件的作用是确保XML配置的正确性，它们为XML解析器提供了关于有效元素和属性...
mybatis-3-mapper.rar
08-06
在处理`mybatis-3-mapper.dtd`这个问题时，我们需要深入理解MyBatis的Mapper体系以及DTD的作用。 首先，`mybatis-3-mapper.dtd`是MyBatis中用于验证XML映射文件的文档类型定义（Document Type Definition）。在XML...
mybatis-plus-join-SQL资源
最新发布
02-24
"Mybatis-plus-join-SQL资源"对于希望深入学习和掌握MyBatis-Plus框架中的join操作，并将其应用到实际开发中的开发人员来说，是一套非常有价值的参考资料。通过这些资源的学习，开发人员可以更好地理解join操作的...
Mybatis-ehcache 1.2.1源码（ehcache-cache-mybatis-ehcache-1.2.1.zip）
07-05
2. **配置**：了解如何在Mybatis的配置文件中设置Ehcache，包括设置缓存的策略（如时间过期、容量限制等），以及如何关联到特定的Mapper或全局配置。 3. **缓存操作**：Mybatis-ehcache如何进行缓存的读取、写入和...
Mybatis学习小结（三）动态SQL
weixin_44541247的博客
05-16 339
动态 SQL 是 MyBatis 的强大特性之一。如果使用过 JDBC 或其它类似的框架，应该能理解根据不同条件拼接 SQL 语句有多痛苦，例如拼接时要确保不能忘记添加必要的空格，还要注意去掉列表最后一个列名的逗号。利用动态 SQL，可以彻底摆脱这种痛苦 使用动态 SQL 并非一件易事，但借助可用于任何 SQL 映射语句中的强大的动态 SQL 语言，MyBatis 显著地提升了这一特性的易用性。说直白一点动态SQL就是指根据不同的条件生成不同的SQL语句本质上还是SQL语句，只是我们可以在SQL层面上去执行
mybatis动态SQL语句的优缺点：
weixin_50483564的博客
11-25 1607
什么是Mybatis? Mybatis 是一个半 ORM（对象关系映射）框架，它内部封装了 JDBC，开发时 只需要关注 SQL 语句本身，不需要花费精力去处理加载驱动、创建连接、创建 statement 等繁杂的过程。程序员直接编写原生态 sql，可以严格控制 sql 执行性 能，灵活度高。 MyBatis 可以使用 XML 或注解来配置和映射原生信息，将 POJO 映射成数 据库中的记录，避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集。 通过 xml 文件或注解的方式将要执行的各种
MyBatis学习（3）——理解动态SQL
m0_38140207的博客
07-07 263
动态SQL 动态 SQL是MyBatis强大特性之一。极大的简化我们拼装SQL的操作。 MyBatis 采用功能强大的基于 OGNL 的表达式来简化操作。 ①if ②choose (when, otherwise) ③trim (where, set) ④foreach if、where、trim等 ①<if>判断，标签内的test=""编写判断条件 ②<where>用于代替sql语句中的where，可去掉前面的and; ③<trim>截取字符串，标签内的 pref
Mybatis-动态SQL的理解及使用
Ara_Hu的博客
03-09 469
动态SQL 动态 SQL 是 MyBatis 的强大特性之一。如果你使用过 JDBC 或其它类似的框架，你应该能理解根据不同条件拼接 SQL 语句有多痛苦，例如拼接时要确保不能忘记添加必要的空格，还要注意去掉列表最后一个列名的逗号。利用动态 SQL，可以彻底摆脱这种痛苦。 在博主看来，所谓动态SQL就是可以在不同的条件下拼接出不同的SQL语句。 Mybatis中主要包含以下这些设置动态SQL的...
深入理解mybatis
GeekSnow的博客
08-15 4598
个人关于mybatis的理解
《深入理解mybatis原理(十二)》 mybatis深入理解之#与$区别
pfnie的博客
11-19 1万+
一、介绍       mybatis 中使用 Mapper.xml里面的配置进行 sql 查询，经常需要动态传递参数，例如我们需要根据用户的姓名来筛选用户时，sql 如下： select * from user where name = "Jack";上述 sql 中，我们希望 name 后的参数 "Jack" 是动态可变的，即不同的时刻根据不同的姓名来查询用户。在 Ma
《深入理解mybatis原理》 MyBatis的架构设计以及实例分析
热门推荐
我的程序人生(亦山札记)
11-04 17万+
MyBatis是目前非常流行的ORM框架，它的功能很强大，然而其实现却比较简单、优雅。本文主要讲述MyBatis的架构设计思路，并且讨论MyBatis的几个核心部件，然后结合一个select查询实例，深入代码，来探究MyBatis的实现。
通过项目逐步深入了解Mybatis(四)
weixin_33730836的博客
12-06 183
相关阅读： 1、通过项目逐步深入了解Mybatis<一> 2、通过项目逐步深入了解Mybatis<二> 3、通过项目逐步深入了解Mybatis<三> 本项目所有代码及文档都托管在 Github地址：https://github.com/zhisheng17/mybatis 延迟加载 什么是延迟加载？ r...
免费下载Mybatis-generator-1.3.6.jar
Mybatis Generator是一款Mybatis官方提供的代码生成工具，它可以根据数据库表的结构信息，...对于Mybatis的深入了解，开发者应当查阅官方文档和源代码，以及在使用过程中不断积累经验，提升自身的开发效率和代码质量。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值