Java EE之SSM框架整合开发 -- (8) MyBatis的动态SQL
作者:快盘下载 人气:本章主要内容：<if>条件元素、<choose>、<when>、<otherwise>分支元素、<trim>、<where>、<set>添加前后缀元素、<foreach>遍历元素、<bind>字符串拼接元素。
前言
1．请简述<bind>元素的作用。
答：防止恶意SQL注入，还有就是有利于代码移植，不同数据库间的字符串拼接交由Mybatis处理。
2．在动态SQL元素中，类似分支语句的元素有哪些？
答：<if>、<choose>、<when>、<otherwise>。
8.1 <if>元素
动态SQL通常要做的事情是有条件地包含where子句的一部分。所以在MyBatis中，<if>元素是最常用的元素。它类似于Java中的if语句。在ch8应用中，测试<if>元素，具体过程如下：
本小节继续使用上一章的实例，在com.mybatis包的UserMapper.xml文件中，添加如下SQL映射语句：
<!-- 使用if元素，根据条件动态查询用户信息 -->
<select id="selectUserByIf" resultType="com.po.MyUser" parameterType="com.po.MyUser">
select * from user where 1=1
<if test="uname !=null and uname!=''">
and uname like concat('%',#{uname},'%')
</if>
<if test="usex !=null and usex!=''">
and usex = #{usex}
</if>
</select> 这个<select>元素中parameterType用的是POJO类MyUser。所以SQL语句中的#{uname}和 #{usex}的值都是MyUser.uname。
当要构造动态sql语句时为了防止sql语句结构不当,所以加上where 1=1 ，这样SQL语句不会报错，后面的逻辑也很简单，判断#{usex}不为空且不为""的时候在后面添加SQL。
对应的Dao接口：
public List<MyUser> selectUserByIf(MyUser user);
测试用的Controller：
// 使用if元素查询用户信息
MyUser ifmu = new MyUser();
ifmu.setUname("张");
ifmu.setUsex("女");
List<MyUser> listByif = userDao.selectUserByIf(ifmu);
System.out.println("if元素================");
for (MyUser myUser : listByif) {
System.out.println(myUser);
} 测试结果：
我们试着不设置#{uname}的值，看是否正确拼接了SQL语句：
8.2 <choose>、<when>、<otherwise>元素
有些时候，不想用到所有的条件语句，而只想从中择其一二。针对这种情况，MyBatis 提供了choose选择元素，它有点像Java中的 switch 语句。
映射语句如下：
<!-- 使用choose、when、otherwise元素，根据条件动态查询用户信息 -->
<!-- 类似于Java的switch，注意：当一个when执行后，其他就不再执行 -->
<select id="selectUserByChoose" resultType="com.po.MyUser" parameterType="com.po.MyUser">
select * from user where 1=1
<choose>
<when test="uname !=null and uname!=''">
and uname like concat('%',#{uname},'%')
</when>
<when test="usex !=null and usex!=''">
and usex = #{usex}
</when>
<otherwise>
and uid > 10
</otherwise>
</choose>
</select> <choose>元素就是switch语句，<when>就是case语句，<otherwise> 就是default语句。同样需要注意的是，当一个<when>元素条件满足时候就不在执行<when>其他元素和<otherwise>了，将会直接结束整个<choose>元素。
Dao接口：
public List<MyUser> selectUserByChoose(MyUser user);
Controller中测试：
// 使用choose元素查询用户信息
MyUser choosemu = new MyUser();
choosemu.setUname("");
choosemu.setUsex("");
List<MyUser> listByChoose = userDao.selectUserByChoose(choosemu);
System.out.println("choose元素================");
for (MyUser myUser : listByChoose) {
System.out.println(myUser);
} 我们例子中传入uname和usex为空，所以执行了<otherwise>元素中的语句，如图：
我们这次传一个usex试试，看看语句如何执行：
// 使用choose元素查询用户信息
MyUser choosemu = new MyUser();
choosemu.setUname("");
choosemu.setUsex("女");
List<MyUser> listByChoose = userDao.selectUserByChoose(choosemu);
System.out.println("choose元素================");
for (MyUser myUser : listByChoose) {
System.out.println(myUser);
} 结果如下，当不为usex空时，仅执行了这个 <when test="usex !=null and usex!=''">元素。
8.3 <trim>、<where>、<set>元素
8.3.1 <trim>元素
<trim>元素的主要功能是可以在自己包含的内容前加上某些前缀，也可以在其后加上某些后缀，与之对应的属性是prefix和suffix；可以把包含内容的首部某些内容覆盖，即忽略，也可以把尾部的某些内容覆盖，对应的属性是prefixOverrides和suffixOverrides；正因为<trim>元素有这样的功能，所以也可以非常简单地利用<trim>来代替<where>元素的功能。
映射语句如下：
<!-- 使用trim元素，根据条件动态查询用户信息 -->
<select id="selectUserByTrim" resultType="com.po.MyUser" parameterType="com.po.MyUser">
select * from user
<trim prefix="where" prefixOverrides="and |or">
<if test="uname !=null and uname!=''">
and uname like concat('%',#{uname},'%')
</if>
<if test="usex !=null and usex!=''">
and usex = #{usex}
</if>
</trim>
</select> <trim prefix="where" prefixOverrides="and |or">的意思是：在整个 <trim> 元素范围内，为SQL语句加上"where"前缀，同时去掉"and |or"后缀。和我们第一小节的 where 1=1 是一个意思，智能拼接SQL语句。
对应的Dao接口：
public List<MyUser> selectUserByTrim(MyUser user);
在Controller中测试：
//使用trim元素查询用户信息
MyUser trimmu = new MyUser();
trimmu.setUname("张");
trimmu.setUsex("男");
List<MyUser> listByTrim = userDao.selectUserByTrim(trimmu);
System.out.println("trim元素================");
for (MyUser myUser : listByTrim) {
System.out.println(myUser);
} 从测试结果中我们可以看到Mybatis智能拼接了SQL语句，加上"where"前缀，同时去掉了"and"后缀。
8.3.2 <where>元素
<where>元素的作用是会在写入<where>元素的地方输出一个where语句，另外一个好处是不需要考虑<where>元素里面的条件输出是什么样子的，MyBatis将智能处理。如果所有的条件都不满足，那么MyBatis就会查出所有的记录，如果输出后是and 开头的，MyBatis会把第一个and忽略，当然如果是or开头的，MyBatis也会把它忽略；此外，在<where>元素中不需要考虑空格的问题，MyBatis将智能加上，都是能够实现智能拼接SQL语句功能。
映射语句如下：
<!-- 使用where元素，根据条件动态查询用户信息 -->
<select id="selectUserByWhere" resultType="com.po.MyUser" parameterType="com.po.MyUser">
select * from user
<where>
<if test="uname !=null and uname!=''">
and uname like concat('%',#{uname},'%')
</if>
<if test="usex !=null and usex!=''">
and usex = #{usex}
</if>
</where>
</select> 在这个<where> 元素中，自动加上了where前缀，并且去掉了and后缀。
Dao接口：
public List<MyUser> selectUserByWhere(MyUser user);
Controller的测试：
//使用where元素查询用户信息
MyUser wheremu = new MyUser();
wheremu.setUname("张");
wheremu.setUsex("男");
List<MyUser> listByWhere = userDao.selectUserByWhere(wheremu);
System.out.println("where元素================");
for (MyUser myUser : listByWhere) {
System.out.println(myUser);
} 结果同上一小节一样：
8.3.3 <set>元素
在动态update语句中，可以使用<set>元素动态更新列。
映射语句：
<!-- 使用set元素，动态修改一个用户 -->
<update id="updateUserBySet" parameterType="com.po.MyUser">
update user
<set>
<if test="uname != null">uname=#{uname},</if>
<if test="usex != null">usex=#{usex}</if>
</set>
where uid = #{uid}
</update> 在 <set>元素中，当uname不为空时，SQL语句自动加上uname=#{uname}，也就是哪个列传来的值不为空，就会更新此列。
Dao接口：
public int updateUserBySet(MyUser user);
Controller中测试：
//使用set元素修改一个用户
MyUser setmu = new MyUser();
setmu.setUid(1);
setmu.setUname("张九");
int setup = userDao.updateUserBySet(setmu);
System.out.println("set元素修改了" + setup + "条记录");
System.out.println( "================"); 从运行截图可以看到，因为uname不为空，所有修改这一列：
8.4 <foreach>元素
<foreach>元素主要用在构建in条件中，它可以在SQL语句中进行迭代一个集合。foreach元素的属性主要有item，index，collection，open，separator，close。
item表示集合中每一个元素进行迭代时的别名，即变量名。
index指定一个名字，用于表示在迭代过程中，每次迭代到的位置，就是循环索引。
open表示该语句以什么开始，通常构建in时候，以"("作为拼接SQL的前缀。
close表示以什么结束。以")"作为拼接SQL的后缀，
separator表示在每次进行迭代之间以什么符号作为分隔符，视传入参数的类型而定。
在使用<foreach>时，最关键的也是最容易出错的是collection属性，该属性是必选的，但在不同情况下，该属性的值是不一样的，主要有以下3种情况：
如果传入的是单参数且参数类型是一个List的时候，collection属性值为list。如果传入的是单参数且参数类型是一个array数组的时候，collection的属性值为array。如果传入的参数是多个时，需要把它们封装成一个Map，当然单参数也可以封装成Map。Map的key是参数名，collection属性值是传入的List或array对象在自己封装的Map中的key，就是实际需要<foreach>元素遍历的值名称。 看着定义很繁琐，其实一个例子就能弄清楚了，如下。定义映射语句：
<!-- 使用foreach元素，查询用户信息 -->
<select id="selectUserByForeach" resultType="com.po.MyUser" parameterType="List">
select * from user where uid in
<foreach item="item" index="index" collection="list"
open="(" separator="," close=")">
#{item}
</foreach>
</select> parameterType="List"表示传入的参数是List，故而collection的属性是"list"。这段代码用Java解释为：
for (int index = 0; index < list.length; index++) {
item=list[index];
} 对应的Dao接口，注意传入和返回的参数类型哦：
public List<MyUser> selectUserByForeach(List<Integer> listId);
Controller中测试：
// 使用foreach元素，查询用户信息
List<Integer> listId = new ArrayList<Integer>();
listId.add(1);
listId.add(11);
listId.add(31);
System.out.println("传入的参数为："+listId);
List<MyUser> listByForeach = userDao.selectUserByForeach(listId);
System.out.println("foreach元素================");
for (MyUser myUser : listByForeach) {
System.out.println(myUser);
} 拼接后的SQL语句为：select * from user where uid in ( ? , ? , ? ) 。结果如图：
补充：当传入多个参数，即foreach的参数为map类型时候
我们有时候需要多个条件的查询语句时候，如：select * from user where usex = ? and uid in ( ? , ? , ? ) 这样的语句时候，就需要往<select>元素中传入多个值，这个时候<foreach>元素中collection属性的值就得为<foreach>遍历中实际传入item的值了。同样的，看例子就懂了，如下映射语句：
<select id="getWorkshopByMap" resultType="com.po.MyUser" parameterType="java.util.Map"> select * from user where usex = #{usex} and uid in <foreach item="item" index="index" collection="maps" open="(" separator="," close=")"> #{item} </foreach> </select>
Dao接口：
List<MyUser> selectUserByForeachMap(HashMap map);
Controller中测试：
// 使用foreach元素，查询用户信息
List<Integer> listId = new ArrayList<Integer>();
listId.add(1);
listId.add(11);
listId.add(31);
HashMap map = new HashMap();
//注意这个maps对应<foreach>元素中collection属性的值
//因为我们需要其中的id值
map.put("maps",listId);
map.put("usex","女");
System.out.println("传入的参数为："+map);
List<MyUser> listByForeach = userDao.selectUserByForeachMap(map);
System.out.println("foreach元素================");
for (MyUser myUser : listByForeach) {
System.out.println(myUser);
} 注意这个map.put("maps",listId);中的maps对应<foreach>元素中collection属性的值，因为我们需要这个id值来传给<foreach>元素解析。map.put("usex","女");中的usex对应SQL语句的usex = #{usex}，结果图：
8.5 <bind>元素
在模糊查询时，如果使用“${}”拼接字符串，则无法防止SQL注入问题。如果使用字符串拼接函数或连接符号，但不同数据库的拼接函数或连接符号不同，如mysql的concat函数、Oracle的连接符号“||”。这样，SQL映射文件就需要根据不同的数据库提供不同的实现，显然是比较麻烦，且不利于代码的移植。幸运的是，MyBatis提供了<bind>元素来解决这一问题。
映射语句：
<!-- 使用bind元素进行模糊查询 -->
<select id="selectUserByBind" resultType="com.po.MyUser" parameterType="com.po.MyUser">
<!-- bind中uname是com.po.MyUser的属性名 -->
<bind name="paran_uname" value="'%' + uname + '%'"/>
select * from user where uname like #{paran_uname}
</select> Dao接口：
public List<MyUser> selectUserByBind(MyUser user);
Controller中测试：
//使用bind元素查询用户信息
MyUser bindmu = new MyUser();
bindmu.setUname("张");
List<MyUser> listByBind = userDao.selectUserByBind(bindmu);
System.out.println("bind元素================");
for (MyUser myUser : listByBind) {
System.out.println(myUser);
} 看看我们最后正确的字符串拼接结果：%张%
运行截图：
本章知识点讲解完毕，这一章还是比较简单的，可能foreach那里有一点点绕，但是做个例子就非常简单了。大家有不懂的可以公众号留言，也可以看看公共号的其他相关文章，最近都是有关Mybatis框架知识的，希望对您有所帮助，本系列教程所有源码见下面地址。
本教程所有源码地址：
https://github.com/jiahaoit/java_ssm_course
加载全部内容