Mybatis的动态SQL

前言：MyBatis的动态SQL是基于OGNL表达式的，通过对sql语句的拼接和组装可以实现一些逻辑。

MyBatis中用于实现动态SQL的元素主要有：i,choose（when,otherwise),where,trim,set,foreach。

(1)if条件语句

if就是简单的条件判断，利用if语句我们可以实现某些简单的条件选择。先来看如下一个例子：

<ol><li><span><span style="color:#333333;"><strong><span class="tag"><</span><span class="tag-name">select</span></strong><span> </span><span class="attribute">id</span><span>=</span><span class="attribute-value">"findActiveBlogIf"</span><span> </span><span class="attribute">parameterType</span><span>=</span><span class="attribute-value">"Blog"</span><span> </span><span class="attribute">resultType</span><span>=</span><span class="attribute-value">"Blog"</span><span class="tag"><strong>></strong></span><span>  </span></span></span></li><li><span style="color:#333333;"><span>    select * from t_blog where </span><span class="attribute">state="ACTIVE"</span><span>   </span></span></li><li><span style="color:#333333;"><span>    </span><strong><span class="tag"><</span><span class="tag-name">if</span></strong><span> </span><span class="attribute">test</span><span>='</span><span class="attribute-value">title != null AND title!=""'</span><span class="tag"><strong>></strong></span><span>  </span></span></li><li><span style="color:#333333;"><span>        and </span><span class="attribute">title</span><span> = #{title}   </span></span></li><li><span style="color:#333333;"><span>    </span><strong><span class="tag"></</span><span class="tag-name">if</span><span class="tag">></span></strong><span>  </span></span></li><li><span style="color:#333333;"><span>    </span><strong><span class="tag"><</span><span class="tag-name">if</span></strong><span> </span><span class="attribute">test</span><span>='</span><span class="attribute-value">author != null AND author!=""'</span><span class="tag"><strong>></strong></span><span>  </span></span></li><li><span style="color:#333333;"><span>        and </span><span class="attribute">author = </span><span>#{author}   </span></span></li><li><span style="color:#333333;"><span>    </span><strong><span class="tag"></</span><span class="tag-name">if</span><span class="tag">></span></strong><span> </span></span></li><li><span style="color:#333333;"><span></select></span><span> </span></span></li></ol>

这条语句的意思非常简单，如果你提供了title参数，那么就要满足title=#{title}，同样如果你提供了author的时候，它们也需要满足相应的条件，之后就是返回满足这些条件的所有Blog，这是非常有用的一个功能，以往我们使用其他类型框架或者直接使用JDBC的时候， 如果我们要达到同样的选择效果的时候，我们就需要拼SQL语句，这是极其麻烦的，比起来，上述的动态SQL就要简单多了。

(2)choose（when,otherwise)开关语句

有时候我们不想应用所有的条件，相反我们想选择多种情况中的一种。choose元素的作用就相当于JAVA中的switch语句，基本上跟JSTL中的choose的作用和用法是一样的，通常都是与when和otherwise搭配的。看如下一个例子：

<ol><li><span><span style="color:#333333;"><strong><span class="tag"><</span><span class="tag-name">select</span></strong><span> </span><span class="attribute">id</span><span>=</span><span class="attribute-value">"findActiveBlogChoose"</span><span> </span><span class="attribute">parameterType</span><span>=</span><span class="attribute-value">"Blog"</span><span> </span><span class="attribute">resultType</span><span>=</span><span class="attribute-value">"Blog"</span><span class="tag"><strong>></strong></span><span>  </span></span></span></li><li><span style="color:#333333;"><span>    select * from t_blog where </span><span class="attribute"><span class="attribute"><span style="BACKGROUND-COLOR: #f0f0f0">state="ACTIVE"</span></span></span><span>  </span></span></li><li><span style="color:#333333;"><span>    </span><strong><span class="tag"><</span><span class="tag-name">choose</span><span class="tag">></span></strong><span>  </span></span></li><li><span style="color:#333333;"><span>        </span><strong><span class="tag"><</span><span class="tag-name">when</span></strong><span> </span><span class="attribute">test</span><span>='</span><span class="attribute-value">title != null AND title!=""'</span><span class="tag"><strong>></strong></span><span>  </span></span></li><li><span style="color:#333333;"><span>            and </span><span class="attribute">title</span><span> = #{title}   </span></span></li><li><span style="color:#333333;"><span>        </span><strong><span class="tag"></</span><span class="tag-name">when</span><span class="tag">></span></strong><span>  </span></span></li><li><span style="color:#333333;"><span>        </span><strong><span class="tag"><</span><span class="tag-name">when</span></strong><span> </span><span class="attribute">test</span><span>='</span><span class="attribute-value">author != null AND author!=""'</span><span class="tag"><strong>></strong></span><span>  </span></span></li><li><span style="color:#333333;"><span>            and </span><span class="attribute">author</span><span>= #{author}   </span></span></li><li><span style="color:#333333;"><span>        </span><strong><span class="tag"></</span><span class="tag-name">when</span><span class="tag">></span></strong><span>  </span></span></li><li><span style="color:#333333;"><span>        </span><strong><span class="tag"><</span><span class="tag-name">otherwise</span><span class="tag">></span></strong><span>  </span></span></li><li><span style="color:#333333;"><span>            and featured=1</span><span>  </span></span></li><li><span style="color:#333333;"><span>        </span><strong><span class="tag"></</span><span class="tag-name">otherwise</span><span class="tag">></span></strong><span>  </span></span></li><li><span style="color:#333333;"><span>    </span><strong><span class="tag"></</span><span class="tag-name">choose</span><span class="tag">></span></strong><span>  </span></span></li><li><span></span><span style="color:#333333;"><strong><span class="tag"></</span><span class="tag-name">select</span><span class="tag">></span></strong><span>  </span></span></li></ol>

when元素表示当when中的条件满足的时候就输出其中的内容，跟JAVA中的switch效果差不多的 是按照条件的顺序执行，当when中有条件满足的时候，就会跳出choose，即所有的when和otherwise条件中， 只有一个会输出，当所有的条件都不满足的时候就输出otherwise中的内容。所以上述语句的意思非常简单， 当title!=null and title!=""的时候就输出and titlte = #{title}，不再往下判断条件，当title为空且author!=null and author!=""的时候就输出and author= #{author}，当所有条件都不满足的时候就输出otherwise中的内容。

(3) where
where语句的作用主要是简化SQL语句中where中的条件判断的.先看一个例子，再解释一下where的好处。

<ol><li><span><span style="color:#333333;"><strong><span class="tag"><</span><span class="tag-name">select</span></strong><span> </span><span class="attribute">id</span><span>=</span><span class="attribute-value">"findActiveBlogWhere"</span><span> </span><span class="attribute">parameterType</span><span>=</span><span class="attribute-value">"Blog"</span><span> </span><span class="attribute">resultType</span><span>=</span><span class="attribute-value">"Blog"</span><span class="tag"><strong>></strong></span><span>  </span></span></span></li><li><span><span style="color:#333333;">    select * from t_blog    </span></span></li><li><span style="color:#333333;"><span>    </span><strong><span class="tag"><</span><span class="tag-name">where</span><span class="tag">></span></strong><span>  </span></span></li><li><span style="color:#333333;"><span>        </span><strong><span class="tag"><</span><span class="tag-name">if</span></strong><span> </span><span class="attribute">test</span><span>='</span><span class="attribute-value">title != null and title!=""'</span><span class="tag"><strong>></strong></span><span>  </span></span></li><li><span style="color:#333333;"><span>            </span><span class="attribute">title</span><span> = #{title}   </span></span></li><li><span style="color:#333333;"><span>        </span><strong><span class="tag"></</span><span class="tag-name">if</span><span class="tag">></span></strong><span>  </span></span></li><li><span style="color:#333333;"><span>        </span><strong><span class="tag"><</span><span class="tag-name">if</span></strong><span> </span><span class="attribute">test</span><span>='</span><span class="attribute-value">author!= null and author!=""'</span><span class="tag"><strong>></strong></span><span>  </span></span></li><li><span style="color:#333333;"><span>            and </span><span class="attribute">author</span><span>= #{author}   </span></span></li><li><span style="color:#333333;"><span>        </span><strong><span class="tag"></</span><span class="tag-name">if</span><span class="tag">></span></strong><span>  </span><span> </span></span></li><li><span><span style="color:#333333;">    </where></span></span></li><li><span><span style="color:#333333;"></select></span></span></li></ol>

 where元素的作用是会在写入where元素的地方输出一个where，另外一个好处是你不需要考虑where元素里面的条件输出是什么样子的，MyBatis会智能的帮你处理，如果所有的条件都不满足那么MyBatis就会查出所有的记录，如果输出后是and 开头的， MyBatis会把第一个and忽略，当然如果是or开头的，MyBatis也会把它忽略；此外，在where元素中 你不需要考虑空格的问题，MyBatis会智能的帮你加上。像上述例子中，如果title=null， 而author!= null，那么输出的整个语句会是select * from t_blog where author= #{author}，而不是select * from t_blog where and author= #{author}， 因为MyBatis会智能的把首个and 或 or 给忽略。我们也可以自定义处理方式，这个就是接下来的trim了。

(4)trim自定义处理方式

trim元素的主要功能是可以在自己包含的内容前加上某些前缀，也可以在其后加上某些后缀，与之对应的属性是prefix和suffix；可以把包含内容的首部某些内容覆盖，即忽略，也可以把尾部的某些内容覆盖，对应的属性是prefixOverrides和suffixOverrides；正因为trim有这样的功能，所以我们也可以非常简单的利用trim来代替where元素的功能，示例代码如下：

<span style="color:#000000;BACKGROUND-COLOR: #ffffff">1<span style="color:#333333;">.<select id="findActiveBlogTrim" parameterType="Blog" resultType="Blog">  
2.    select * from t_blog    
3.    <trim prefix="where" prefixOverrides="and |or ">  
4.        <if test='title != null and title!=""'>  
5.            title = #{title}   
6.        </if>  
7.        <if test='author!= null and author!=""'>  
8.            and author= #{author}   
9.        </if>    
10.    </trim>  
11.</select>  </span></span>

(5)Set

set元素主要是用在更新操作的时候，它的主要功能和where元素其实是差不多的，主要是在包含的语句前输出一个set，然后如果包含的语句是以逗号结束的话将会把该逗号忽略，如果set包含的内容为空的话则会出错。有了set元素我们就可以动态的更新那些修改了的字段。下面是一段示例代码：

<span style="color:#000000;">1.<update id="update<span style="color:#333333;">dActiveBlogSet</span>" parameterType="Blog">  
2.    update t_blog   
3.    <set>  
4.        <if test='title != null and title!=""'>  
5.            title = #{title},   
6.        </if>  
7.        <if test='author!= null and author!=""'>  
8.            author= #{author},   
9.        </if>   
10.    </set>  
11.    where id = #{id}   
12.</update> </span> 

上述示例代码中，如果set中一个条件都不满足，即set中包含的内容为空的时候就会报错。
(6)foreach

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="<span style="color:#333333;">findActiveBlogForeach1</span>" resultType="Blog">  
2.    select * from t_blog where id in   
3.    <foreach collection="list" index="index" item="listItem" open="(" separator="," close=")">  
4.        #{listItem}   
5.    </foreach>  
6.</select>

mapper接口：

public List<Blog> <span style="color:#333333;">findActiveBlogForeach1</span>(List<Integer> ids);  

2.单参数array数组的类型

xml配置：

1.<select id="<span style="color:#333333;">findActiveBlogForeach2</span>" resultType="Blog">  
2.    select * from t_blog where id in   
3.    <foreach collection="array" index="index" item="listItem" open="(" separator="," close=")">  
4.        #{listItem}   
5.    </foreach>  
6.</select>

mapper接口：

public List<Blog> <span style="color:#333333;">findActiveBlogForeach2</span>(int[] ids);  

3.自己把参数封装成Map的类型

xml配置：

1.<select id="<span style="color:#333333;">findActiveBlogForeach3</span>" resultType="Blog">  
2.    select * from t_blog where title like "%"#{title}"%" and id in   
3.    <foreach collection="ids" index="index" item="listItem" open="(" separator="," close=")">  
4.        #{listItem}   
5.    </foreach>  
6.</select>

上述collection的值为ids，是传入的参数Map的key，对应的Mapper：

public List<Blog> <span style="color:#333333;">findActiveBlogForeach3</span>(Map<String, Object> params);