1.动态SQL简介
MyBatis 的强大特性之一便是它的动态 SQL。
如果使用 JDBC 或其他类似框架,你就能体会到根据不同条件拼接 SQL 语句有多么痛苦。拼接的时候要确保不能忘了必要的空格,还要注意省掉列名列表最后的逗号。利用动态 SQL 这一特性可以彻底摆脱这种痛苦。
MyBatis 使用一种强大的动态 SQL 语言来改进这种情形,
动态SQL:SQL语句可以根据用户的条件动态的生成和变化 ,MyBatis性能高、灵活度高!
对象导航图语言(Object Graph Navigation Language):简称OGNL,是应用于Java中的一个开源的表达式语言(Expression Language),它被集成在Struts2等框架中,作用是对数据进行访问,它拥有类型转换、访问对象方法、操作集合对象等功能。
MyBatis 的动态sql语句是基于OGNL表达式的。可以方便的在 sql 语句中实现某些逻辑. 总体说来MyBatis 动态SQL 语句主要有以下几类:
-
if 语句 (简单的条件判断)
-
choose (when,otherwise) ,相当于java 语言中的 switch ,与 jstl 中的choose 很类似.
-
trim (对包含的内容加上 prefix,或者 suffix 等,前缀,后缀)
-
where (主要是用来简化sql语句中where条件判断的,能智能的处理 and or ,不必担心多余导致语法错误)
-
set (主要用于更新时)
-
foreach (在实现 mybatis in 语句查询时特别有用)
2.分支判断
2.1 if元素
根据 username 和 sex 来查询数据。如果username为空,那么将只根据sex来查询;反之只根据username来查询 首先不使用 动态SQL 来书写
<select id="selectUserByUsernameAndSex" resultType="user" parameterType="User">
select * from user where username=#{username} and sex=#{sex}
</select>
上面的查询语句,我们可以发现,如果 #{username} 为空,那么查询结果也是空,如何解决这个问题呢?使用 if 来判断
<select id="selectUserByUsernameAndSex" resultType="user"
parameterType="User">
select * from user where
<if test="username != null">
username=#{username}
</if>
<if test="sex!= null">
and sex=#{sex}
</if>
</select>
这样写我们可以看到,如果 sex 等于 null,那么查询语句为:
select * from user where username=#{username};
但是如果usename 为空呢?那么查询语句为 :
select * from user where and sex=#{sex};
这是错误的 SQL 语句,如何解决呢?请看下面的 where 语句
2.2 动态SQL:if+where 语句
<select id="selectUserByUsernameAndSex" resultType="User" parameterType="User">
select * from user
<where>
<if test="username != null">
and username=#{username}
</if>
<if test="sex != null">
and sex=#{sex}
</if>
</where>
</select>
这个“where”标签会知道如果它包含的标签中有返回值的话,它就插入一个‘WHERE’。此外,如果标签它会剔除掉返回内容中的第一个and 或or。
2.3 动态SQL:if+set 语句
同理,上面的对于查询 SQL 语句包含 where 关键字,如果在进行更新操作的时候,含有 set 关键词,我们怎么处理呢?
<!-- 根据 id 更新 user 表的数据 -->
<update id="updateUserById" parameterType="User">
update user u
<set>
<if test="username != null and username != ''">
u.username = #{username},
</if>
<if test="sex != null and sex != ''">
u.sex = #{sex},
</if>
</set>
where id=#{id}
</update>
如果username 为空,那么 sql 语句为:
update user u set u.sex=? where id=?
如果第一个条件不为空,那么 sql 语句为:
update user u set u.username = ? ,u.sex = ? where id=?
如果出现多余逗号会自动去掉!!通常去掉set返回内容中的最后一个逗号
2.4 动态SQL:choose(when,otherwise) 语句 (了解)
有时候,我们不想用到所有的查询条件,只想选择其中的一个,查询条件有一个满足即可,使用 choose 标签可以解决此类问题,类似于 Java 的 switch 语句
<select id="selectUserByChoose" resultType="User" parameterType="User">
select * from user
<where>
<choose>
<when test="id !='' and id != null">
and id=#{id}
</when>
<when test="username !='' and username != null">
and username=#{username}
</when>
<otherwise>
and sex=#{sex}
</otherwise>
</choose>
</where>
</select>
也就是说,这里我们有三个条件,id,username,sex,只能选择一个作为查询条件
如果 id 不为空,那么查询语句为:select * from user where id=?
如果 id 为空,那么看username 是否为空,如果不为空,那么语句为 select * from user where username=?;
如果 id 为空,username 为空,那么查询语句为 select * from user where sex=?
同时,如果标签返回的内容是以AND 或OR 开头的,则它会剔除掉AND 或OR 。
2.5 动态SQL:trim 语句 (了解)
trim标记是一个格式化的标记,可以完成set或者是where标记的功能
①用 trim 改写上面第二点的 if+where 语句
<select id="selectUserByUsernameAndSex" resultType="user" parameterType="User">
select * from user
<trim prefix="where" prefixOverrides="and | or">
<if test="username != null">
and username=#{username}
</if>
<if test="sex != null">
and sex=#{sex}
</if>
</trim>
</select>
prefix:前缀
prefixoverride:去掉第一个and或者是or
②、用 trim 改写上面第三点的 if+set 语句
<!-- 根据 id 更新 user 表的数据 -->
<update id="updateUserById" parameterType="User">
update user u
<trim prefix="set" suffixOverrides=",">
<if test="username != null and username != ''">
u.username = #{username},
</if>
<if test="sex != null and sex != ''">
u.sex = #{sex},
</if>
</trim>
where id=#{id}
</update>
suffix:后缀
suffixoverride:去掉最后一个逗号
2.6 动态SQL: SQL 片段
有时候可能某个 sql 语句我们用的特别多,为了增加代码的重用性,简化代码,我们需要将这些代码抽取出来,然后使用时直接调用。 比如:假如我们需要经常根据用户名和性别来进行联合查询,那么我们就把这个代码抽取出来,如下:
<!-- 定义 sql 片段 -->
<sql id="selectUserByUserNameAndSexSQL">
<if test="username != null and username != ''">
AND username = #{username}
</if>
<if test="sex != null and sex != ''">
AND sex = #{sex}
</if>
</sql>
引用 sql 片段
<select id="selectUserByUsernameAndSex" resultType="user" parameterType="User">
select * from user
<trim prefix="where" prefixOverrides="and | or">
<!-- 引用 sql 片段,如果refid 指定的不在本文件中,那么需要在前面加上 namespace -->
<include refid="selectUserByUserNameAndSexSQL"></include>
<!-- 在这里还可以引用其他的 sql 片段 -->
</trim>
</select>
注意:
①、最好基于单表来定义 sql 片段,提高片段的可重用性
②、在 sql 片段中不要包括 where
2.7 动态SQL: foreach 语句
需求:我们需要查询 user 表中 id 分别为1,2,3的用户 sql语句:
select * from user where id=1 or id=2 or id=3
select * from user where id in (1,2,3)
-
传入参数为单参数List的类型
public List<User> dynamicForeachTest(List<Integer> ids);
<select id="dynamicForeachTest" resultType="User">
select * from user where id in
<foreach collection="list" item="item" open="(" separator="," close=")">
#{item}
</foreach>
</select>
@Test
public void testSelectUserByListId1(){
List<Integer> ids = new ArrayList<Integer>();
ids.add(1);
ids.add(2);
ids.add(3);
List<User> listUser = mapper.dynamicForeachTest(ids);
for(User u : listUser){
System.out.println(u);
}
}
-
传入参数为单参数array数组的类型
<select id="dynamicForeach2Test" resultType="User">
select * from user where id in
<foreach collection="array" item="item" open="(" separator="," close=")">
#{item}
</foreach>
</select>
public List<User> dynamicForeach2Test(Integer[] ids);
@Test
public void dynamicForeach2Test(){
Integer[] ids={1,2,3};
List<User> listUser = mapper.dynamicForeach2Test(ids);
for(User u : listUser){
System.out.println(u);
}
}