详解Java的MyBatis框架中动态SQL的基本用法

有些时候，sql语句where条件中，需要一些安全判断，例如按某一条件查询时如果传入的参数是空，此时查询出的结果很可能是空的，也许我们需要参数为空时，是查出全部的信息。使用oracle的序列、mysql的函数生成id。这时我们可以使用动态sql。下文均采用mysql语法和函数（例如字符串链接函数concat）。

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

<!-- 插入学生 自动主键--> 
<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

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标签
 
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> 
 <if test="studentbirthday != null "> 
  and st.student_birthday = #{studentbirthday, jdbctype=date} 
 </if> 
 <if test="classid != null and classid!= '' "> 
  and st.class_id = #{classid, jdbctype=varchar} 
 </if> 
 <if test="classentity != null and classentity.classid !=null and classentity.classid !=' ' "> 
  and st.class_id = #{classentity.classid, jdbctype=varchar} 
 </if> 
 <if test="placeid != null and placeid != '' "> 
  and st.place_id = #{placeid, jdbctype=varchar} 
 </if> 
 <if test="placeentity != null and placeentity.placeid != null and placeentity.placeid != '' "> 
  and st.place_id = #{placeentity.placeid, jdbctype=varchar} 
 </if> 
 <if test="studentid != null and studentid != '' "> 
  and st.student_id = #{studentid, jdbctype=varchar} 
 </if> 
</select> 

使用时比较灵活， 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()); 
 } 
} 
 

 
if + where 的条件判断
       当where中的条件使用的if标签较多时，这样的组合可能会导致错误。我们以在3.1中的查询语句为例子，当java代码按如下方法调用时：

@test 
public void select_test_2_1() { 
 studententity entity = new studententity(); 
 entity.setstudentname(null); 
 entity.setstudentsex(1); 
 list<studententity> list = this.dynamicsqlmapper.getstudentlist_if(entity); 
 for (studententity e : list) { 
  system.out.println(e.tostring()); 
 } 
} 

如果上面例子，参数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"> 
 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> 
  <if test="studentbirthday != null "> 
   and st.student_birthday = #{studentbirthday, jdbctype=date} 
  </if> 
  <if test="classid != null and classid!= '' "> 
   and st.class_id = #{classid, jdbctype=varchar} 
  </if> 
  <if test="classentity != null and classentity.classid !=null and classentity.classid !=' ' "> 
   and st.class_id = #{classentity.classid, jdbctype=varchar} 
  </if> 
  <if test="placeid != null and placeid != '' "> 
   and st.place_id = #{placeid, jdbctype=varchar} 
  </if> 
  <if test="placeentity != null and placeentity.placeid != null and placeentity.placeid != '' "> 
   and st.place_id = #{placeentity.placeid, jdbctype=varchar} 
  </if> 
  <if test="studentid != null and studentid != '' "> 
   and st.student_id = #{studentid, jdbctype=varchar} 
  </if> 
 </where> 
</select> 

if + set 的更新语句
当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}, 
  </if> 
  <if test="studentsex != null and studentsex != '' "> 
   student_tbl.student_sex = #{studentsex}, 
  </if> 
  <if test="studentbirthday != null "> 
   student_tbl.student_birthday = #{studentbirthday}, 
  </if> 
  <if test="studentphoto != null "> 
   student_tbl.student_photo = #{studentphoto, javatype=byte[], jdbctype=blob, typehandler=org.apache.ibatis.type.blobtypehandler}, 
  </if> 
  <if test="classid != '' "> 
   student_tbl.class_id = #{classid} 
  </if> 
  <if test="placeid != '' "> 
   student_tbl.place_id = #{placeid} 
  </if> 
 </set> 
 where student_tbl.student_id = #{studentid};  
</update> 

if + trim代替where/set标签
       trim是更灵活的去处多余关键字的标签，他可以实践where和set的效果。
 
trim代替where

<!-- 5.1 if/trim代替where(判断参数) - 将实体类不为空的属性作为where条件 --> 
<select id="getstudentlist_if_trim" resultmap="resultmap_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 
 <trim prefix="where" prefixoverrides="and|or"> 
  <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> 
  <if test="studentbirthday != null "> 
   and st.student_birthday = #{studentbirthday, jdbctype=date} 
  </if> 
  <if test="classid != null and classid!= '' "> 
   and st.class_id = #{classid, jdbctype=varchar} 
  </if> 
  <if test="classentity != null and classentity.classid !=null and classentity.classid !=' ' "> 
   and st.class_id = #{classentity.classid, jdbctype=varchar} 
  </if> 
  <if test="placeid != null and placeid != '' "> 
   and st.place_id = #{placeid, jdbctype=varchar} 
  </if> 
  <if test="placeentity != null and placeentity.placeid != null and placeentity.placeid != '' "> 
   and st.place_id = #{placeentity.placeid, jdbctype=varchar} 
  </if> 
  <if test="studentid != null and studentid != '' "> 
   and st.student_id = #{studentid, jdbctype=varchar} 
  </if> 
 </trim>  
</select> 

 
trim代替set

<!-- 5.2 if/trim代替set(判断参数) - 将实体类不为空的属性更新 --> 
<update id="updatestudent_if_trim" parametertype="liming.student.manager.data.model.studententity"> 
 update student_tbl 
 <trim prefix="set" suffixoverrides=","> 
  <if test="studentname != null and studentname != '' "> 
   student_tbl.student_name = #{studentname}, 
  </if> 
  <if test="studentsex != null and studentsex != '' "> 
   student_tbl.student_sex = #{studentsex}, 
  </if> 
  <if test="studentbirthday != null "> 
   student_tbl.student_birthday = #{studentbirthday}, 
  </if> 
  <if test="studentphoto != null "> 
   student_tbl.student_photo = #{studentphoto, javatype=byte[], jdbctype=blob, typehandler=org.apache.ibatis.type.blobtypehandler}, 
  </if> 
  <if test="classid != '' "> 
   student_tbl.class_id = #{classid}, 
  </if> 
  <if test="placeid != '' "> 
   student_tbl.place_id = #{placeid} 
  </if> 
 </trim> 
 where student_tbl.student_id = #{studentid} 
</update> 

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包起来，放置关键字多于错误。

<!-- 6 choose(判断参数) - 按顺序将实体类第一个不为空的属性作为where条件 --> 
<select id="getstudentlist_choose" 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> 
  <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 > 
   <when test="studentbirthday != null "> 
    and st.student_birthday = #{studentbirthday, jdbctype=date} 
   </when > 
   <when test="classid != null and classid!= '' "> 
    and st.class_id = #{classid, jdbctype=varchar} 
   </when > 
   <when test="classentity != null and classentity.classid !=null and classentity.classid !=' ' "> 
    and st.class_id = #{classentity.classid, jdbctype=varchar} 
   </when > 
   <when test="placeid != null and placeid != '' "> 
    and st.place_id = #{placeid, jdbctype=varchar} 
   </when > 
   <when test="placeentity != null and placeentity.placeid != null and placeentity.placeid != '' "> 
    and st.place_id = #{placeentity.placeid, jdbctype=varchar} 
   </when > 
   <when test="studentid != null and studentid != '' "> 
    and st.student_id = #{studentid, jdbctype=varchar} 
   </when > 
   <otherwise> 
   </otherwise> 
  </choose> 
 </where> 
</select> 

 
foreach
对于动态sql 非常必须的，主是要迭代一个集合，通常是用于in 条件。list 实例将使用“list”做为键，数组实例以“array” 做为键。
foreach元素是非常强大的，它允许你指定一个集合，声明集合项和索引变量，它们可以用在元素体内。它也允许你指定开放和关闭的字符串，在迭代之间放置分隔符。这个元素是很智能的，它不会偶然地附加多余的分隔符。
注意：你可以传递一个list实例或者数组作为参数对象传给mybatis。当你这么做的时候，mybatis会自动将它包装在一个map中，用名称在作为键。list实例将会以“list”作为键，而数组实例将会以“array”作为键。
这个部分是对关于xml配置文件和xml映射文件的而讨论的。下一部分将详细讨论java api，所以你可以得到你已经创建的最有效的映射。

1.参数为array示例的写法
 
接口的方法声明：

public list<studententity> getstudentlistbyclassids_foreach_array(string[] classids); 

 
动态sql语句：

<!— 7.1 foreach(循环array参数) - 作为where中in的条件 --> 
<select id="getstudentlistbyclassids_foreach_array" resultmap="resultmap_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 st.class_id in 
  <foreach collection="array" item="classids" open="(" separator="," close=")"> 
  #{classids} 
  </foreach> 
</select> 

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

@test 
public void test7_foreach() { 
  string[] classids = { "20000001", "20000002" }; 
  list<studententity> list = this.dynamicsqlmapper.getstudentlistbyclassids_foreach_array(classids); 
  for (studententity e : list) { 
    system.out.println(e.tostring()); 
  } 
} 

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

public list<studententity> getstudentlistbyclassids_foreach_list(list<string> classidlist); 

 
动态sql语句：

<!-- 7.2 foreach(循环list<string>参数) - 作为where中in的条件 --> 
<select id="getstudentlistbyclassids_foreach_list" resultmap="resultmap_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 st.class_id in 
  <foreach collection="list" item="classidlist" open="(" separator="," close=")"> 
  #{classidlist} 
  </foreach> 
</select> 

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

@test 
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); 
 for (studententity e : list) { 
  system.out.println(e.tostring()); 
 } 
} 

3.自己把参数封装成map的类型

<select id="dynamicforeach3test" resulttype="blog"> 
 select * from t_blog where title like "%"#{title}"%" and id in 
 <foreach collection="ids" index="index" item="item" open="(" separator="," close=")"> 
  #{item} 
 </foreach> 
</select> 

上述collection的值为ids，是传入的参数map的key，对应的mapper代码：

public list<blog> dynamicforeach3test(map<string, object> params); 

  对应测试代码：

@test 
public void dynamicforeach3test() { 
 sqlsession session = util.getsqlsessionfactory().opensession(); 
 blogmapper blogmapper = session.getmapper(blogmapper.class); 
 final list<integer> ids = new arraylist<integer>(); 
 ids.add(1); 
 ids.add(2); 
 ids.add(3); 
 ids.add(6); 
 ids.add(7); 
 ids.add(9); 
 map<string, object> params = new hashmap<string, object>(); 
 params.put("ids", ids); 
 params.put("title", "中国"); 
 list<blog> blogs = blogmapper.dynamicforeach3test(params); 
 for (blog blog : blogs) 
  system.out.println(blog); 
 session.close(); 
}