Mybatis动态Sql及标签的详解

1.定义sql语句
1.1 select 标签
属性介绍:
id :唯一的标识符.
parameterType:传给此语句的参数的全路径名或别名 例:com.test.poso.User或user
resultType :语句返回值类型或别名。注意，如果是集合，那么这里填写的是集合的泛型，而不是集合本身（resultType 与resultMap 不能并用

 

<select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="Object">
        select * from student where id=#{id}
</select>

 

1.2 insert标签

属性介绍:
id :唯一的标识符
parameterType:传给此语句的参数的全路径名或别名 例:com.test.poso.User

<insert id="insert" parameterType="Object">
    insert into student
    <trim prefix="("suffix=")"suffixOverrides=",">    
     <if test="name != null">
     NAME
     </if>    
    </trim>
    <trim prefix="values("suffix=")" suffixOverrides="," >
     <if test="name != null">
      #{name} 
      </if>    
    </trim>
</insert>

 

1.3 delete标签

属性同 insert

<delete id="deleteByPrimaryKey" parameterType="Object">
        delete from student where id=#{id}
</delete>

 

1.4 update标签

属性同 insert

<update id="updateStudent" parameterType="Object">     
    UPDATE STUDENT   
       SET NAME = #{name}
     WHERE ID = #{id};      
</update>   

 

2. 配置JAVA对象属性与查询结果集中列名对应关系

resultMap 标签的使用
基本作用：

建立SQL查询结果字段与实体属性的映射关系信息
查询的结果集转换为java对象，方便进一步操作。
将结果集中的列与java对象中的属性对应起来并将值填充进去

 

！注意：与java对象对应的列不是数据库中表的列名，而是查询后结果集的列名

 

<resultMap id="BaseResultMap" type="com.online.charge.platform.student.model.Student">
        <id property="id" column="id" />
        <result column="NAME" property="name" />
        <result column="HOBBY" property="hobby" />
        <result column="MAJOR" property="major" />
        <result column="BIRTHDAY" property="birthday" />
        <result column="AGE" property="age" />
</resultMap>
  <!--查询时resultMap引用该resultMap -->  
<select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="Object">
        select id,name,hobby,major,birthday,age from student where id=#{id}
</select> 

 

标签说明：

主标签：
id:该resultMap的标志
type：返回值的类名，此例中返回Studnet类

子标签：
id:用于设置主键字段与领域模型属性的映射关系，此处主键为ID，对应id。
result：用于设置普通字段与领域模型属性的映射关系

 

3. 动态sql拼接

3.1 if 标签

if标签通常用于WHERE语句、UPDATE语句、INSERT语句中，通过判断参数值来决定是否使用某个查询条件、判断是否更新某一个字段、判断是否插入某个字段的值。

<if test="name != null and name != ''">
         and NAME = #{name}
</if>

 

3.2 foreach 标签
foreach标签主要用于构建in条件，可在sql中对集合进行迭代。也常用到批量删除、添加等操作中。

   <!-- in查询所有，不分页 -->
    <select id="selectIn" resultMap="BaseResultMap">
        select name,hobby 
     　　       from student where id in
        <foreach item="item" index="index" collection="list" open="(" separator="," close=")">
            #{item}
        </foreach>
    </select>

 

属性介绍：

collection：collection属性的值有三个分别是list、array、map三种，分别对应的参数类型为：List、数组、map集合。
item ：表示在迭代过程中每一个元素的别名
index ：表示在迭代过程中每次迭代到的位置（下标）
open ：前缀
close ：后缀
separator ：分隔符，表示迭代时每个元素之间以什么分隔

3.3 choose标签

有时候我们并不想应用所有的条件，而只是想从多个选项中选择一个。MyBatis提供了choose 元素，按顺序判断when中的条件出否成立，如果有一个成立，则choose结束。当choose中所有when的条件都不满则时，则执行 otherwise中的sql。类似于Java 的switch 语句，choose为switch，when为case，otherwise则为default。

if是与(and)的关系，而choose是或（or）的关系。

<select id="getStudentListChoose" parameterType="Student" resultMap="BaseResultMap">     
    SELECT * from STUDENT WHERE 1=1    
    <where>     
        <choose>     
            <when test="Name!=null and student!='' ">     
                   AND name LIKE CONCAT(CONCAT('%', #{student}),'%')      
            </when>     
            <when test="hobby!= null and hobby!= '' ">     
                    AND hobby = #{hobby}      
            </when>                   
            <otherwise>     
                    AND AGE = 15  
            </otherwise>     
        </choose>     
    </where>     
</select>   

 

4. 格式化输出
4.1 where标签
当if标签较多时，这样的组合可能会导致错误。 如下：

<select id="getStudentListWhere" parameterType="Object" resultMap="BaseResultMap">     
    SELECT * from STUDENT      
        WHERE      
        <if test="name!=null and name!= ''">     
            NAME LIKE CONCAT(CONCAT('%', #{name}),'%')      
        </if>     
        <if test="hobby!= null and hobby!= ''">     
            AND hobby = #{hobby}      
        </if>     
</select> 

 

当name值为null时，查询语句会出现 “WHERE AND” 的情况，解决该情况除了将"WHERE"改为“WHERE 1=1”之外，还可以利用where标签。这个“where”标签会知道如果它包含的标签中有返回值的话，它就插入一个‘where’。此外，如果标签返回的内容是以AND 或OR 开头的，则它会剔除掉。

 

<select id="getStudentListWhere" parameterType="Object" resultMap="BaseResultMap">     
    SELECT * from STUDENT      
       <where>   
         <if test="name!=null and name!='' ">     
            NAME LIKE CONCAT(CONCAT('%', #{name}),'%')      
         </if>     
         <if test="hobby!= null and hobby!= '' ">     
            AND hobby = #{hobby}      
         </if>  
       </where>        
</select>  

 

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

<update id="updateStudent" parameterType="Object">     
    UPDATE STUDENT   
       SET NAME = #{name},   
           MAJOR = #{major},
           HOBBY = #{hobby}
     WHERE ID = #{id};      
</update>   

<update id="updateStudent" parameterType="Object">     
    UPDATE STUDENT SET    
        <if test="name!=null and name!='' ">     
            NAME = #{name},      
        </if>     
        <if test="hobby!=null and hobby!='' ">     
            MAJOR = #{major},      
        </if> 
        <if test="hobby!=null and hobby!='' ">     
            HOBBY = #{hobby}    
        </if>          
    WHERE ID = #{id};      
</update>  

 

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

<update id="updateStudent" parameterType="Object">     
    UPDATE STUDENT      
    <set>     
        <if test="name!=null and name!='' ">     
            NAME = #{name},      
        </if>     
        <if test="hobby!=null and hobby!='' ">     
            MAJOR = #{major},      
        </if> 
        <if test="hobby!=null and hobby!='' ">     
            HOBBY = #{hobby}    
        </if>     
    </set>     
    WHERE ID = #{id};      
</update>  

 

4.3 trim标签
trim标记是一个格式化的标记，主要用于拼接sql的条件语句（前缀或后缀的添加或忽略），可以完成set或者是where标记的功能。

trim属性主要有以下四个

prefix：前缀覆盖并增加其内容
suffix：后缀覆盖并增加其内容
prefixOverrides：前缀判断的条件
suffixOverrides：后缀判断的条件
例如在update中

<update id="updateByPrimaryKey" parameterType="Object">
        update student set 
  <trim  suffixOverrides="," > 
    <if test="name != null  ">
        NAME=#{name},
    </if>
    <if test="hobby != null  ">
        HOBBY=#{hobby},
    </if>
  </trim> where id=#{id}
</update>

 

如果name和hobby的值都不为空的话，会执行如下语句

update student set name='xx',hobby='xx' /*,*/ where id='xx'

 

会忽略最后一个“，” ;

在select中

<select id="selectByNameOrHobby" resultMap="BaseResultMap">
select * from student 
<trim prefix="WHERE" prefixOverrides="AND | OR">
    <if test="name != null and name.length()>0"> AND name=#{name}
    </if>
    <if test="hobby != null and hobby.length()>0"> AND hobby=#{hobby}
    </if>
</trim>
</select>

 

如果name和hobby的值都不为空的话，会执行如下语句

select * from user where/*and*/ name = ‘xx’ and hobby= ‘xx’

 

会为片段添加 “where” 前缀，并忽略第一个 “and” ；

当然，避免出现“where and”还有其他方法，如下

<!--将where提取出来，并加上“1=1”的查询条件 -->
select * from student 
where 1=1
<trim suffixOverrides=",">
   <if test="name != null and name != ''">
      and NAME = #{name}
   </if>
   <if test="hobby != null and hobby != ''">
      and HOBBY = #{hobby}
   </if> 
</trim>

 

用在insert中

   <insert id="insert" parameterType="Object">
        insert into student <trim prefix="(" suffix=")" suffixOverrides="," >
    <if test="name != null  ">
        NAME,
    </if>
    <if test="hobby != null  ">
        HOBBY,
    </if>    
    </trim>    <trim     prefix="values("    suffix=")"    suffixOverrides="," >  
    <if test="name != null  ">
        #{name},
    </if>
    <if test="hobby != null  ">
        #{hobby},
    </if>
    </trim>
    </insert>

 

可以为生成格式正确的insert语句。

 

5. 配置关联关系
5.1 collection标签

• 对多关联映射：collection

5.2 association标签

• 对一关联映射：association
• 关于关联映射关系，详细参考这篇博客

6. 定义常量及引用
6.1 sql标签
当多种类型的查询语句的查询字段或者查询条件相同时，可以将其定义为常量，方便调用。为求结构清晰也可将sql语句分解。

 <!-- 查询字段 -->
<sql id="Base_Column_List">
   ID,MAJOR,BIRTHDAY,AGE,NAME,HOBBY
</sql>
1
2
3
4
<!-- 查询条件 -->
    <sql id="Example_Where_Clause">
        where 1=1
        <trim suffixOverrides=","> 
            <if test="id != null and id !=''">
                and id = #{id}
            </if>
            <if test="major != null and major != ''">
                and MAJOR = #{major}
            </if>
            <if test="birthday != null ">
                and BIRTHDAY = #{birthday}
            </if>
            <if test="age != null ">
                and AGE = #{age}
            </if>
            <if test="name != null and name != ''">
                and NAME = #{name}
            </if>
            <if test="hobby != null and hobby != ''">
                and HOBBY = #{hobby}
            </if>            
            <if test="sorting != null">
                order by #{sorting}
            </if>
            <if test="sort!= null  and sort != '' ">
                order by ${sort}   ${order}
            </if>
        </trim>
    </sql>

 

6.2 include标签
用于引用定义的常量

<!-- 查询所有，不分页 -->
    <select id="selectAll" resultMap="BaseResultMap">
        SELECT
        <include refid="Base_Column_List" />
        FROM
        student
        <include refid="Example_Where_Clause" />
    </select>  

<!-- 分页查询 -->
    <select id="select" resultMap="BaseResultMap">
        select * from (
            select tt.*,rownum as rowno from 
                (
                    SELECT
                    <include refid="Base_Column_List" /> 
                    FROM
                    student
                    <include refid="Example_Where_Clause" />
                     ) tt 
                     <where>
                            <if test="pageNum != null and rows != null">
                            and  rownum  <![CDATA[<=]]>#{page}*#{rows}
                         </if>
                    </where>
             ) table_alias
            where table_alias.rowno>#{pageNum} 
    </select>

<!-- 根据条件删除 -->
<delete id="deleteByEntity" parameterType="java.util.Map">
    DELETE  FROM   student
    <include refid="Example_Where_Clause" />
</delete>