MyBatis的强大特性之一 便是动态SQL。由于JDBC或类似框架需要根据不同条件拼接SQL语句时不仅不能忘了必要的空格,还要注意省略掉列名列表最后的的逗号,处理方式比较麻烦,而动态SQL可以摆脱这些问题。这里主要介绍计中MyBatis的动态SQL在XML文件中支持的几种标签。
if标签
if标签通常用于where语句,通过判断参数值来决定是否使用某个查询条件,也常用于update语句中判断是否更新某一个字段,还可以在insert语句中用来判断是否插入某个字段的值。
示例:
需求:以订单表orders为例(id,user_id,number,createtime,note)
通过的用户ID和订单编号查询订单?
select * from orders where number=? and user_id=?
按照之前的方式进行查询如下:
<!--通过订单号或用户名查询订单-->
<select id="getOrderByIdAndNum" resultType="MavenLG.bean.Orders" >
select * from orders where user_id = #{userId} and number = #{number}
</select>
当同时输入user_id和number这两个参数时,能查出正确的结果,但当只提供user_id一个参数,另一个参数number默认为null,就会导致number=null也成为查询条件,无法查找正确结果。此时可以采用if标签解决问题:
<!--通过订单号或用户名查询订单-->
<select id="getOrderByIdAndNum" resultType="MavenLG.bean.Orders" >
select * from orders where 1=1
<if test="userId != null and userId != ''">
and user_id = #{userId}
</if>
<if test="number != null and number != ''">
and number = #{number}
</if>
</select>
if标签有一个必填属性test,test的属性值是一个OGNL表达式,表达式的结果可以是true或false,除此之外,所有的非零值都为true。以下为OGNL的简单介绍:
- 判断条件property != null或property == null:适用于任何类型的字段,用于判断属性值是否为空;
- 判断条件property != ' '或property == ' ':仅适用于String类型的字段,用于判断是否为空字符串;
- and和or:当有多个判断条件时,使用and或or进行连接,嵌套的判断可以使用小括号分组,and相当于Java中的与(&&),or相当于Java中的或(||)
接口中增加对应方法
public Orders getOrderByIdAndNum(Orders orders);
测试方法:
@Test
public void testgetOrderByIdAndNum(){
//通过sqlsessionFactory实例创建sqlsession实例
SqlSession sqlSession = sqlSessionFactory.openSession();
//通过反射机制来获取对应mapper实例
OrderMapper mapper = sqlSession.getMapper(OrderMapper.class);
//只通过user_id查询时
Orders order1 = new Orders();
order1.setUserId(10);
mapper.getOrderByIdAndNum(order1);
//只通过number查询时
order1 = new Orders();
order1.setNumber("3");
mapper.getOrderByIdAndNum(order1);
//通过user_id和number查询时
order1 = new Orders();
order1.setNumber("3");
order1.setUserId(10);
mapper.getOrderByIdAndNum(order1);
//两个参数都无效
order1 = new Orders();
mapper.getOrderByIdAndNum(order1);
sqlSession.close();
}
针对四种情况进行测试,输出日志如下:
Preparing: select * from orders where 1=1 and user_id = ?
2019-06-14-20:59:19,117 [main] [MavenLG.mapper.OrderMapper.getOrderByIdAndNum] [DEBUG] - ==> Parameters: 10(Integer)
2019-06-14-20:59:19,281 [main] [MavenLG.mapper.OrderMapper.getOrderByIdAndNum] [DEBUG] - <== Total: 1
2019-06-14-21:06:34,660 [main] [MavenLG.mapper.OrderMapper.getOrderByIdAndNum] [DEBUG] - ==> Parameters: 3(String)
2019-06-14-21:06:34,699 [main] [MavenLG.mapper.OrderMapper.getOrderByIdAndNum] [DEBUG] - <== Total: 1
2019-06-14-21:05:16,857 [main] [MavenLG.mapper.OrderMapper.getOrderByIdAndNum] [DEBUG] - ==> Preparing: select * from orders where 1=1 and user_id = ? and number = ?
2019-06-14-21:05:16,982 [main] [MavenLG.mapper.OrderMapper.getOrderByIdAndNum] [DEBUG] - ==> Parameters: 10(Integer), 3(String)
2019-06-14-21:05:17,098 [main] [MavenLG.mapper.OrderMapper.getOrderByIdAndNum] [DEBUG] - <== Total: 1
Preparing: select * from orders where 1=1
2019-06-14-21:01:59,721 [main] [MavenLG.mapper.OrderMapper.getOrderByIdAndNum] [DEBUG] - ==> Parameters:
2019-06-14-21:01:59,758 [main] [MavenLG.mapper.OrderMapper.getOrderByIdAndNum] [DEBUG] - <== Total: 3
从日志中可以看到,查询条件的不同组合最终执行的SQL和预期一样,这样就实现了动态条件查询。但要注意:
(1)注意SQL中where关键字后面的条件 where 1=1,由于两个条件都是动态的,若没有这个条件,当两个if判断都不满足时,最终生成的SQL会以where结束,不符合SQL规范,报错 。
(2)注意条件中的and(或or),当if条件不满足,where元素中没有元素,则SQL中不会出现where,如果if条件满足且以and开头,where会自动去掉开头and,保证where条件正确。
set标签
set标签的作用:标签包含的元素有返回值,就插入一个set,如果set后面是以逗号结尾的就将逗号剔除掉
示例:
在接口文件中:
public void setOrder(Orders order);
在mapper.xml中
<update id="setOrder">
update orders
<set>
<if test="number != null and number != ''">
number = #{number},
</if>
</set>
<where>
user_id = #{id}
</where>
</update>
测试:
@Test
public void teatSetOrder(){
//通过sqlsessionFactory实例创建sqlsession实例
SqlSession sqlSession = sqlSessionFactory.openSession();
//通过反射机制来获取对应mapper实例
OrderMapper mapper = sqlSession.getMapper(OrderMapper.class);
Orders order1 = new Orders();
order1.setNumber("7");
order1.setUserId(10);
//调用mapper实例下方法
mapper.setOrder(order1);
sqlSession.commit();
sqlSession.close();
}
输出日志:
2019-06-14-21:25:51,405 [main] [MavenLG.mapper.OrderMapper.setOrder] [DEBUG] - ==> Preparing: update orders SET number = ? WHERE user_id = ?
2019-06-14-21:25:51,463 [main] [MavenLG.mapper.OrderMapper.setOrder] [DEBUG] - ==> Parameters: 7(String), 0(Integer)
foreach标签
foreach标签实现批量数据处理,遍历集合对象
foreach包含属性如下:
collection:必填:值为迭代循环的属性名 属性值情况较多
collection属性:
当参数为数组时,collection属性为array
当参数为map时,collection属性为_parameter
当参数为list时,collection属性为list
item:变量名,值为从迭代对象中取出的每一个值
index:索引的属性名,在集合数组下值为当前索引值,当迭代循环对象是map
类型时,值为map的key
open:整个循环开始的字符串
close:整个循环内容结束的字符串
separator:每次循环的分隔符
示例:
XML文件:
<insert id="batchAddOrder" >
insert into orders (user_id,number,createtime,note)
values
<foreach collection="list" item="order" separator=",">
(#{order.userId},#{order.number},#{order.createtime}, #{order.note})
</foreach>
</insert>
JAVA接口:
/**
* 批量插入订单
* @param orders
* @return
*/
public int batchAddOrder(List<Orders> orders);
这部分主要介绍了动态SQL的几个标签,动态SQL可以避免在Java代码中处理繁杂的业务逻辑,通过将大量的判断写入到MyBatis的映射层可以极大程度上提高我们的逻辑应变能力,当有一般的业务逻辑改变时,通常只需要在映射层通过动态SQL实现。