MyBatis學習 之 四、動态SQL語句

   有些時候，sql語句where條件中，需要一些安全判斷，例如按某一條件查詢時如果傳入的參數是空，此時查詢出的結果很可能是空的，也許我們需要參數為空時，是查出全部的資訊。使用Oracle的序列、mysql的函數生成Id。這時我們可以使用動态sql。

       下文均采用mysql文法和函數（例如字元串連結函數CONCAT）。

       在insert語句中，在Oracle經常使用序列、在MySQL中使用函數來自動生成插入表的主鍵，而且需要方法能傳回這個生成主鍵。使用myBatis的selectKey标簽可以實作這個效果。

       下面例子，使用mysql資料庫自定義函數nextval('student')，用來生成一個key，并把他設定到傳入的實體類中的studentId屬性上。是以在執行完此方法後，邊可以通過這個實體類擷取生成的key。

Xml代碼  

<!-- 插入學生 自動主鍵-->  

<insert id="createStudentAutoKey" parameterType="liming.student.manager.data.model.StudentEntity" keyProperty="studentId">  

    <selectKey keyProperty="studentId" resultType="String" order="BEFORE">  

        select nextval('student')  

    </selectKey>  

    INSERT INTO STUDENT_TBL(STUDENT_ID,  

                            STUDENT_NAME,  

                            STUDENT_SEX,  

                            STUDENT_BIRTHDAY,  

                            STUDENT_PHOTO,  

                            CLASS_ID,  

                            PLACE_ID)  

    VALUES (#{studentId},  

            #{studentName},  

            #{studentSex},  

            #{studentBirthday},  

            #{studentPhoto, javaType=byte[], jdbcType=BLOB, typeHandler=org.apache.ibatis.type.BlobTypeHandler},  

            #{classId},  

            #{placeId})  

</insert>  

調用接口方法，和擷取自動生成key

Java代碼  

StudentEntity entity = new StudentEntity();  

entity.setStudentName("黎明你好");  

entity.setStudentSex(1);  

entity.setStudentBirthday(DateUtil.parse("1985-05-28"));  

entity.setClassId("20000001");  

entity.setPlaceId("70000001");  

this.dynamicSqlMapper.createStudentAutoKey(entity);  

System.out.println("新增學生ID: " + entity.getStudentId());  

selectKey語句屬性配置細節：

屬性

描述

取值

keyProperty

selectKey 語句生成結果需要設定的屬性。

resultType

生成結果類型，MyBatis 允許使用基本的資料類型，包括String 、int類型。

order

1：BEFORE，會先選擇主鍵，然後設定keyProperty，再執行insert語句；

2：AFTER，就先運作insert 語句再運作selectKey 語句。

BEFORE

AFTER

statementType

MyBatis 支援STATEMENT，PREPARED和CALLABLE 的語句形式， 對應Statement ，PreparedStatement 和CallableStatement 響應

STATEMENT

PREPARED

CALLABLE

 if标簽可用在許多類型的sql語句中，我們以查詢為例。首先看一個很普通的查詢：

<!-- 查詢學生list，like姓名 -->  

<select id="getStudentListLikeName" parameterType="StudentEntity" resultMap="studentResultMap">  

    SELECT * from STUDENT_TBL ST   

WHERE ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName}),'%')  

</select>  

但是此時如果studentName或studentSex為null，此語句很可能報錯或查詢結果為空。此時我們使用if動态sql語句先進行判斷，如果值為null或等于空字元串，我們就不進行此條件的判斷，增加靈活性。

參數為實體類StudentEntity。将實體類中所有的屬性均進行判斷，如果不為空則執行判斷條件。

<!-- 2 if(判斷參數) - 将實體類不為空的屬性作為where條件 -->  

<select id="getStudentList_if" resultMap="resultMap_studentEntity" parameterType="liming.student.manager.data.model.StudentEntity">  

    SELECT ST.STUDENT_ID,  

           ST.STUDENT_NAME,  

           ST.STUDENT_SEX,  

           ST.STUDENT_BIRTHDAY,  

           ST.STUDENT_PHOTO,  

           ST.CLASS_ID,  

           ST.PLACE_ID  

      FROM STUDENT_TBL ST   

     WHERE  

    <if test="studentName !=null ">  

        ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName, jdbcType=VARCHAR}),'%')  

    </if>  

    <if test="studentSex != null and studentSex != '' ">  

        AND ST.STUDENT_SEX = #{studentSex, jdbcType=INTEGER}  

    <if test="studentBirthday != null ">  

        AND ST.STUDENT_BIRTHDAY = #{studentBirthday, jdbcType=DATE}  

    <if test="classId != null and classId!= '' ">  

        AND ST.CLASS_ID = #{classId, jdbcType=VARCHAR}  

    <if test="classEntity != null and classEntity.classId !=null and classEntity.classId !=' ' ">  

        AND ST.CLASS_ID = #{classEntity.classId, jdbcType=VARCHAR}  

    <if test="placeId != null and placeId != '' ">  

        AND ST.PLACE_ID = #{placeId, jdbcType=VARCHAR}  

    <if test="placeEntity != null and placeEntity.placeId != null and placeEntity.placeId != '' ">  

        AND ST.PLACE_ID = #{placeEntity.placeId, jdbcType=VARCHAR}  

    <if test="studentId != null and studentId != '' ">  

        AND ST.STUDENT_ID = #{studentId, jdbcType=VARCHAR}  

    </if>   

使用時比較靈活， new一個這樣的實體類，我們需要限制那個條件，隻需要附上相應的值就會where這個條件，相反不去指派就可以不在where中判斷。

public void select_test_2_1() {  

    StudentEntity entity = new StudentEntity();  

    entity.setStudentName("");  

    entity.setStudentSex(1);  

    entity.setStudentBirthday(DateUtil.parse("1985-05-28"));  

    entity.setClassId("20000001");  

    //entity.setPlaceId("70000001");  

    List<StudentEntity> list = this.dynamicSqlMapper.getStudentList_if(entity);  

    for (StudentEntity e : list) {  

        System.out.println(e.toString());  

    }  

}  

       當where中的條件使用的if标簽較多時，這樣的組合可能會導緻錯誤。我們以在3.1中的查詢語句為例子，當java代碼按如下方法調用時：

@Test  

    entity.setStudentName(null);  

如果上面例子，參數studentName為null，将不會進行STUDENT_NAME列的判斷，則會直接導“WHERE AND”關鍵字多餘的錯誤SQL。

這時我們可以使用where動态語句來解決。這個“where”标簽會知道如果它包含的标簽中有傳回值的話，它就插入一個‘where’。此外，如果标簽傳回的内容是以AND 或OR 開頭的，則它會剔除掉。

上面例子修改為：

<!-- 3 select - where/if(判斷參數) - 将實體類不為空的屬性作為where條件 -->  

<select id="getStudentList_whereIf" resultMap="resultMap_studentEntity" parameterType="liming.student.manager.data.model.StudentEntity">  

    <where>  

        <if test="studentName !=null ">  

            ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName, jdbcType=VARCHAR}),'%')  

        </if>  

        <if test="studentSex != null and studentSex != '' ">  

            AND ST.STUDENT_SEX = #{studentSex, jdbcType=INTEGER}  

        <if test="studentBirthday != null ">  

            AND ST.STUDENT_BIRTHDAY = #{studentBirthday, jdbcType=DATE}  

        <if test="classId != null and classId!= '' ">  

            AND ST.CLASS_ID = #{classId, jdbcType=VARCHAR}  

        <if test="classEntity != null and classEntity.classId !=null and classEntity.classId !=' ' ">  

            AND ST.CLASS_ID = #{classEntity.classId, jdbcType=VARCHAR}  

        <if test="placeId != null and placeId != '' ">  

            AND ST.PLACE_ID = #{placeId, jdbcType=VARCHAR}  

        <if test="placeEntity != null and placeEntity.placeId != null and placeEntity.placeId != '' ">  

            AND ST.PLACE_ID = #{placeEntity.placeId, jdbcType=VARCHAR}  

        <if test="studentId != null and studentId != '' ">  

            AND ST.STUDENT_ID = #{studentId, jdbcType=VARCHAR}  

    </where>    

當update語句中沒有使用if标簽時，如果有一個參數為null，都會導緻錯誤。

當在update語句中使用if标簽時，如果前面的if沒有執行，則或導緻逗号多餘錯誤。使用set标簽可以将動态的配置SET 關鍵字，和剔除追加到條件末尾的任何不相關的逗号。

       使用if+set标簽修改後，如果某項為null則不進行更新，而是保持資料庫原值。如下示例：

<!-- 4 if/set(判斷參數) - 将實體類不為空的屬性更新 -->  

<update id="updateStudent_if_set" parameterType="liming.student.manager.data.model.StudentEntity">  

    UPDATE STUDENT_TBL  

    <set>  

        <if test="studentName != null and studentName != '' ">  

            STUDENT_TBL.STUDENT_NAME = #{studentName},  

            STUDENT_TBL.STUDENT_SEX = #{studentSex},  

            STUDENT_TBL.STUDENT_BIRTHDAY = #{studentBirthday},  

        <if test="studentPhoto != null ">  

            STUDENT_TBL.STUDENT_PHOTO = #{studentPhoto, javaType=byte[], jdbcType=BLOB, typeHandler=org.apache.ibatis.type.BlobTypeHandler},  

        <if test="classId != '' ">  

            STUDENT_TBL.CLASS_ID = #{classId}  

        <if test="placeId != '' ">  

            STUDENT_TBL.PLACE_ID = #{placeId}  

    </set>  

    WHERE STUDENT_TBL.STUDENT_ID = #{studentId};      

</update>  

       trim是更靈活的去處多餘關鍵字的标簽，他可以實踐where和set的效果。

3.5.1trim代替where

<!-- 5.1 if/trim代替where(判斷參數) - 将實體類不為空的屬性作為where條件 -->  

<select id="getStudentList_if_trim" resultMap="resultMap_studentEntity">  

    <trim prefix="WHERE" prefixOverrides="AND|OR">  

    </trim>     

<!-- 5.2 if/trim代替set(判斷參數) - 将實體類不為空的屬性更新 -->  

<update id="updateStudent_if_trim" parameterType="liming.student.manager.data.model.StudentEntity">  

    <trim prefix="SET" suffixOverrides=",">  

            STUDENT_TBL.CLASS_ID = #{classId},  

    </trim>  

    WHERE STUDENT_TBL.STUDENT_ID = #{studentId}  

    有時候我們并不想應用所有的條件，而隻是想從多個選項中選擇一個。而使用if标簽時，隻要test中的表達式為true，就會執行if标簽中的條件。 MyBatis提供了choose 元素。if标簽是與(and)的關系，而choose比傲天是或（or）的關系。

    choose标簽是按順序判斷其内部when标簽中的test條件出否成立，如果有一個成立，則choose結束。當choose中所有when的條件都 不滿則時，則執行otherwise中的sql。類似于Java 的switch 語句，choose為switch，when為case，otherwise則為default。

    例如下面例子，同樣把所有可以限制的條件都寫上，方面使用。choose會從上到下選擇一個when标簽的test為true的sql執行。安全考慮，我們使用where将choose包起來，放置關鍵字多于錯誤。

<!-- 6 choose(判斷參數) - 按順序将實體類第一個不為空的屬性作為where條件 -->  

<select id="getStudentList_choose" resultMap="resultMap_studentEntity" parameterType="liming.student.manager.data.model.StudentEntity">  

        <choose>  

            <when test="studentName !=null ">  

                ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName, jdbcType=VARCHAR}),'%')  

            </when >  

            <when test="studentSex != null and studentSex != '' ">  

                AND ST.STUDENT_SEX = #{studentSex, jdbcType=INTEGER}  

            <when test="studentBirthday != null ">  

                AND ST.STUDENT_BIRTHDAY = #{studentBirthday, jdbcType=DATE}  

            <when test="classId != null and classId!= '' ">  

                AND ST.CLASS_ID = #{classId, jdbcType=VARCHAR}  

            <when test="classEntity != null and classEntity.classId !=null and classEntity.classId !=' ' ">  

                AND ST.CLASS_ID = #{classEntity.classId, jdbcType=VARCHAR}  

            <when test="placeId != null and placeId != '' ">  

                AND ST.PLACE_ID = #{placeId, jdbcType=VARCHAR}  

            <when test="placeEntity != null and placeEntity.placeId != null and placeEntity.placeId != '' ">  

                AND ST.PLACE_ID = #{placeEntity.placeId, jdbcType=VARCHAR}  

            <when test="studentId != null and studentId != '' ">  

                AND ST.STUDENT_ID = #{studentId, jdbcType=VARCHAR}  

            <otherwise>  

            </otherwise>  

        </choose>  

對于動态SQL 非常必須的，主是要疊代一個集合，通常是用于IN 條件。List 執行個體将使用“list”做為鍵，數組執行個體以“array” 做為鍵。

foreach元素是非常強大的，它允許你指定一個集合，聲明集合項和索引變量，它們可以用在元素體内。它也允許你指定開放和關閉的字元串，在疊代之間放置分隔符。這個元素是很智能的，它不會偶然地附加多餘的分隔符。

注意：你可以傳遞一個List執行個體或者數組作為參數對象傳給MyBatis。當你這麼做的時候，MyBatis會自動将它包裝在一個Map中，用名稱在作為鍵。List執行個體将會以“list”作為鍵，而數組執行個體将會以“array”作為鍵。

這個部分是對關于XML配置檔案和XML映射檔案的而讨論的。下一部分将詳細讨論Java API，是以你可以得到你已經建立的最有效的映射。

接口的方法聲明：

public List<StudentEntity> getStudentListByClassIds_foreach_array(String[] classIds);  

動态SQL語句：

<!— 7.1 foreach(循環array參數) - 作為where中in的條件 -->  

<select id="getStudentListByClassIds_foreach_array" resultMap="resultMap_studentEntity">  

      FROM STUDENT_TBL ST  

      WHERE ST.CLASS_ID IN   

     <foreach collection="array" item="classIds"  open="(" separator="," close=")">  

        #{classIds}  

     </foreach>  

測試代碼，查詢學生中，在20000001、20000002這兩個班級的學生：

public void test7_foreach() {  

    String[] classIds = { "20000001", "20000002" };  

    List<StudentEntity> list = this.dynamicSqlMapper.getStudentListByClassIds_foreach_array(classIds);  

<p>}<span style="font-size: 14px; font-weight: bold; white-space: normal;">  </span></p>  

public List<StudentEntity> getStudentListByClassIds_foreach_list(List<String> classIdList);  

<!-- 7.2 foreach(循環List<String>參數) - 作為where中in的條件 -->  

<select id="getStudentListByClassIds_foreach_list" resultMap="resultMap_studentEntity">  

     <foreach collection="list" item="classIdList"  open="(" separator="," close=")">  

        #{classIdList}  

public void test7_2_foreach() {  

    ArrayList<String> classIdList = new ArrayList<String>();  

    classIdList.add("20000001");  

    classIdList.add("20000002");  

    List<StudentEntity> list = this.dynamicSqlMapper.getStudentListByClassIds_foreach_list(classIdList);