Mybatis学习笔记之动态SQL揭秘

前言

MyBatis 的强大特性之一便是它的动态 SQL。所以今天小编在这里为大家介绍一下Mybatis的一个强大功能-动态SQL

动态SQL是Mybatis的一个强大的特性，在使用JDBC操作数据时，如果查询条件特别多，将条件串联成SQL字符串是一件非常痛苦的事情，通常的解决方法使写很多的if-else条件语句去判断和拼接，并确保不能忘了空格或在字段的最后省略逗号。Mybatis使用一种强大的动态SQL语言来改善这种情况

动态SQL基于OGNL的表达式，可使我们能方便地在SQL语句中实现某些逻辑，那么有哪些元素来支持这种功能呢？这就是下面我要说的了

• if：利用if实现简单的条件选择
• choose（when，otherwise）：相当于java中的switch语句，通常与when和otherwise搭配
• where：简化SQL语句中where的条件判断
• set：解决动态更新语句
• trim：可以灵活地去除多余的关键字
• foreach：迭代一个集合，通常用于in条件

上面小编所说的这些元素，都是用于mapper. 文件中的，并且它还是一个标签，双标签。其实用法和咱们普通的编写java用法差不多，接下来小编就来一一讲解一下单个的元素都好说，来说说组合标签

使用if+where实现多条件查询

<select id=\"getUserList\" resultType=\"User\">
select * from user
<where>
<if test=\"username!=null and userName!=\'\'\">
and userName like CONCAT(\'%\',#{userName},\'%\')
</if>
</where>
</select>

上述代码就是一个最简单的if+where的SQL映射语句，where元素标签会自动识别其标签内是否有返回值，若有，就插入一个where关键字，此外，若该标签返回的内容是以and或者or开头的，where元素会将其自动剔除，if元素标签里主要的属性就是test属性，test后面跟的是一个表达式，返回true或者false，以此来进行判断。

使用if+trim实现对条件查询

<select id=\"getUserList\" resultType=\"User\">
select * from user
<trim prefix=\"where\" prefixOverride=\"and|or\">
<if test=\"username!=null and userName!=\'\'\">
and userName like CONCAT(\'%\',#{userName},\'%\')
</if>
</trim>
</select>

从上述代码中可以看出trim和where元素标签的用法差不多，就trim标签中多了几个元素，那多了啥元素呢？

• prefix：前缀，作用是在trim包含的内容上加上前缀。
• suffix：后缀，作用是在trim包含的内容上加上后缀。
• prefixOverride：对于trim包含内容的首部进行指定内容（如此出的“and|or“）的忽略。
• suffixOverride：对于trim包含内容的首尾部进行指定内容的忽略。

接下来再来看看使用动态SQL来实现更新操作

使用if+set实现更新操作

<update id=\"modify\" parameterType=\"AppInfo\">
update app_info
<set>
<if test=\"logoPicPath != null\">logoPicPath=#{logoPicPath},</if>
<if test=\"logoLocPath != null\">logoLocPath=#{logoLocPath},</if>
<if test=\"modifyBy != null\">modifyBy=#{modifyBy},</if>
<if test=\"modifyDate != null\">modifyDate=#{modifyDate},</if>
</set>
where id=#{id}
</update>

上述代码就是一个最简单的if+set的动态SQL，从上面的代码中能看出其所做的更新操作是动态的，意思就是说你这个值为不为空，不为空就给你更新，要是为空就不管它，emmmm，看样子它的设计还是很人性化的。

上面的操作也是可以用trim来实现的

if+trim实现更新操作

<update id=\"modify\" parameterType=\"AppInfo\">
update app_info
<trim prefix=\"set\" suffixOverride=\",\" suffix=\"where id=#{id}\">
<if test=\"logoPicPath != null\">logoPicPath=#{logoPicPath},</if>
<if test=\"logoLocPath != null\">logoLocPath=#{logoLocPath},</if>
<if test=\"modifyBy != null\">modifyBy=#{modifyBy},</if>
<if test=\"modifyDate != null\">modifyDate=#{modifyDate},</if>
</trim>
</update>

小编之前已经介绍过trim的用法了，在这里就不再赘述了，认真的童鞋应该都明白了。

接下来就是使用foreach完成复杂查询，先说说Mybatis入参为数组的foreach迭代

小编先带大家了解一下foreach的基本用法和属性，foreach主要用于在构建in条件中，它可以在SQL语句中迭代一个集合。它的属性主要有：item、index、collection、separator、close、open，下面我们来看代码

<select id=\"getUserByRole_foreach_array\" resultMap=\"userMapByRole\">
select * from user_info where userRole in
<foreach collection=\"array\" item=\"roleIds\" open=\"(\"separator\",\"close=\")\">
#{roleIds}
</foreach>
</select>
<resultMap tye=\"User\" id=\"userMapByRole\">
<id property=\"id\" clumn=\"id\"/>
<result property=\"userCode\" column=\"userCode/>
<result property=\"userName\" column=\"userName/>
</resultMap>

对于SQL条件循环（in语句），需要使用foreach标签，那小编就用上述代码来向大家介绍一下foreach的基本属性

Item：表示集合中每一个元素进行迭代的别名(如此处的roleIds)。

index：指定一个名称，用于表示在迭代过程中，每次迭代到的位置。

open：表示该语句以什么开始（既然是in条件语句，所以必然是以“(”开始）

separator：表示在每次进行迭代之间以什么符号作为分隔符（既然是in条件语句，所以必然以“,作为分隔符）。

close：表示该语句以什么结束（既然是in条件语句，所以必然是以“)”结束）。

collection：最关键并最容易出错的属性，需格外注意，该属性必须指定，不同情况下，该属性的值是不一样的。主要有三种情况

• 若入参为单参数且参数类型是一个list的时候，collection属性值为list。
• 若入参为单参数且参数类型是一个数组的时候，collection属性值为array（此处传入参数Integer[] roleIds为数组类型，故此处collection属性值设为“array”）。
• 若传入参数为多参数，就需要把它们封装为一个Map进行处理。
  

以上就是动态SQL的基本语法和元素了，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。