MyBatis的动态SQL详解

标签： mybatis sql | 发表时间：2013-11-16 16:45 | 作者：ljl8086
出处：http://www.iteye.com

基础部分可以查看我的另一篇博客： http://haohaoxuexi.iteye.com/blog/1333271

 

MyBatis的动态SQL是基于OGNL表达式的，它可以帮助我们方便的在SQL语句中实现某些逻辑。

MyBatis中用于实现动态SQL的元素主要有：

 

  • if
  • choose（when，otherwise）
  • trim
  • where
  • set
  • foreach
if就是简单的条件判断，利用if语句我们可以实现某些简单的条件选择。先来看如下一个例子：
Xml代码   收藏代码
  1. <select id="dynamicIfTest" parameterType="Blog" resultType="Blog">  
  2.     select * from t_blog where 11 = 1  
  3.     <if test="title != null">  
  4.         and title = #{title}  
  5.     </if>  
  6.     <if test="content != null">  
  7.         and content = #{content}  
  8.     </if>  
  9.     <if test="owner != null">  
  10.         and owner = #{owner}  
  11.     </if>  
  12. </select>  
这条语句的意思非常简单，如果你提供了title参数，那么就要满足title=#{title}，同样如果你提供了Content和Owner的时候，它们也需要满足相应的条件，之后就是返回满足这些条件的所有Blog，这是非常有用的一个功能，以往我们使用其他类型框架或者直接使用JDBC的时候， 如果我们要达到同样的选择效果的时候，我们就需要拼SQL语句，这是极其麻烦的，比起来，上述的动态SQL就要简单多了。
 
choose元素的作用就相当于JAVA中的switch语句，基本上跟JSTL中的choose的作用和用法是一样的，通常都是与when和otherwise搭配的。看如下一个例子：
Xml代码   收藏代码
  1. <select id="dynamicChooseTest" parameterType="Blog" resultType="Blog">  
  2.     select * from t_blog where 11 = 1   
  3.     <choose>  
  4.         <when test="title != null">  
  5.             and title = #{title}  
  6.         </when>  
  7.         <when test="content != null">  
  8.             and content = #{content}  
  9.         </when>  
  10.         <otherwise>  
  11.             and owner = "owner1"  
  12.         </otherwise>  
  13.     </choose>  
  14. </select>  
when元素表示当when中的条件满足的时候就输出其中的内容，跟JAVA中的switch效果差不多的是按照条件的顺序，当when中有条件满足的时候，就会跳出choose，即所有的when和otherwise条件中，只有一个会输出，当所有的我很条件都不满足的时候就输出otherwise中的内容。所以上述语句的意思非常简单， 当title!=null的时候就输出and titlte = #{title}，不再往下判断条件，当title为空且content!=null的时候就输出and content = #{content}，当所有条件都不满足的时候就输出otherwise中的内容。
 
where语句的作用主要是简化SQL语句中where中的条件判断的，先看一个例子，再解释一下where的好处。
Xml代码   收藏代码
  1. <select id="dynamicWhereTest" parameterType="Blog" resultType="Blog">  
  2.     select * from t_blog   
  3.     <where>  
  4.         <if test="title != null">  
  5.             title = #{title}  
  6.         </if>  
  7.         <if test="content != null">  
  8.             and content = #{content}  
  9.         </if>  
  10.         <if test="owner != null">  
  11.             and owner = #{owner}  
  12.         </if>  
  13.     </where>  
  14. </select>  
 where元素的作用是会在写入where元素的地方输出一个where，另外一个好处是你不需要考虑where元素里面的条件输出是什么样子的，MyBatis会智能的帮你处理，如果所有的条件都不满足那么MyBatis就会查出所有的记录，如果输出后是and 开头的，MyBatis会把第一个and忽略，当然如果是or开头的，MyBatis也会把它忽略；此外，在where元素中你不需要考虑空格的问题，MyBatis会智能的帮你加上。像上述例子中，如果title=null， 而content != null，那么输出的整个语句会是select * from t_blog where content = #{content}，而不是select * from t_blog where and content = #{content}，因为MyBatis会智能的把首个and 或 or 给忽略。
 
trim元素的主要功能是可以在自己包含的内容前加上某些前缀，也可以在其后加上某些后缀，与之对应的属性是prefix和suffix；可以把包含内容的首部某些内容覆盖，即忽略，也可以把尾部的某些内容覆盖，对应的属性是prefixOverrides和suffixOverrides；正因为trim有这样的功能，所以我们也可以非常简单的利用trim来代替where元素的功能，示例代码如下：
Xml代码   收藏代码
  1. <select id="dynamicTrimTest" parameterType="Blog" resultType="Blog">  
  2.     select * from t_blog   
  3.     <trim prefix="where" prefixOverrides="and |or">  
  4.         <if test="title != null">  
  5.             title = #{title}  
  6.         </if>  
  7.         <if test="content != null">  
  8.             and content = #{content}  
  9.         </if>  
  10.         <if test="owner != null">  
  11.             or owner = #{owner}  
  12.         </if>  
  13.     </trim>  
  14. </select>  
 
set元素主要是用在更新操作的时候，它的主要功能和where元素其实是差不多的，主要是在包含的语句前输出一个set，然后如果包含的语句是以逗号结束的话将会把该逗号忽略，如果set包含的内容为空的话则会出错。有了set元素我们就可以动态的更新那些修改了的字段。下面是一段示例代码：
Xml代码   收藏代码
  1. <update id="dynamicSetTest" parameterType="Blog">  
  2.     update t_blog  
  3.     <set>  
  4.         <if test="title != null">  
  5.             title = #{title},  
  6.         </if>  
  7.         <if test="content != null">  
  8.             content = #{content},  
  9.         </if>  
  10.         <if test="owner != null">  
  11.             owner = #{owner}  
  12.         </if>  
  13.     </set>  
  14.     where id = #{id}  
  15. </update>  
 上述示例代码中，如果set中一个条件都不满足，即set中包含的内容为空的时候就会报错。
 
foreach的主要用在构建in条件中，它可以在SQL语句中进行迭代一个集合。foreach元素的属性主要有item，index，collection，open，separator，close。item表示集合中每一个元素进行迭代时的别名，index指定一个名字，用于表示在迭代过程中，每次迭代到的位置，open表示该语句以什么开始，separator表示在每次进行迭代之间以什么符号作为分隔符，close表示以什么结束，在使用foreach的时候最关键的也是最容易出错的就是collection属性，该属性是必须指定的，但是在不同情况下，该属性的值是不一样的，主要有一下3种情况：
  1. 如果传入的是单参数且参数类型是一个List的时候，collection属性值为list
  2. 如果传入的是单参数且参数类型是一个array数组的时候，collection的属性值为array
  3. 如果传入的参数是多个的时候，我们就需要把它们封装成一个Map了， 当然单参数也可以封装成map，实际上如果你在传入参数的时候，在MyBatis里面也是会把它封装成一个Map的，map的key就是参数名，所以这个时候collection属性值就是传入的List或array对象在自己封装的map里面的key
下面分别来看看上述三种情况的示例代码：
1.单参数List的类型：
Xml代码   收藏代码
  1. <select id="dynamicForeachTest" resultType="Blog">  
  2.     select * from t_blog where id in  
  3.     <foreach collection="list" index="index" item="item" open="(" separator="," close=")">  
  4.         #{item}  
  5.     </foreach>  
  6. </select>  
 上述collection的值为list，对应的Mapper是这样的
Java代码   收藏代码
  1. public List<Blog> dynamicForeachTest(List<Integer> ids);  
 测试代码：
Java代码   收藏代码
  1. @Test  
  2. public void dynamicForeachTest() {  
  3.     SqlSession session = Util.getSqlSessionFactory().openSession();  
  4.     BlogMapper blogMapper = session.getMapper(BlogMapper.class);  
  5.     List<Integer> ids = new ArrayList<Integer>();  
  6.     ids.add(1);  
  7.     ids.add(3);  
  8.     ids.add(6);  
  9.     List<Blog> blogs = blogMapper.dynamicForeachTest(ids);  
  10.     for (Blog blog : blogs)  
  11.         System.out.println(blog);  
  12.     session.close();  
  13. }  
 
2.单参数array数组的类型：
Xml代码   收藏代码
  1. <select id="dynamicForeach2Test" resultType="Blog">  
  2.     select * from t_blog where id in  
  3.     <foreach collection="array" index="index" item="item" open="(" separator="," close=")">  
  4.         #{item}  
  5.     </foreach>  
  6. </select>  
 上述collection为array，对应的Mapper代码：
Java代码   收藏代码
  1. public List<Blog> dynamicForeach2Test(int[] ids);  
 对应的测试代码：
Java代码   收藏代码
  1. @Test  
  2. public void dynamicForeach2Test() {  
  3.     SqlSession session = Util.getSqlSessionFactory().openSession();  
  4.     BlogMapper blogMapper = session.getMapper(BlogMapper.class);  
  5.     int[] ids = new int[] {1,3,6,9};  
  6.     List<Blog> blogs = blogMapper.dynamicForeach2Test(ids);  
  7.     for (Blog blog : blogs)  
  8.         System.out.println(blog);  
  9.     session.close();  
  10. }  
 
3.自己把参数封装成Map的类型
Xml代码   收藏代码
  1. <select id="dynamicForeach3Test" resultType="Blog">  
  2.     select * from t_blog where title like "%"#{title}"%" and id in  
  3.     <foreach collection="ids" index="index" item="item" open="(" separator="," close=")">  
  4.         #{item}  
  5.     </foreach>  
  6. </select>  
上述collection的值为ids，是传入的参数Map的key，对应的Mapper代码：
Java代码   收藏代码
  1. public List<Blog> dynamicForeach3Test(Map<String, Object> params);  
  对应测试代码：
Java代码   收藏代码
  1. @Test  
  2. public void dynamicForeach3Test() {  
  3.     SqlSession session = Util.getSqlSessionFactory().openSession();  
  4.     BlogMapper blogMapper = session.getMapper(BlogMapper.class);  
  5.     final List<Integer> ids = new ArrayList<Integer>();  
  6.     ids.add(1);  
  7.     ids.add(2);  
  8.     ids.add(3);  
  9.     ids.add(6);  
  10.     ids.add(7);  
  11.     ids.add(9);  
  12.     Map<String, Object> params = new HashMap<String, Object>();  
  13.     params.put("ids", ids);  
  14.     params.put("title", "中国");  
  15.     List<Blog> blogs = blogMapper.dynamicForeach3Test(params);  
  16.     for (Blog blog : blogs)  
  17.         System.out.println(blog);  
  18.     session.close();  
  19. }  
 


已有 0 人发表留言，猛击->> 这里<<-参与讨论


ITeye推荐



相关 [mybatis sql] 推荐：

MyBatis的动态SQL详解

- - 编程语言 - ITeye博客
基础部分可以查看我的另一篇博客： http://haohaoxuexi.iteye.com/blog/1333271. MyBatis的动态SQL是基于OGNL表达式的，它可以帮助我们方便的在SQL语句中实现某些逻辑. MyBatis中用于实现动态SQL的元素主要有：. if就是简单的条件判断，利用if语句我们可以实现某些简单的条件选择.

Mybatis实用Mapper SQL汇总示例

- - 开源软件 - ITeye博客
批量操作主要使用的是Mybatis的foreach，遍历参数列表执行相应的操作，所以批量插入/更新/删除的写法是类似的，只是SQL略有区别而已. MySql批量操作需要数据库连接配置allowMultiQueries=true才可以. 上面演示的是MySql的写法(表主键自增的写法)，因为MySql支持主键自增，所以直接设置useGeneratedKeys=true，即可在插入数据时自动实现主键自增；不需要自增时就不需要设置useGeneratedKeys，而且插入SQL包含所有字段即可.

使用Log4jdbc-log4j2监听MyBatis中运行的SQL和Connection

- - CSDN博客数据库推荐文章
引言： 在项目中使用了MyBatis，一个比较苦恼的问题是无法看到执行的SQL的具体情况，所以，就找到了Log4jdbc-log4j2. 这个是一个基于jdbc层面的监听工具，可以监听对于数据库的主要操作，从而完美的查看到其中执行的操作. Log4jdbc-log4j2版本选择.      如果项目是基于Maven工具，则可以直接使用如下依赖，即可完美解决问题：.

mybatis-generator配置

- - 开源软件 - ITeye博客
新项目要用mybatis，为了开发效率和方便开发，研究了mybatis-generate，在maven环境下，通过插件的形式配置，废话不多说. .    由于M2e不支持这个goal，会报错，忽略这个goal就好了，具体原因请看：. 解决办法把下面这段配置添加到与plugins平级目录中即可解决：.

Spring+MyBatis实践——MyBatis访问数据库

- - 开源软件 - ITeye博客
    在http://dufengx201406163237.iteye.com/blog/2102054中描述了工程的配置，在此记录一下如何使用MyBatis访问数据库；. . .

ibatis和mybatis区别

- - SQL - 编程语言 - ITeye博客
简介： 本文主要讲述了 iBatis 2.x 和 MyBatis 3.0.x 的区别，以及从 iBatis 向 MyBatis 移植时需要注意的地方. 通过对本文的学习，读者基本能够了解 MyBatis 有哪些方面的改进，并能够顺利使用 MyBatis 进行开发. 本文更适合有 iBatis 基础的开发人员阅读.

iBatis与MyBatis区别

- - 非技术 - ITeye博客
iBatis 框架的主要优势：. 1、iBatis 封装了绝大多数的 JDBC 样板代码，使得开发者只需关注 SQL 本身，而不需要花费精力去处理例如注册驱动，创建 Connection，以及确保关闭 Connection 这样繁杂的代码. 2、从 iBatis 到 MyBatis，不只是名称上的变化，MyBatis 提供了更为强大的功能，同时并没有损失其易用性，相反，在很多地方都借助于 JDK 的泛型和注解特性进行了简化.

mybatis oracle mysql 批量插入

- - Oracle - 数据库 - ITeye博客
一、oracle的批量插入方式. 二、mysql的批量插入方式. ORA-00918:未明确定义列. 如果不设置列名，那么#{item.senderPhone}的值就是默认列名，那么就有很多概率会产生列名重复，而产生异常. （两个列的值完全可能一样）. #{item.receiveTime} 值为null时，必须指定转换类型.

Mybatis查询延迟加载

- - Elim的个人空间
Mybatis 查询延迟加载. 1.1        启用延迟加载. 1.2        分析.        Mybatis的延迟加载是针对嵌套查询而言的，是指在进行查询的时候先只查询最外层的SQL，对于内层SQL将在需要使用的时候才查询出来. Mybatis的延迟加载默认是关闭的，即默认是一次就将所有的嵌套SQL一并查了将对象所有的信息都查询出来.

spring +mybatis读写分离

- - 编程语言 - ITeye博客
一、配置定义数据库连接属性. .     .     .     .     .         . .