10种优雅的MyBatis写法，同事用了都说好

用来循环容器的标签forEach,检察例子

foreach元素的属性重要有item，index，collection，open，separator，close。

• item：集合中元素迭代时的别名，
  
• index：集合中元素迭代时的索引
  
• open：常用语where语句中，表现以什么开始，比如以'('开始
  
• separator：表现在每次举行迭代时的分隔符，
  
• close 常用语where语句中，表现以什么结束，
  

在利用foreach的时间最关键的也是最容易出错的就是collection属性，该属性是必须指定的，但是在不同环境下，该属性的值是不一样的，重要有一下3种环境：

• 如果传入的是单参数且参数类型是一个List的时间，collection属性值为list .
  
• 如果传入的是单参数且参数类型是一个array数组的时间，collection的属性值为array .
  
• 如果传入的参数是多个的时间，我们就必要把它们封装成一个Map了，固然单参数也可以封装成map，现实上如果你在传入参数的时间，在MyBatis内里也是会把它封装成一个Map的，map的key就是参数名，所以这个时间collection属性值就是传入的List或array对象在自己封装的map内里的key.
  

针对最后一条，我们来看一下官方说法：
   留意 你可以将一个 List 实例或者数组作为参数对象传给 MyBatis，当你这么做的时间，MyBatis 会主动将它包装在一个 Map 中并以名称为键。List 实例将会以“list”作为键，而数组实例的键将是“array”。
  所以，不管是多参数还是单参数的list,array类型，都可以封装为map举行传递。如果传递的是一个List，则mybatis会封装为一个list为key，list值为object的map，如果是array，则封装成一个array为key，array的值为object的map，如果自己封装呢，则colloection里放的是自己封装的map里的key值

1. //mapper中我们要为这个方法传递的是一个容器,将容器中的元素一个一个的
2. //拼接到xml的方法中就要使用这个forEach这个标签了
3. public List<Entity> queryById(List<String> userids);
5. //对应的xml中如下
6.   <select id="queryById" resultMap="BaseReslutMap" >
7.       select * FROM entity
8.       where id in 
9.       <foreach collection="userids" item="userid" index="index" open="(" separator="," close=")">
10.               #{userid}
11.       </foreach>
12.   </select>

复制代码

concat暗昧查询

1. //比如说我们想要进行条件查询,但是几个条件不是每次都要使用,那么我们就可以
2. //通过判断是否拼接到sql中
3.   <select id="queryById" resultMap="BascResultMap" parameterType="entity">
4.     SELECT *  from entity
5.     <where>
6.         <if test="name!=null">
7.             name like concat('%',concat(#{name},'%'))
8.         </if>
9.     </where>
10.   </select>

复制代码

choose (when, otherwise)标签

choose标签是按顺序判断其内部when标签中的test条件出否建立，如果有一个建立，则 choose 结束。当 choose 中全部 when 的条件都不满则时，则执行 otherwise 中的sql。类似于Java 的 switch 语句，choose 为 switch，when 为 case，otherwise 则为 default。
例如下面例子，同样把全部可以限制的条件都写上，方面利用。choose会从上到下选择一个when标签的test为true的sql执行。安全考虑，我们利用where将choose包起来，放置关键字多于错误。

1. <!--  choose(判断参数) - 按顺序将实体类 User 第一个不为空的属性作为：where条件 -->  
2. <select id="getUserList_choose" resultMap="resultMap_user" parameterType="com.yiibai.pojo.User">  
3.     SELECT *  
4.       FROM User u   
5.     <where>  
6.         <choose>  
7.             <when test="username !=null ">  
8.                 u.username LIKE CONCAT(CONCAT('%', #{username, jdbcType=VARCHAR}),'%')  
9.             </when >  
10.             <when test="sex != null and sex != '' ">  
11.                 AND u.sex = #{sex, jdbcType=INTEGER}  
12.             </when >  
13.             <when test="birthday != null ">  
14.                 AND u.birthday = #{birthday, jdbcType=DATE}  
15.             </when >  
16.             <otherwise>  
17.             </otherwise>  
18.         </choose>  
19.     </where>    
20. </select> 

复制代码

selectKey 标签

在insert语句中，在Oracle常常利用序列、在MySQL中利用函数来主动天生插入表的主键，而且必要方法能返回这个天生主键。利用myBatis的selectKey标签可以实现这个效果。
下面例子，利用mysql数据库自定义函数nextval('student')，用来天生一个key，并把他设置到传入的实体类中的studentId属性上。所以在执行完此方法后，边可以通过这个实体类获取天生的key。

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>  

复制代码

调用接口方法，和获取主动天生key

1. StudentEntity entity = new StudentEntity();  
2. entity.setStudentName("黎明你好");  
3. entity.setStudentSex(1);  
4. entity.setStudentBirthday(DateUtil.parse("1985-05-28"));  
5. entity.setClassId("20000001");  
6. entity.setPlaceId("70000001");  
7. this.dynamicSqlMapper.createStudentAutoKey(entity);  
8. System.out.println("新增学生ID: " + entity.getStudentId());  

复制代码

if标签

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

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为null，此语句很大概报错或查询效果为空。此时我们利用if动态sql语句先举行判断，如果值为null或等于空字符串，我们就不举行此条件的判断，增长机动性。
参数为实体类StudentEntity。将实体类中全部的属性均举行判断，如果不为空则执行判断条件。

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> 

复制代码

利用时比较机动， new一个如许的实体类，我们必要限制谁人条件，只必要附上相应的值就会where这个条件，相反不去赋值就可以不在where中判断。

1. public void select_test_2_1() {  
2.     StudentEntity entity = new StudentEntity();  
3.     entity.setStudentName("");  
4.     entity.setStudentSex(1);  
5.     entity.setStudentBirthday(DateUtil.parse("1985-05-28"));  
6.     entity.setClassId("20000001");  
7.     //entity.setPlaceId("70000001");  
8.     List<StudentEntity> list = this.dynamicSqlMapper.getStudentList_if(entity);  
9.     for (StudentEntity e : list) {  
10.         System.out.println(e.toString());  
11.     }  
12. }

复制代码

if + where 的条件判断

当where中的条件利用的if标签较多时，如许的组合大概会导致错误。我们以在3.1中的查询语句为例子，当java代码按如下方法调用时：

1. @Test  
2. public void select_test_2_1() {  
3.     StudentEntity entity = new StudentEntity();  
4.     entity.setStudentName(null);  
5.     entity.setStudentSex(1);  
6.     List<StudentEntity> list = this.dynamicSqlMapper.getStudentList_if(entity);  
7.     for (StudentEntity e : list) {  
8.         System.out.println(e.toString());  
9.     }  
10. } 

复制代码

如果上面例子，参数studentName为null，将不会举行STUDENT_NAME列的判断，则会直接导“WHERE AND”关键字多余的错误SQL。
这时我们可以利用where动态语句来解决。这个“where”标签会知道如果它包含的标签中有返回值的话，它就插入一个‘where’。别的，如果标签返回的内容是以AND 或OR 开头的，则它会剔撤除。
上面例子修改为：

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>  

复制代码

if + set实现修改语句

当update语句中没有利用if标签时，如果有一个参数为null，都会导致错误。
当在update语句中利用if标签时，如果前面的if没有执行，则或导致逗号多余错误。利用set标签可以将动态的设置SET 关键字，和剔除追加到条件末尾的任何不相关的逗号。利用if+set标签修改后，如果某项为null则不举行更新，而是保持数据库原值。
如下示例：

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> 

复制代码

if + trim代替where/set标签

trim是更机动的去处多余关键字的标签，他可以实践where和set的效果。
trim代替where

1. <!-- 5.1if/trim代替where(判断参数) -将实体类不为空的属性作为where条件-->  
2. <select id="getStudentList_if_trim" 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.     <trim prefix="WHERE" prefixOverrides="AND|OR">  
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.     </trim>     
37. </select> 

复制代码

trim代替set

1. <!-- 5.2 if/trim代替set(判断参数) - 将实体类不为空的属性更新 -->  
2. <update id="updateStudent_if_trim" parameterType="liming.student.manager.data.model.StudentEntity">  
3.     UPDATE STUDENT_TBL  
4.     <trim prefix="SET" suffixOverrides=",">  
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.     </trim>  
24.     WHERE STUDENT_TBL.STUDENT_ID = #{studentId}  
25. </update>

复制代码

foreach

对于动态SQL 非常必须的，主是要迭代一个集合，通常是用于IN 条件。List 实例将利用“list”做为键，数组实例以“array” 做为键。
foreach元素是非常强盛的，它答应你指定一个集合，声明集合项和索引变量，它们可以用在元素体内。它也答应你指定开放和关闭的字符串，在迭代之间放置分隔符。这个元素是很智能的，它不会偶然地附加多余的分隔符。
   留意：你可以传递一个List实例或者数组作为参数对象传给MyBatis。当你这么做的时间，MyBatis会主动将它包装在一个Map中，用名称在作为键。List实例将会以“list”作为键，而数组实例将会以“array”作为键。
  这个部门是对关于XML设置文件和XML映射文件的而讨论的。下一部门将详细讨论Java API，所以你可以得到你已经创建的最有效的映射。
1.参数为array示例的写法
接口的方法声明：

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

复制代码

动态SQL语句：

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> 

复制代码

测试代码，查询学生中，在20000001、20000002这两个班级的学生：

1. @Test  
2. public void test7_foreach() {  
3.     String[] classIds = { "20000001", "20000002" };  
4.     List<StudentEntity> list = this.dynamicSqlMapper.getStudentListByClassIds_foreach_array(classIds);  
5.     for (StudentEntity e : list) {  
6.         System.out.println(e.toString());  
7.     }  
8. }

复制代码

2.参数为list示例的写法
接口的方法声明：

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

复制代码

动态SQL语句：

1. <!-- 7.2 foreach(循环List<String>参数) - 作为where中in的条件 -->  
2. <select id="getStudentListByClassIds_foreach_list" 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="list" item="classIdList"  open="(" separator="," close=")">  
13.         #{classIdList}  
14.      </foreach>  
15. </select>

复制代码

测试代码，查询学生中，在20000001、20000002这两个班级的学生：

1. @Test  
2. public void test7_2_foreach() {  
3.     ArrayList<String> classIdList = new ArrayList<String>();  
4.     classIdList.add("20000001");  
5.     classIdList.add("20000002");  
6.     List<StudentEntity> list = this.dynamicSqlMapper.getStudentListByClassIds_foreach_list(classIdList);  
7.     for (StudentEntity e : list) {  
8.         System.out.println(e.toString());  
9.     }  
10. } 

复制代码

sql片断标签<sql>：通过该标签可定义能复用的sql语句片断，在执行sql语句标签中直接引用即可。如许既可以提高编码服从，还能有效简化代码，提高可读性
必要设置的属性：id="" >>>表现必要改sql语句片断的唯一标识
引用：通过<include refid="" />标签引用，refid="" 中的值指向必要引用的<sql>中的id=“”属性

1. <!--定义sql片段-->  
2. <sql id="orderAndItem">  
3.     o.order_id,o.cid,o.address,o.create_date,o.orderitem_id,i.orderitem_id,i.product_id,i.count  
4.   </sql>  
6.  <select id="findOrderAndItemsByOid" parameterType="java.lang.String" resultMap="BaseResultMap">  
7.     select  
8. <!--引用sql片段-->  
9.     <include refid="orderAndItem" />  
10.     from ordertable o  
11.     join orderitem i on o.orderitem_id = i.orderitem_id  
12.     where o.order_id = #{orderId}  
13.   </select>  

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。