MyBatis——动态SQL讲解
MyBatis的动态SQL是基于OGNL表达式的，它可以帮助我们方便的在SQL语句中实现某些逻辑。
MyBatis中用于实现动态SQL的元素主要有：
-
if
-
where
-
set
-
choose（when，otherwise）
-
trim
-
foreach
1、if标签
if标签可用在许多类型的sql语句中，我们以查询为例。首先看一个很普通的查询：
<select id="getStudentListLikeName" parameterType="StudentEntity" resultMap="studentResultMap">
SELECT * from STUDENT_TBL ST
WHERE ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName}),'%')
select>
但是此时如果studentName为null，此语句很可能报错或查询结果为空。此时我们使用if动态sql语句先进行判断，如果值为null或等于空字符串，我们就不进行此条件的判断，增加灵活性。
参数为实体类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.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName, jdbcType=VARCHAR}),'%')
AND ST.STUDENT_SEX = #{studentSex, jdbcType=INTEGER}
AND ST.STUDENT_BIRTHDAY = #{studentBirthday, jdbcType=DATE}
AND ST.CLASS_ID = #{classId, jdbcType=VARCHAR}
AND ST.CLASS_ID = #{classEntity.classId, jdbcType=VARCHAR}
AND ST.PLACE_ID = #{placeId, jdbcType=VARCHAR}
AND ST.PLACE_ID = #{placeEntity.placeId, jdbcType=VARCHAR}
AND ST.STUDENT_ID = #{studentId, jdbcType=VARCHAR}
使用时比较灵活， 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
for (StudentEntity e : list) {
System.out.println(e.toString());
}
}
2、if + where 的条件判断
当where中的条件使用的if标签较多时，这样的组合可能会导致错误。我们以在1中的查询语句为例子，当java代码按如下方法调用时：
@Test
public void select_test_2_1() {
StudentEntity entity = new StudentEntity();
entity.setStudentName(null);
entity.setStudentSex(1);
List
for (StudentEntity e : list) {
System.out.println(e.toString());
}
}
如果上面例子，参数studentName为null，将不会进行STUDENT_NAME列的判断，则会直接导"WHERE AND"关键字多余的错误SQL。
这时我们可以使用where动态语句来解决。这个"where"标签会知道如果它包含的标签中有返回值的话，它就插入一个'where'。此外，如果标签返回的内容是以AND 或OR 开头的，则它会剔除掉。
上面例子修改为：
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
ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName, jdbcType=VARCHAR}),'%')
AND ST.STUDENT_SEX = #{studentSex, jdbcType=INTEGER}
AND ST.STUDENT_BIRTHDAY = #{studentBirthday, jdbcType=DATE}
AND ST.CLASS_ID = #{classId, jdbcType=VARCHAR}
AND ST.CLASS_ID = #{classEntity.classId, jdbcType=VARCHAR}
AND ST.PLACE_ID = #{placeId, jdbcType=VARCHAR}
AND ST.PLACE_ID = #{placeEntity.placeId, jdbcType=VARCHAR}
AND ST.STUDENT_ID = #{studentId, jdbcType=VARCHAR}
3、if + set 的更新语句
当update语句中没有使用if标签时，如果有一个参数为null，都会导致错误。
当在update语句中使用if标签时，如果前面的if没有执行，则或导致逗号多余错误。使用set标签可以将动态的配置SET 关键字，和剔除追加到条件末尾的任何不相关的逗号。如果set包含的内容为空的话则会出错。
使用if+set标签修改后，如果某项为null则不进行更新，而是保持数据库原值。如下示例：
<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>
4、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包起来，放置关键字多于错误。
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
ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName, jdbcType=VARCHAR}),'%')
AND ST.STUDENT_SEX = #{studentSex, jdbcType=INTEGER}
AND ST.STUDENT_BIRTHDAY = #{studentBirthday, jdbcType=DATE}
AND ST.CLASS_ID = #{classId, jdbcType=VARCHAR}
AND ST.CLASS_ID = #{classEntity.classId, jdbcType=VARCHAR}
AND ST.PLACE_ID = #{placeId, jdbcType=VARCHAR}
AND ST.PLACE_ID = #{placeEntity.placeId, jdbcType=VARCHAR}
AND ST.STUDENT_ID = #{studentId, jdbcType=VARCHAR}
5、trim标签
trim元素的主要功能是可以在自己包含的内容前加上某些前缀，也可以在其后加上某些后缀，与之对应的属性是prefix和suffix；可以把包含内容的首部某些内容覆盖，即忽略，也可以把尾部的某些内容覆盖，对应的属性是prefixOverrides和suffixOverrides。正因为trim有这样的功能，所以我们也可以非常简单的利用trim来代替where/set标签的功能，示例代码如下：
trim代替where标签：
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
ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName, jdbcType=VARCHAR}),'%')
AND ST.STUDENT_SEX = #{studentSex, jdbcType=INTEGER}
AND ST.STUDENT_BIRTHDAY = #{studentBirthday, jdbcType=DATE}
AND ST.CLASS_ID = #{classId, jdbcType=VARCHAR}
AND ST.CLASS_ID = #{classEntity.classId, jdbcType=VARCHAR}
AND ST.PLACE_ID = #{placeId, jdbcType=VARCHAR}
AND ST.PLACE_ID = #{placeEntity.placeId, jdbcType=VARCHAR}
AND ST.STUDENT_ID = #{studentId, jdbcType=VARCHAR}
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>
6、foreach标签
foreach的主要用在构建in条件中，它可以在SQL语句中进行迭代一个集合。foreach元素的属性主要有item，index，collection，open，separator，close。
-
item表示集合中每一个元素进行迭代时的别名；
-
index指定一个名字，用于表示在迭代过程中，每次迭代到的位置；
-
open表示该语句以什么开始；
-
separator表示在每次进行迭代之间以什么符号作为分隔符；
-
close表示以什么结束；
-
在使用foreach的时候最关键的也是最容易出错的就是collection属性，该属性是必须指定的，但是在不同情况下，该属性的值是不一样的，主要有一下3种情况：
-
如果传入的是单参数且参数类型是一个List的时候，collection属性值为list
-
如果传入的是单参数且参数类型是一个array数组的时候，collection的属性值为array
-
如果传入的参数是多个的时候，我们就需要把它们封装成一个Map了，当然单参数也可以封装成map，实际上如果你在传入参数的时候，在MyBatis里面也是会把它封装成一个Map的，map的key就是参数名，所以这个时候collection属性值就是传入的List或array对象在自己封装的map里面的key
-
下面分别来看看上述三种情况的示例代码：
1）单参数List的类型：
<select id="dynamicForeachTest" resultType="Blog">
select * from t_blog where id in
<foreach collection="list" index="index" item="item" open="(" separator="," close=")">
#{item}
foreach>
select>
上述collection的值为list，对应的Mapper是这样的：
public List<Blog> dynamicForeachTest(List
测试代码：
@Test
public void dynamicForeachTest() {
SqlSession session = Util.getSqlSessionFactory().openSession();
BlogMapper blogMapper = session.getMapper(BlogMapper.class);
List
ids.add(1);
ids.add(3);
ids.add(6);
List
for (Blog blog : blogs)
System.out.println(blog);
session.close();
}
2）单参数array数组的类型：
<select id="dynamicForeach2Test" resultType="Blog">
select * from t_blog where id in
<foreach collection="array" index="index" item="item" open="(" separator="," close=")">
#{item}
foreach>
select>
上述collection为array，对应的Mapper代码：
public List
测试代码：
@Test
public void dynamicForeach2Test() {
SqlSession session = Util.getSqlSessionFactory().openSession();
BlogMapper blogMapper = session.getMapper(BlogMapper.class);
int[] ids = new int[] {1,3,6,9};
List
for (Blog blog : blogs)
System.out.println(blog);
session.close();
}
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
测试代码：
@Test
public void dynamicForeach3Test() {
SqlSession session = Util.getSqlSessionFactory().openSession();
BlogMapper blogMapper = session.getMapper(BlogMapper.class);
final List
ids.add(1);
ids.add(2);
ids.add(3);
ids.add(6);
ids.add(7);
ids.add(9);
Map
params.put("ids", ids);
params.put("title", "中国");
List
for (Blog blog : blogs)
System.out.println(blog);
session.close();
}
转载：http://haohaoxuexi.iteye.com/blog/1338557