动态SQL
MyBatis 的强大特性之一便是它的动态 SQL。如果你有使用 JDBC 或其它类似框架的经验,你就能体会到根据不同条件拼接 SQL 语句的痛苦。例如拼接时要确保不能忘记添加必要的空格,还要注意去掉列表最后一个列名的逗号。利用动态 SQL 这一特性可以彻底摆脱这种痛苦。
- if
- choose (when, otherwise)
- trim (where, set)
- foreach
if
<select id="findUserList" parameterType="String" resultType="user">
SELECT * FROM user WHERE sex = "1"
<if test="name != null">
AND username LIKE '%${name}%'
</if>
</select>
这条语句提供了一种可选的查找功能。如果没有传入“name”,那么性别为"1"的用户都会返回;反之若传入了“name”,那么就会对“name”一列进行模糊查找并返回 List结果
如果希望有两个可选参数,则可以增加if标签来实现
<select id="findUserList" parameterType="userQueryVO" resultType="user">
SELECT * FROM user WHERE sex = '1'
<if test="user != null">
<if test="user.username !=null">
AND username LIKE '%${user.username}%'
</if>
<if test="user.address !=null">
AND address LIKE '%${user.address}%'
</if>
</if>
</select>
choose
有时我们不想应用到所有的条件语句,而只想从中择其一项。针对这种情况,MyBatis 提供了 choose 元素,它有点像 Java 中的 switch 语句。
还是上面的例子,但是这次变为提供了“username”就按“username”查找,提供了“address”就按“address”查找的情形,若两者都没有提供,就返回所有符合条件的 user(实际情况可能是由管理员按一定策略选出 user列表,而不是返回大量无意义的随机结果)。
<select id="findUserByChoose" parameterType="userQueryVO" resultType="user">
SELECT * FROM user WHERE sex = '1'
<choose>
<when test="user != null and user.username !=null">
AND username LIKE '%${user.username}%'
</when>
<when test="user != null and user.address !=null">
AND address LIKE '%${user.address}%'
</when>
</choose>
</select>
where
在if事例中,如果我们将sex='1’也设置成动态的条件
<select id="findUserList" parameterType="userQueryVO" resultType="user">
SELECT * FROM user WHERE
<if test="user != null">
<if test="user.sex !=null">
AND sex LIKE '%${user.sex}%'
</if>
<if test="user.username !=null">
AND username LIKE '%${user.username}%'
</if>
<if test="user.address !=null">
AND address LIKE '%${user.address}%'
</if>
</if>
</select>
如果这些条件没有一个能匹配上,最终这条SQL会变成
SELECT * FROM user WHERE
如果仅仅匹配到了第二个条件,最终这条SQL会变成
SELECT * FROM user WHERE AND username LIKE '%user.username%'
这两种情况都会导致查询失败,因此,在mybatis中,有一个简单的处理——使用where标签,这在 90% 的情况下都会有用。
<select id="findUserList" parameterType="userQueryVO" resultType="user">
SELECT * FROM user
<where>
<if test="user != null">
<if test="user.sex !=null">
AND sex LIKE '%${user.sex}%'
</if>
<if test="user.username !=null">
AND username LIKE '%${user.username}%'
</if>
<if test="user.address !=null">
AND address LIKE '%${user.address}%'
</if>
</if>
</where>
</select>
foreach
动态 SQL 的另外一个常用的操作需求是对一个集合进行遍历,通常是在构建 IN 条件语句的时候。比如:
<select id="findUserByIds" parameterType="list" resultType="user">
SELECT * FROM user
<where>
<if test="list != null and list.size() > 0">
<foreach collection="list" item="id" open="id in(" close=")" separator="," >
#{id}
</foreach>
</if>
</where>
</select>
你可以将任何可迭代对象(如 List、Set 等)、Map 对象或者数组对象传递给 foreach 作为集合参数。当使用可迭代对象或者数组时,index 是当前迭代的次数,item 的值是本次迭代获取的元素。当使用 Map 对象(或者 Map.Entry 对象的集合)时,index 是键,item 是值。
SQL片段
Mybatis 提供了SQL片段的功能,可以提高SQL的可重用性