MyBatis 动态SQL语句

MyBatis 的强大特性之一便是它的动态 SQL。如果你有使用 JDBC 或其他类似框架的经验，你就能体会到根据不同条件拼接 SQL 语句有多么痛苦。拼接的时候要确保不能忘了必要的空格，还要注意省掉列名列表最后的逗号。利用动态 SQL 这一特性可以彻底摆脱这种痛苦。

动态 SQL 元素和使用 JSTL 或其他类似基于 XML 的文本处理器相似。在 MyBatis 之前的版本中,有很多的元素需要来了解。MyBatis 3 大大提升了它们,现在用不到原先一半的元素就可以了。MyBatis 采用功能强大的基于 OGNL 的表达式来消除其他元素。

if

choose (when, otherwise)

trim (where, set)

foreach

if 标签

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

<select id="getPersons" resultType="cn.bjut.entity.Person">
SELECT * FROM persons WHERE
<if test="name != null">
name = #{name}
</if>
<if test="age != null">
AND age = #{age}
</if>
</select>

上述语句的意思非常简单，如果你提供了name参数（不为空），那么就会在WHERE语句后拼接 name=#{name}，对于age，则拼接 and age=#{age}。之后就是返回满足这些条件的所有Person，这是非常有用的一个功能，以往我们使用其他类型框架或者直接使用JDBC的时候， 如果我们要达到同样的选择效果的时候，我们就需要拼SQL语句，这是极其麻烦的，比起来，上述的动态SQL就要简单多了。

但是如果我们传入的name为null，那么最终生成的SQL语句就变成了（假设传入的age不为null）

SELECT * FROM persons WHERE AND age = #{age}

这就导致程序出现MySQLSyntaxErrorException异常。

我们可以使用如下的小技巧（在where语句后添加1 = 1）或者使用下面介绍的where标签。

<select id="getPersons" resultType="cn.bjut.entity.Person">
SELECT * FROM persons WHERE 1 = 1
<if test="name != null">
AND name = #{name}
</if>
<if test="age != null">
AND age = #{age}
</if>
</select>

where 标签

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

<select id="getPersons" resultType="cn.bjut.entity.Person">
SELECT * FROM persons
<where>
<if test="name != null">
name = #{name}
</if>
<if test="age != null">
AND age = #{age}
</if>
</where>
</select>

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

where 元素知道只有在一个以上的if条件有值的情况下才去插入“WHERE”子句。而且，若最后的内容是“AND”或“OR”开头的，where 元素也知道如何将他们去除。

trim 标签

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

<select id="getPersons" resultType="cn.bjut.entity.Person">
SELECT * FROM persons
<trim prefix="WHERE" prefixOverrides="AND | OR">
<if test="name != null">
name = #{name}
</if>
<if test="age != null">
AND age = #{age}
</if>
</trim>
</select>

choose 标签

choose元素的作用就相当于JAVA中的switch语句，基本上跟JSTL中的choose的作用和用法是一样的，通常都是与when和otherwise搭配的。看如下一个例子：

<select id="getPersons" resultType="cn.bjut.entity.Person">
SELECT * FROM persons WHERE
<choose>
<when test="name != null">
name = #{name}
</when>
<when test="age != null">
age = #{age}
</when>
<otherwise>
id = 1
</otherwise>
</choose>
</select>

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

set 标签

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

<update id="updatePerson" parameterType="cn.bjut.entity.Person">
UPDATE Persons
<set>
<if test="name != null">
name = #{name},
</if>
<if test="age != null">
age = #{age},
</if>
</set>
where id = #{id}
</update>

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

foreach 标签

foreach的主要用在构建in条件中，它可以在SQL语句中进行迭代一个集合。foreach元素的属性主要有item，index，collection，open，separator，close。item表示集合中每一个元素进行迭代时的别名，index指定一个名字，用于表示在迭代过程中，每次迭代到的位置，open表示该语句以什么开始，separator表示在每次进行迭代之间以什么符号作为分隔符，close表示以什么结束。

将一个 List 实例或者数组作为参数对象传给 MyBatis，当这么做的时候，MyBatis 会自动将它包装在一个 Map 中并以名称为键。List 实例将会以“list”作为键，而数组实例的键将是“array”。同样， 当循环的对象为map的时候，index其实就是map的key。

下面是一段示例代码：

<select id="getPersons" resultType="cn.bjut.entity.Person">
SELECT * FROM persons WHERE id IN
<foreach collection="list" item="id" index="index" open="(" separator="," close=")">
#{id}
</foreach>
</select>

参考：

动态SQL

http://elim.iteye.com/blog/1338557

http://www.yihaomen.com/article/java/328.htm

http://www.cnblogs.com/dongying/p/4092662.html