MyBatis提供了一些相当方便的标签元素来帮助我们编写动态SQL查询语句,例如if,where,trim,choose等等。如果你原来用JDBC或其他框架编写过动态SQL,你就能体会到借助MyBatis来编写动态SQL可以帮你省掉多少拼接sql的麻烦。
先看一下,MyBatis都提供了哪些元素:
下面的例子全部在MyBatis(一)单表操作的基础上操作即可。
1.if元素
当我们提供给用户一些可选查询选项的时候,我们要根据用户输入的查询字段来拼接我们的Where条件语句,比如用户输入了用户名,我们就按用户名查询;如果用户输入了用户名和昵称,那我们就按用户名和昵称来查询。
<select id="findAuthorWithNicknameLike" resultMap="authorMap">
SELECT *
FROM author
WHERE username = '老刘'
<if test="nickname != null">
AND nickname LIKE #{nickname}
</if>
</select>
<resultMap id="authorMap" type="Author">
<id property="id" column="id"></id>
<result property="registerTime" column="register_time"></result>
</resultMap>
上面的例子中,查询用户名为”老刘”,并且如果昵称不为空的话,就自动拼接if里面的条件语句。这里if中用test来指定哪些条件下需要拼接if里面的语句.
MyMapper文件:
Author findAuthorWithNicknameLike(Map<String, Object> map);
Main文件:
Map<String, Object> map = new HashMap<>();
map.put("nickname", "Bob liu");
Author author = myMapper.findAuthorWithNicknameLike(map);
System.out.println(author);
注意,main文件中拼接参数的map中的key值要和<select>中的参数名称保持一致。
2.choose, when, otherwise
这三个元素的作用和switch的功能是一样的,直接上例子:
<select id="findAuthorLike" resultMap="authorMap">
SELECT *
FROM author
WHERE id = 2
<choose>
<when test="author != null and author.username != null">
AND username LIKE #{author.username}
</when>
<when test="nickname != null">
AND nickname LIKE #{nickname}
</when>
<otherwise>
AND username = '老刘'
</otherwise>
</choose>
</select>
choose元素只会匹配一个<when>元素,如果所有的<when>元素都没匹配上,最后就会拼接<otherwise>元素里面的语句。
3.where语句,先看例子
<select id="findAuthorWhere" resultMap="authorMap">
SELECT *
FROM author
<where>
<if test="nickname != null">
nickname = #{nickname}
</if>
<if test="username != null">
AND username = #{username}
</if>
</where>
</select>
where元素会自动在第一if满足的语句前面拼接where, 并且会自动删除第一个条件前面的AND等关键字。比如上面的两个if, 如果第一个if不满足,第二个if满足,那么只有第二个if里面的AND username=#{username}语句会拼接到where后面,并且username前面的AND关键字会自动删除。
4.set元素用来更新数据,同where元素一样,set元素会自动匹配到第一个满足条件的语句,并在其前面拼接set关键字,同时会自动删除不必要的”,”。比如:
<update id="updateAuthor">
UPDATE author
<set>
<if test="username != null">username = #{username},</if>
<if test="nickname != null">nickname = #{nickname}</if>
</set>
WHERE id = #{id}
</update>
如果第二个if不满足,第一个if满足,如果不做处理的话,set语句后面会带有第一个if最后的”,”,而set元素会帮我们自动处理掉这个不必要的“,”。
5.trim元素。
如果对where元素不太放心,可以使用trim元素来代替它。
<select id="findAuthorTrim" resultMap="authorMap">
SELECT *
FROM author
<trim prefix="WHERE" prefixOverrides="AND | OR ">
<if test="nickname != null">
nickname = #{nickname}
</if>
<if test="username != null">
AND username = #{username}
</if>
</trim>
</select>
trim中的prefix用于生成对应的关键字并拼接到对应的位置。如果最后生成的语句前面或后面遇到prefixOverrides和suffixOverrides属性中的值,MyBatis会自动将它们删除。比如由于if元素的原因,最后的sql语句可能是这样的WHERE AND nickname = ‘Bob liu’, 这时候MyBatis就会自动将AND删除,生成最后的WHERE nickname = ‘Bob liu’语句。
6.foreach元素用来遍历集合,一般用来构造in语句,例如:
<select id="selectIN" resultMap="authorMap">
SELECT *
FROM author
WHERE id in
<foreach collection="list" item="item" index ="index" open="(" separator="," close=")">
#{item}
</foreach>
</select>
7.bind元素,用来自定义一个变量,并将其绑定到上下文。例如下面的LIKE查询:
<select id="selectLike" resultMap="authorMap">
<bind name="namelike" value="'%' + usernameLike + '%'"/>
SELECT *
FROM author
WHERE username LIKE #{namelike}
</select>
最后,还有Multi-db vendor support和动态 SQL 中可插拔的脚本语言暂时没有涉及到,以后用到再补充。