MyBatis学习笔记（六）动态sql

在一些情况下，如查询参数不确定时，需要用到动态sql

例子，根据动态输入的查询条件查询student．

一．if语句

１.StudentTMapper

[html] view plain copy

1. package com.skymr.mybatis.mappers;  
2.   
3. import java.util.List;  
4. import java.util.Map;  
5.   
6. import com.skymr.mybatis.model.Student;  
7.   
8. public interface StudentTMapper {  
9.   
10.     public List<Student> searchStudents(Map<String,Object> map);  
11. }  

 

map参数是查询条件

２.StudentTMappler.xml

[html] view plain copy

1. <?xml version="1.0" encoding="UTF-8" ?>  
2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">  
3. <!-- namespace:Mapper映射 -->  
4. <!-- 这个文件感觉就像StudentMapper接口的实现一样，只是从java文件变成了xml文件  
5. 充当了Dao类的功能  
6.  -->  
7. <mapper namespace="com.skymr.mybatis.mappers.StudentTMapper">  
8.   
9.     <resultMap type="Student" id="stuMap">  
10.         <id property="id" column="id"/>  
11.         <result property="name" column="name"/>  
12.         <result property="age" column="age"/>  
13.         <association property="address" column="address_id" select="com.skymr.mybatis.mappers.AddressMapper.getAddress">  
14.         </association>  
15.         <association property="grade" column="grade_id" select="com.skymr.mybatis.mappers.GradeMapper.getGrade"></association>  
16.     </resultMap>  
17.     <select id="searchStudents" resultMap="stuMap" parameterType="map">  
18.         select * from mybatis_student where 1=1  
19.         <if test="name!=null">  
20.             and name like #{name}  
21.         </if>  
22.         <if test="age!=null">  
23.             and age=#{age}  
24.         </if>  
25.     </select>  
26. </mapper>   

 

３.测试

[html] view plain copy

1. package com.skymr.mybatis.service;  
2.   
3. import java.util.HashMap;  
4. import java.util.List;  
5. import java.util.Map;  
6.   
7. import org.apache.ibatis.session.SqlSession;  
8. import org.junit.After;  
9. import org.junit.Before;  
10. import org.junit.Test;  
11. import org.slf4j.Logger;  
12. import org.slf4j.LoggerFactory;  
13.   
14. import com.skymr.mybatis.mappers.StudentTMapper;  
15. import com.skymr.mybatis.model.Student;  
16. import com.skymr.mybatis.util.MybatisUtil;  
17.   
18. public class StudentTest4 {  
19.   
20.     private Logger logger = LoggerFactory.getLogger(StudentTest4.class);  
21.       
22.     private SqlSession session;  
23.       
24.     @Before  
25.     public void beforeTest(){  
26.         session = MybatisUtil.openSession();  
27.     }  
28.     @After  
29.     public void afterTest(){  
30.         session.close();  
31.     }  
32.       
33.     @Test  
34.     public void testSearch(){  
35.         logger.info("测试查询学生");  
36.         StudentTMapper mapper = session.getMapper(StudentTMapper.class);  
37.         Map<String,Object> map = new HashMap<String, Object>();  
38.         map.put("name", "%aaa%");  
39.         map.put("age", 111);  
40.         List<Student> list = mapper.searchStudents(map);  
41.         logger.info(list.toString());  
42.     }  
43.       
44. }  

 

二．choose,when ,otherwise

[html] view plain copy

1. Sometimes we don’t want all of the conditionals to apply, instead we want to choose only one case  
2. among many options. Similar to a switch statement in Java, MyBatis offers a choose element.  
3. Let’s use the example above, but now let’s search only on title if one is provided, then only by author  
4. if one is provided. If neither is provided, let’s only return featured blogs (perhaps a strategically list  
5. selected by administrators, instead of returning a huge meaningless list of random blogs).  

有些时候我们不想所有的条件都使用到，只想在所有条件中选择一个条件．与java的switch语种相似，Mybatis提供了一个元素．让我们做个例子．

[html] view plain copy

1. <select id="findActiveBlogLike"  
2.      resultType="Blog">  
3.   SELECT * FROM BLOG WHERE state = ‘ACTIVE’  
4.   <choose>  
5.     <when test="title != null">  
6.       AND title like #{title}  
7.     </when>  
8.     <when test="author != null and author.name != null">  
9.       AND author_name like #{author.name}  
10.     </when>  
11.     <otherwise>  
12.       AND featured = 1  
13.     </otherwise>  
14.   </choose>  
15. </select>  

上面的例子是引用Mybatis文档．

自己的例子：

[html] view plain copy

1. <select id="searchStudents2" resultMap="stuMap" parameterType="map">  
2.     select * from mybatis_student where 1=1  
3.     <choose>  
4.         <when test="searchBy=='name'">  
5.             and name like #{name}  
6.         </when>  
7.         <when test="searchBy=='gradeId'">  
8.             and grade_id=#{gradeId}  
9.         </when>  
10.         <otherwise>  
11.             and age=#{age}  
12.         </otherwise>  
13.     </choose>  
14. </select>  

 

三．trim, where, set元素

1.当没有条件时，有可能会生成这样的sql

[html] view plain copy

1. SELECT * FROM BLOG  
2. WHERE  

如果不在后边加入 1=1，则应该加上where标签

[html] view plain copy

1. <select id="findActiveBlogLike"  
2.      resultType="Blog">  
3.   SELECT * FROM BLOG  
4.   <where>  
5.       <if test="state != null">  
6.         state = #{state}  
7.       </if>  
8.   </where>  
9. </select>  

改成这样就可以避免以上情况．

２.还有这种情况

[html] view plain copy

1. SELECT * FROM BLOG  
2. WHERE  
3. AND title like ‘someTitle’  

需要去年多余的and /or

[html] view plain copy

1. <select id="searchStudents3" resultMap="stuMap" parameterType="map">  
2.     select * from mybatis_student   
3.     <trim prefix="WHERE" prefixOverrides="AND|OR">  
4.         <if test="name!=null">  
5.             and name like #{name}  
6.         </if>  
7.         <if test="age!=null">  
8.             and age=#{age}  
9.         </if>  
10.     </trim>  
11. </select>  

 

同样，update set语句也会出现多余的","的问题

[html] view plain copy

1. <update id="updateAuthorIfNecessary">  
2.   update Author  
3.     <set>  
4.       <if test="username != null">username=#{username},</if>  
5.       <if test="password != null">password=#{password},</if>  
6.       <if test="email != null">email=#{email},</if>  
7.       <if test="bio != null">bio=#{bio}</if>  
8.     </set>  
9.   where id=#{id}  
10. </update>  

 

也可以使用trim修改

[html] view plain copy

1. <update id="updateAuthorIfNecessary">  
2.   update Author  
3.     <trim prefix="SET" suffixOverrides=",">  
4.       <if test="username != null">username=#{username},</if>  
5.       <if test="password != null">password=#{password},</if>  
6.       <if test="email != null">email=#{email},</if>  
7.       <if test="bio != null">bio=#{bio}</if>  
8.     </trim>  
9.   where id=#{id}  
10. </update>  

四．foreach元素

这是一个非常有用的动态sql元素，用来遍历集合，常应用于IN语句中，例：

[html] view plain copy

1. IN condition. For example:  
2. <select id="selectPostIn" resultType="domain.blog.Post">  
3.   SELECT *  
4.   FROM POST P  
5.   WHERE ID in  
6.   <foreach item="item" index="index" collection="list"  
7.       open="(" separator="," close=")">  
8.         #{item}  
9.   </foreach>  
10. </select>  

 

foreach元素非常强大，它允许你指定一个集合，声明item和index变量，在元素内部使用．生成有"开始/结尾/分隔符"的字符串，这个元素非常智能，它不会不小心添加额外的分隔符．

记住，你可以把一个List实例或者一个数组当作参数传递到MyBatis.当你这样做了，MyBatis会自动放到一个Map里．List实例会以"list"作为Key值，数组实例会以"array"作为Key值．

 

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

item表示集合中每一个元素进行迭代时的别名.

index指 定一个名字，用于表示在迭代过程中，每次迭代到的位置.

open表示该语句以什么开始，separator表示在每次进行迭代之间以什么符号作为分隔 符.

close表示以什么结束.

上面的例子生成的sql相当于

  SELECT *

  FROM POST P

  WHERE ID in (?,?,?)