【MyBatis】（4）mapper映射文件中动态sql的使用

动态sql

动态sql : sql的内容是变化的，可以根据条件获取到不同的sql语句。
主要是where部分发生变化。

动态 SQL，主要用于解决查询条件不确定的情况：在程序运行期间，根据用户提交的查询条件进行查询。提交的查询条件不同，执行的 SQL 语句就会不同。若将每种可能的情况均逐一列出，对所有条件进行排列组合，将会出现大量的 SQL 语句。此时，可使用动态 SQL 来解决这样的问题

 动态sql的实现，使用的是mybatis提供的标签，如： <if> ,<where>,<foreach>

注意：动态sql中接口方法的传入参数用 java对象

在 mapper 的动态 SQL 中若出现大于号（>）、小于号（<）、大于等于号（>=）、小于等于号（<=）等符号，最好将其转换为实体符号。否则，XML 可能会出现解析出错问题。

特别是对于小于号（<），在 XML 中是绝不能出现的。否则解析 mapper 文件会出错。

实体符号表：

数学符号	含义	实体符号
<	小于	&lt;
>	大于	&gt;
>=	大于等于	&gt;=
<=	小于等于	&lt;=

1. <if>

<if> 是用于判断条件的，对于该标签的执行，当 test 的值为 true 时，会将其包含的 SQL 片断拼接到其所在的 SQL 语句中。
语法 :

		<if test="判断java对象的属性值">
            部分sql语句
	    </if>

接口方法：

List<Student> selectStudentIf(Student student);	

mapper.xml :

<!--if
	<if test="使用传入参数java对象的属性值作为判断条件">
-->
<select id="selectStudentIf" resultType="com.kaho.domain.Student">
     select id,name,email,age from student
     where 1=1  这一个"1=1"很重要！！！
     <if test="name != null and name !='' ">
     	and name = #{name}
     </if>
     <if test="age > 0 ">
     	and age &gt; #{age}
     </if>
</select>

测试方法：

@Test
public void testSelect() throws IOException {
    
    
 	 Student student = new Student();
     student.setName("桐谷和人");
     student.setAge(18);
     List<Student> studentList = studentDao.selectStudentIf(student);
     studentList.forEach( stu -> System.out.println(stu));
}

注意：

扫描二维码关注公众号，回复： 15898949 查看本文章

当使用 <if/> 标签时，需要在 where 后手工添加 “1=1” 子句。因为，若 where 后的所有 <if/> 条件均为 false，而 where 后又没有 “1=1” 子句，则 SQL 中就会只剩下一个空的 where，SQL 会出错。所以，在 where 后，需要添加一个永为真子句 “1=1”，以防止这种情况的发生。但当数据量很大时，会严重影响查询效率。

更需要注意的是，加了 “1=1” 子句也可能会出问题，例如：可能出现sql语句最终拼接结果为一下这种情况：

select * from student where 1=1 or age=?

这种情况下最后查询的结果可能跟预期结果大有不同，所以要注意！！！

2. <where>

<where> 是用来包含多个 <if> 的， 使用 <where/> 标签，在有查询条件时，可以自动添加上 where 子句；没有查询条件时，不会添加 where 子句。需要注意的是，**第一个 <if/> 标签中的 SQL 片段，可以不包含 and。不过，写上 and 也不会出错，系统会将多出的 and 去掉。但其它 <if/> 中 SQL 片段的 and 必须写上，**否则 SQL 语句将拼接出错。

语法：

<where> 其他动态 sql </where>

接口方法：

List<Student> selectStudentWhere(Student student);

mapper.xml :

<select id="selectStudentWhere" resultType="com.kaho.domain.Student">
     select id,name,email,age from student
     <where>
         <if test="name != null and name !='' ">
             and name = #{name}
         </if>
         <if test="age > 0 ">
             and age &gt; #{age}
         </if>
     </where>
</select>

测试方法：

@Test
public void testSelectWhere() throws IOException {
    
    
     Student student = new Student();
     student.setName("桐谷和人");
     student.setAge(18);
     List<Student> studentList = studentDao.selectStudentWhere(student);
     studentList.forEach( stu -> System.out.println(stu));
}

3. <foreach>

<foreach/> 标签用于遍历 java 中的数组与 List 集合。 主要用在 sql 的 in 语句中。

示例：查询学生id是 1001,1002,1003的三个学生

 要实现的sql:
 select * from student where id in (1001,1002,1003)
 接口方法:
 public List<Student> selectFor(List<Integer> idlist);
 测试方法:
 List<Integer> list = new ArrayList<>();
 list.add(1001);
 list.add(1002);
 list.add(1003);

 dao.selectFor(list)

语法：

 <foreach collection="" item="" open="" close="" separator="">
         #{item的值}
 </foreach>

 collection:表示接口中的方法的参数类型， 如果是数组使用array , 如果是List集合使用list
 item:自定义的，表示数组和集合成员的变量
 open:循环开始时的字符
 close:循环结束时的字符
 separator:集合成员之间的分隔符

1）遍历 List<简单类型>

接口方法：

List<Student> selectStudentForList(List<Integer> idList);

mapper.xml :

<select id="selectStudentForList" resultType="com.kaho.domain.Student">
     select id,name,email,age from student
     <!--表达式中的 List 使用 list 表示，其大小使用 list.size 表示-->
     <if test="list != null and list.size > 0 ">
         where id in
         <foreach collection="list" open="(" close=")" item="stuid" separator=",">
             #{stuid}
         </foreach>
     </if>
</select>

测试方法：

@Test
public void testSelectForList() {
    
    
     List<Integer> list = new ArrayList<>();
     list.add(1001);
     list.add(1002);
     list.add(1003);
     List<Student> studentList = studentDao.selectStudentForList(list);
     studentList.forEach( stu -> System.out.println(stu));
}

2）遍历 List<对象类型>

接口方法：

List<Student> selectStudentForList2(List<Student> stuList);

mapper.xml :

<select id="selectStudentForList2" resultType="com.kaho.domain.Student">
     select id,name,email,age from student
     <if test="list !=null and list.size > 0 ">
         where id in
         <foreach collection="list" open="(" close=")" item="stuobject" separator=",">
         	#{stuobject.id}
         </foreach>
     </if>
</select>

测试方法：

@Test
public void testSelectForList2() {
    
    
     List<Student> list = new ArrayList<>();
     Student student = new Student();
     student.setId(1001);
     list.add(student);
     student = new Student();
     student.setId(1002);
     list.add(student);
     List<Student> studentList = studentDao.selectStudentForList2(list);
     studentList.forEach( stu -> System.out.println(stu));
}

4. 代码片段

sql 代码片段， 就是复用一些语句。<sql/> 标签用于定义 SQL 片段，以便其它 SQL 标签复用。而其它标签使用该 SQL 片段，需要使用 <include/> 子标签。该 <sql/> 标签可以定义 SQL 语句中的任何部分，所以 <include/> 子标签可以放在动态 SQL 的任何位置。

步骤：

 	1. 先定义 <sql id="自定义名称唯一">  sql语句，表名，字段等 </sql>
 	2. 再使用 <include refid="id的值" />

接口方法：

List<Student> selectStudentSqlFragment(List<Student> stuList);

mapper.xml :

<!--创建 sql 片段 id:片段的自定义名称--> 
<sql id="studentSql">
 	select id,name,email,age from student
</sql> 
<select id="selectStudentSqlFragment" resultType="com.kaho.domain.Student">
     <!-- 引用 sql 片段 -->
     <include refid="studentSql"/>
     <if test="list !=null and list.size > 0 ">
         where id in
         <foreach collection="list" open="(" close=")" item="stuobject" separator=",">
         	#{stuobject.id}
         </foreach>
     </if>
</select>

测试方法：

@Test
public void testSelectSqlFragment() {
    
    
     List<Student> list = new ArrayList<>();
     Student student = new Student();
     student.setId(1001);
     list.add(student);
     student = new Student();
     student.setId(1002);
     list.add(student);
     List<Student> studentList = studentDao.selectStudentSqlFragment(list);
     studentList.forEach( stu -> System.out.println(stu));
}