MyBatis中動態SQL元素的使用

掌握MyBatis中動態SQL元素的使用

• if
• choose（when，otherwise）
• trim
• where
• set
• foreach
• <SQL>和<include>

在應用中我們經常會做一些動態的拼接條件，但是如果是JDBC我們可以用程序拼接SQL語句，如果MyBatis，我們可以使用動態SQL語句。例如按照員工姓名和工資來搜索員工信息，如果如果姓名和工資的檢索值為空，則忽略這個檢索條件。一般來說，我們都會用where 1=1類似這種寫法來實現，但是MyBatis就需要動態語句實現。

1      if元素

mapper.xml

<select id="selectStudentByCondition" parameterType="student" resultMap="BaseResultMap">
        select * from student where 1=1
        <!-- 當傳入的屬性值為空或者空字符串時會忽略掉條件
            注意：test中的pojo中的屬性名稱
                 like的使用
                 <![CDATA[ ]]>的使用-->
        <if test="stuName !=null and stuName != ''">
            and stu_name like '%' ||#{stuName}||'%'
        </if>
        <if test="stuBirthdate != null">
            <![CDATA[and stu_birthdate>#{stuBirthdate}]]>
        </if>
    </select>

daoImpl.java

@Override
public void testQuery6(Student s){
    SqlSession session = fac.openSession();
    List<Student> result = session.selectList("student.selectStudentByCondition",s);
    for (Student s1 : result) {
        System.out.println("s1  id=" + s1.getStuId());
        System.out.println("s1  name=" + s1.getStuName());
        System.out.println("s1  Birthdate=" + s1.getStuBirthdate());
    }
    session.close();
}

測試

public static void main(String[] args) throws Exception {
    //創建要保存的學生信息
    Student s = new Student();
    s.setStuName("zhou");
    s.setStuBirthdate(new SimpleDateFormat("yyyy-MM-dd").parse("1991-1-12"));
    
    StudentDao sdao = new StudentDaoImpl(fac);
    sdao.testQuery6(s);
}

2     choose元素

choose元素相當於java語句的if … else if …else語句

<!-- 動態SQL：choose標簽 -->
<select id="queryByCondition2" parameterType="student " resultMap="BaseResultMap">
select * from student where 1=1
<choose>
<when test="stuName != null and stuName != ''">
          and stu_name=#{stuName}
</when>
<when test="stuBirthdate != null">
          and stu_birthdate=#{stuBirthdate}
</when>
<otherwise>
           and stu_phone=#{stuPhone}
</otherwise>
</choose>
</select>

3      WHERE元素

使用where元素會自動根據條件的個數增刪where語句and運算符，所以不需要寫where 1=1之類的語句

<!-- 動態SQL：where標簽 -->
<select id="queryByCondition3" parameterType="student " resultMap="BaseResultMap">
select * from student
<where>
<if test="stuName != null and stuName != ''">
    and stu_name=#{stuName}
</if>
<if test="stuBirthdate != null">
    and stu_birthdate=#{stuBirthdate}
</if>
<if test="stuPhone != null and stuPhone != ''">
    and stu_phone=#{stuPhone}
</if>
</where>
</select>

4      Trim元素

trim元素的主要功能是可以在自己包含的內容前加上某些前綴，也可以在其后加上某些后綴，與之對應的屬性是prefix和suffix；可以把包含內容的首部某些內容覆蓋，即忽略，也可以把尾部的某些內容覆蓋，對應的屬性是prefixOverrides和suffixOverrides 

<!-- 動態SQL：trim標簽 -->
<select id="queryByCondition4" parameterType="student " resultMap="BaseResultMap">
select * from student
<trim prefix="where" prefixOverrides="and|or">
<if test="stuName != null and stuName != ''">
    and stu_name=#{stuName}
</if>
<if test="stuBirthdate != null">
    and stu_birthdate=#{stuBirthdate}
</if>
<if test="stuPhone != null and stuPhone != ''">
    or stu_phone=#{stuPhone}
</if>
</trim>
</select>

5      foreach元素

foreach的主要用在構建in條件中，它可以在SQL語句中進行迭代一個集合。foreach元素的屬性主要有item，index，collection，open，separator，close。item表示集合中每一個元素進行迭代時的別名，index指定一個名字，用於表示在迭代過程中，每次迭代到的位置，open表示該語句以什么開始，separator表示在每次進行迭代之間以什么符號作為分隔符，close表示以什么結束，在使用foreach的時候最關鍵的也是最容易出錯的就是collection屬性，該屬性是必須指定的，但是在不同情況下，該屬性的值是不一樣的，主要有以下3種情況。

1. 如果傳入的是單參數且參數類型是一個List的時候，collection屬性值為list
2. 如果傳入的是單參數且參數類型是一個array數組的時候，collection的屬性值為array
3. 如果傳入的參數是多個的時候，我們就需要把它們封裝成一個Map了，當然單參數也可以封裝成map，實際上如果你在傳入參數的時候，在MyBatis里面也是會把它封裝成一個Map的，map的key就是參數名，所以這個時候collection屬性值就是傳入的List或array對象在自己封裝的map里面的key

Mapper.xml

<!-- 動態SQL：傳入Array數組 -->
    <select id="queryByInArray" resultMap="BaseResultMap">
       select * from student 
    <if test="array.length>0">
        where stu_id in 
        <foreach collection="array" index="i" item="stuId" open="(" close=")" separator=",">
            #{stuId}
        </foreach>
    </if>
    </select>
<!-- 動態SQL：傳入List集合 -->
    <select id="queryByInList" resultMap="BaseResultMap">
        select * from student
        <if test="list.size()>0">
            where stu_id in
            <foreach collection="list" index="i" item="stuId" open="("
                close=")" separator=",">
                #{stuId}
            </foreach>
        </if>
    </select>
<!-- 動態SQL：傳入Map集合包含List集合 -->
    <select id="queryByInMap" resultMap="BaseResultMap">
        select * from student
        <if test="ids.size()>0">
            where stu_id in
            <foreach collection="ids" index="i" item="stuId" open="("
                close=")" separator=",">
                #{stuId}
            </foreach>
        </if>
    </select>

DaoImpl.java

@Override
    public void testQuery7(){
        SqlSession session = fac.openSession();
        int[] ids = new int[]{2};
        List<Student> list = session.selectList("student.queryByInArray",ids);
        for (Student item : list) {
            System.out.println(item);
        }
        session.close();
    }
@Override
    public void testQuery8(){
        SqlSession session = fac.openSession();
        List ids = new ArrayList();
        ids.add(2);
        ids.add(3);
        ids.add(4);
        List<Student> list = session.selectList("student.queryByInList",ids);
        for (Student item : list) {
            System.out.println(item);
        }
session.close();
    }
    @Override
    public void testQuery8(){
        SqlSession session = fac.openSession();
        List ids = new ArrayList();
        ids.add(2);
        ids.add(3);
        Map map = new HashMap();
        map.put("ids", ids);
        List<Student> list = session.selectList("student.queryByInMap",map);
        for (Student item : list) {
            System.out.println(item);
        }
        session.close();
    }

6      set元素

set元素主要是用在更新操作的時候，它的主要功能和where元素其實是差不多的，主要是在包含的語句前輸出一個set，然后如果包含的語句是以逗號結束的話將會把該逗號忽略，如果set包含的內容為空的話則會出錯。有了set元素我們就可以動態的更新那些修改了的字段。

    <!-- 動態SQL：set更新 -->
<update id="updateByCondition" parameterType="student">
    update student
    <set>
        <if test="stuName!=null and stuName!=''">
            stu_name=#{stuName},
        </if>
        <if test="stuBirthdate!=null">
            stu_birthdate=#{stuBirthdate},
        </if>
        <if test="stuPhone!=null and stuPhone!=''">
            stu_phone=#{stuPhone}
        </if>
    </set>
    where stu_id=#{stuId}
</update>

7      <SQL>和<include>

可以編寫一些語句片段<SQL>標簽，然后在其他語句標簽匯中用<include>引用，這樣可以是SQL語句片段得到重用

示例：

<!-- SQL片段 -->
<SQL id="SQL_select">
         select *
 </SQL>
<SQL id="SQL_count">
         select count(*)
</SQL>

<!-- 包含SQL片段 -->
<select id="query6" resultMap="BaseResultMap">
         <include refid="SQL_select"/>
         from student
</select>

<select id="query7" resultType="java.lang.Integer">
         <include refid="SQL_count"/>
         from student
</select>