MyBatis学习(四) --------- 动态SQL

---

一、动态 SQL 的概念

动态 SQL，通过 MyBatis 提供的各种标签对条件作出判断以实现动态拼接 SQL 语句。这里的条件判断使用的表达式为 OGNL 表达式。常用的动态 SQL 标签有<if>、<where>、<choose/>、<foreach>等。MyBatis 的动态 SQL 语句，与 JSTL 中的语句非常相似。

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

注意事项：

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

实体符号对应表：

普通符号	实体符号
<	&lt;
>	&gt;
>=	&gt;=
<=	&lt;=

二、动态 SQL 之 < if >

我们首先在 MySql 中创建 Student表，表中有name与age两个字段，其中name为主键

接着，在 Java 中 domain 包下写出Student表相应的映射实体类文件

package com.fancy.domain;

public class Student {
    private String name;
    private int age;

    public Student() {
    }

    public Student(String name, int age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

在StudentDao接口中定义接口方法：

List<Student> selectStudentIf(Student student);

在 mapper 文件中使用动态 SQL 标签 <if>

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

对于该标签的执行，当 test 的值为 true 时，会将其包含的 SQL 片断拼接到其所在的 SQL 语句中。
语法：<if test="条件"> sql 语句的部分 </if>

测试方法：

@Test
public void testStudent() throws IOException {
    String config = "mybatis-config.xml";
    InputStream in = Resources.getResourceAsStream(config);
    SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(in);
    SqlSession session = factory.openSession();
    StudentDao studentDao = session.getMapper(StudentDao.class);
    Student param = new Student();
    param.setAge(12);
    param.setName("hhh");
    List<Student> studentList = studentDao.selectStudentIf(param);
    //studentList.forEach(stu-> System.out.println(stu));
    for (Student stu : studentList) {
        System.out.println(stu);
    }
    session.commit();
    session.close();
}

查询结果：

三、动态 SQL 之 < where >

<if/>标签的中存在一个比较麻烦的地方：需要在 where 后手工添加 1=1 的子句。因为，若 where 后的所有<if/>条件均为 false，而 where 后若又没有 1=1 子句，则 SQL 中就会只剩下一个空的 where，SQL 出错。所以，在 where 后，需要添加永为真子句 1=1，以防止这种情况的发生。但当数据量很大时，会严重影响查询效率。使用<where/>标签，在有查询条件时，可以自动添加上 where 子句；没有查询条件时，不会添加 where 子句。需要注意的是，第一个标签中的 SQL 片断，可以不包含 and。不过，写上 and 也不错，系统会将多出的 and 去掉。但其它中 SQL 片断的 and，必须要求写上。否则 SQL 语句将拼接出错。

语法：<where> 其他动态 sql </where>

然后，与<if>的测试代码相比，只需要重新定义一个接口，然后在 mapper 文件中相应地进行修改即可

接口：

List<Student> selectStudentWhere(Student student);

mapper 文件：

<select id="selectStudentWhere" resultType="com.bjpowernode.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>

四、动态 SQL 之 < foreach >

<foreach/>标签用于实现对于数组与集合的遍历。对其使用，需要注意：

➢ collection 表示要遍历的集合类型, list ，array 等。
➢ open、close、separator 为对遍历内容的 SQL 拼接

语法：
<foreach collection=" 集合类型" open=" 开始的字符" close=" 结束的字符" item=" 集合中的成员" separator=" 集合成员之间的分隔符">
       #{item 的值}
</foreach>

（1) 遍历简单类型

以 List 为例
表达式中的 List 使用 list 表示，其大小使用 list.size 表示。

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

mapper 文件

<select id="selectStudentForList" resultType="com.fancy.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="stuId" separator=",">
            #{stuid}
        </foreach>
     </if>
</select>

测试文件

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

（2）遍历对象类型

接口方法

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

mapper 文件

<select id="selectStudentForList" resultType="com.fancy.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 s1 = new Student();
    s1.setId(1002);
    list.add(s1);
    s1 = new Student();
    s1.setId(1005);
    list.add(s1);
    List<Student> studentList = studentDao.selectStudentForList(list);
    studentList.forEach( stu -> System.out.println(stu));
}

五、动态 SQL 之 代码片段

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

接口方法

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

mapper 文件

<!-- 创建 sql 片段 id: 片段的自定义名称 -->
<sql id="studentSql">
    select id,name,email,age from student
</sql>
<select id="selectStudentSqlFragment" resultType="com.fancy.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 s1 = new Student();
    s1.setId(1002);
    list.add(s1);
    s1 = new Student();
    s1.setId(1005);
    list.add(s1);
    List<Student> studentList = studentDao.selectStudentSqlFragment(list);
    studentList.forEach( stu -> System.out.println(stu));
}