myBatis的动态SQL之标签的使用111

当sql语句where条件中，需要一些安全判断，例如按某一条件查询时如果传入的参数是空，此时查询出的结果很可能是空的，也许我们需要参数为空时，是查出全部的信息。使用Oracle的序列、mysql的函数生成Id。这时我们可以使用动态sql。

1 selectKey 标签

  在 insert 语句中，在 Oracle 经常使用序列、在 MySQL 中使用函数来自动生成插入表的主键，而且需要方法能返回这个生成主键。使用 myBatis 的 selectKey 标签可以实现这个效果。

下面例子，使用mysql数据库自定义函数nextval('student')，用来生成一个key，并把他设置到传入的实体类中的studentId属性上。所以在执行完此方法后，边可以通过这个实体类获取生成的key。

[html]  view plain  copy

1. <!-- 插入学生 自动主键-->  
2. <insert id="createStudentAutoKey" parameterType="liming.student.manager.data.model.StudentEntity" keyProperty="studentId">  
3.     <selectKey keyProperty="studentId" resultType="String" order="BEFORE">  
4.         select nextval('student')  
5.     </selectKey>  
6.     INSERT INTO STUDENT_TBL(STUDENT_ID,  
7.                             STUDENT_NAME,  
8.                             STUDENT_SEX,  
9.                             STUDENT_BIRTHDAY,  
10.                             STUDENT_PHOTO,  
11.                             CLASS_ID,  
12.                             PLACE_ID)  
13.     VALUES (#{studentId},  
14.             #{studentName},  
15.             #{studentSex},  
16.             #{studentBirthday},  
17.             #{studentPhoto, javaType=byte[], jdbcType=BLOB, typeHandler=org.apache.ibatis.type.BlobTypeHandler},  
18.             #{classId},  
19.             #{placeId})  
20. </insert>  

2 if标签

if 标签可用在许多类型的 sql 语句中，我们以查询为例。首先看一个很普通的查询：

[html]  view plain  copy

1. <!-- 查询学生list，like姓名 -->  
2. <select id="getStudentListLikeName" parameterType="StudentEntity" resultMap="studentResultMap">  
3.     SELECT * from STUDENT_TBL ST   
4. WHERE ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName}),'%')  
5. </select>  

但是此时如果studentName或studentSex为null，此语句很可能报错或查询结果为空。此时我们使用if动态sql语句先进行判断，如果值为null或等于空字符串，我们就不进行此条件的判断，增加灵活性。参数为实体类StudentEntity。将实体类中所有的属性均进行判断，如果不为空则执行判断条件。

[html]  view plain  copy

1. <!-- 2 if(判断参数) - 将实体类不为空的属性作为where条件 -->  
2. <select id="getStudentList_if" resultMap="resultMap_studentEntity" parameterType="liming.student.manager.data.model.StudentEntity">  
3.     SELECT ST.STUDENT_ID,  
4.            ST.STUDENT_NAME,  
5.            ST.STUDENT_SEX,  
6.            ST.STUDENT_BIRTHDAY,  
7.            ST.STUDENT_PHOTO,  
8.            ST.CLASS_ID,  
9.            ST.PLACE_ID  
10.       FROM STUDENT_TBL ST   
11.      WHERE  
12.     <if test="studentName !=null ">  
13.         ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName, jdbcType=VARCHAR}),'%')  
14.     </if>  
15.     <if test="studentSex != null and studentSex != '' ">  
16.         AND ST.STUDENT_SEX = #{studentSex, jdbcType=INTEGER}  
17.     </if>  
18.     <if test="studentBirthday != null ">  
19.         AND ST.STUDENT_BIRTHDAY = #{studentBirthday, jdbcType=DATE}  
20.     </if>  
21.     <if test="classId != null and classId!= '' ">  
22.         AND ST.CLASS_ID = #{classId, jdbcType=VARCHAR}  
23.     </if>  
24.     <if test="classEntity != null and classEntity.classId !=null and classEntity.classId !=' ' ">  
25.         AND ST.CLASS_ID = #{classEntity.classId, jdbcType=VARCHAR}  
26.     </if>  
27.     <if test="placeId != null and placeId != '' ">  
28.         AND ST.PLACE_ID = #{placeId, jdbcType=VARCHAR}  
29.     </if>  
30.     <if test="placeEntity != null and placeEntity.placeId != null and placeEntity.placeId != '' ">  
31.         AND ST.PLACE_ID = #{placeEntity.placeId, jdbcType=VARCHAR}  
32.     </if>  
33.     <if test="studentId != null and studentId != '' ">  
34.         AND ST.STUDENT_ID = #{studentId, jdbcType=VARCHAR}  
35.     </if>   
36. </select>  

3 if + where 的条件判断

当where中的条件使用的if标签较多时，这样的组合可能会导致错误。这时我们可以使用where动态语句来解决。这个“where”标签会知道如果它包含的标签中有返回值的话，它就插入一个‘where’。此外，如果标签返回的内容是以AND 或OR 开头的，则它会剔除掉。

上面例子修改为：

[html]  view plain  copy

1. <!-- 3 select - where/if(判断参数) - 将实体类不为空的属性作为where条件 -->  
2. <select id="getStudentList_whereIf" resultMap="resultMap_studentEntity" parameterType="liming.student.manager.data.model.StudentEntity">  
3.     SELECT ST.STUDENT_ID,  
4.            ST.STUDENT_NAME,  
5.            ST.STUDENT_SEX,  
6.            ST.STUDENT_BIRTHDAY,  
7.            ST.STUDENT_PHOTO,  
8.            ST.CLASS_ID,  
9.            ST.PLACE_ID  
10.       FROM STUDENT_TBL ST   
11.     <where>  
12.         <if test="studentName !=null ">  
13.             ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName, jdbcType=VARCHAR}),'%')  
14.         </if>  
15.         <if test="studentSex != null and studentSex != '' ">  
16.             AND ST.STUDENT_SEX = #{studentSex, jdbcType=INTEGER}  
17.         </if>  
18.         <if test="studentBirthday != null ">  
19.             AND ST.STUDENT_BIRTHDAY = #{studentBirthday, jdbcType=DATE}  
20.         </if>  
21.         <if test="classId != null and classId!= '' ">  
22.             AND ST.CLASS_ID = #{classId, jdbcType=VARCHAR}  
23.         </if>  
24.         <if test="classEntity != null and classEntity.classId !=null and classEntity.classId !=' ' ">  
25.             AND ST.CLASS_ID = #{classEntity.classId, jdbcType=VARCHAR}  
26.         </if>  
27.         <if test="placeId != null and placeId != '' ">  
28.             AND ST.PLACE_ID = #{placeId, jdbcType=VARCHAR}  
29.         </if>  
30.         <if test="placeEntity != null and placeEntity.placeId != null and placeEntity.placeId != '' ">  
31.             AND ST.PLACE_ID = #{placeEntity.placeId, jdbcType=VARCHAR}  
32.         </if>  
33.         <if test="studentId != null and studentId != '' ">  
34.             AND ST.STUDENT_ID = #{studentId, jdbcType=VARCHAR}  
35.         </if>  
36.     </where>    
37. </select>  

4 if + set 的更新语句

当update语句中没有使用if标签时，如果有一个参数为null，都会导致错误。

当在update语句中使用if标签时，如果前面的if没有执行，则或导致逗号多余错误。使用set标签可以将动态的配置SET 关键字，和剔除追加到条件末尾的任何不相关的逗号。

使用if+set标签修改后，如果某项为null则不进行更新，而是保持数据库原值。如下示例：

[html]  view plain  copy

1. <!-- 4 if/set(判断参数) - 将实体类不为空的属性更新 -->  
2. <update id="updateStudent_if_set" parameterType="liming.student.manager.data.model.StudentEntity">  
3.     UPDATE STUDENT_TBL  
4.     <set>  
5.         <if test="studentName != null and studentName != '' ">  
6.             STUDENT_TBL.STUDENT_NAME = #{studentName},  
7.         </if>  
8.         <if test="studentSex != null and studentSex != '' ">  
9.             STUDENT_TBL.STUDENT_SEX = #{studentSex},  
10.         </if>  
11.         <if test="studentBirthday != null ">  
12.             STUDENT_TBL.STUDENT_BIRTHDAY = #{studentBirthday},  
13.         </if>  
14.         <if test="studentPhoto != null ">  
15.             STUDENT_TBL.STUDENT_PHOTO = #{studentPhoto, javaType=byte[], jdbcType=BLOB, typeHandler=org.apache.ibatis.type.BlobTypeHandler},  
16.         </if>  
17.         <if test="classId != '' ">  
18.             STUDENT_TBL.CLASS_ID = #{classId}  
19.         </if>  
20.         <if test="placeId != '' ">  
21.             STUDENT_TBL.PLACE_ID = #{placeId}  
22.         </if>  
23.     </set>  
24.     WHERE STUDENT_TBL.STUDENT_ID = #{studentId};      
25. </update>  

5 choose(when, otherwise)

有时候我们并不想应用所有的条件，而只是想从多个选项中选择一个。而使用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包起来，放置关键字多于错误。

[html]  view plain  copy

1. <!-- 6 choose(判断参数) - 按顺序将实体类第一个不为空的属性作为where条件 -->  
2. <select id="getStudentList_choose" resultMap="resultMap_studentEntity" parameterType="liming.student.manager.data.model.StudentEntity">  
3.     SELECT ST.STUDENT_ID,  
4.            ST.STUDENT_NAME,  
5.            ST.STUDENT_SEX,  
6.            ST.STUDENT_BIRTHDAY,  
7.            ST.STUDENT_PHOTO,  
8.            ST.CLASS_ID,  
9.            ST.PLACE_ID  
10.       FROM STUDENT_TBL ST   
11.     <where>  
12.         <choose>  
13.             <when test="studentName !=null ">  
14.                 ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName, jdbcType=VARCHAR}),'%')  
15.             </when >  
16.             <when test="studentSex != null and studentSex != '' ">  
17.                 AND ST.STUDENT_SEX = #{studentSex, jdbcType=INTEGER}  
18.             </when >  
19.             <when test="studentBirthday != null ">  
20.                 AND ST.STUDENT_BIRTHDAY = #{studentBirthday, jdbcType=DATE}  
21.             </when >  
22.             <when test="classId != null and classId!= '' ">  
23.                 AND ST.CLASS_ID = #{classId, jdbcType=VARCHAR}  
24.             </when >  
25.             <when test="classEntity != null and classEntity.classId !=null and classEntity.classId !=' ' ">  
26.                 AND ST.CLASS_ID = #{classEntity.classId, jdbcType=VARCHAR}  
27.             </when >  
28.             <when test="placeId != null and placeId != '' ">  
29.                 AND ST.PLACE_ID = #{placeId, jdbcType=VARCHAR}  
30.             </when >  
31.             <when test="placeEntity != null and placeEntity.placeId != null and placeEntity.placeId != '' ">  
32.                 AND ST.PLACE_ID = #{placeEntity.placeId, jdbcType=VARCHAR}  
33.             </when >  
34.             <when test="studentId != null and studentId != '' ">  
35.                 AND ST.STUDENT_ID = #{studentId, jdbcType=VARCHAR}  
36.             </when >  
37.             <otherwise>  
38.             </otherwise>  
39.         </choose>  
40.     </where>    
41. </select>  

7 foreach

[html]  view plain  copy

1. <!— 7.1 foreach(循环array参数) - 作为where中in的条件 -->  
2. <select id="getStudentListByClassIds_foreach_array" resultMap="resultMap_studentEntity">  
3.     SELECT ST.STUDENT_ID,  
4.            ST.STUDENT_NAME,  
5.            ST.STUDENT_SEX,  
6.            ST.STUDENT_BIRTHDAY,  
7.            ST.STUDENT_PHOTO,  
8.            ST.CLASS_ID,  
9.            ST.PLACE_ID  
10.       FROM STUDENT_TBL ST  
11.       WHERE ST.CLASS_ID IN   
12.      <foreach collection="array" item="classIds"  open="(" separator="," close=")">  
13.         #{classIds}  
14.      </foreach>  
15. </select>