【程序猿们看这儿！】MyBatis-动态SQL

MyBatis之动态SQL

1.动态SQL简介

  MyBatis 的强大特性之一便是它的动态 SQL。如果你有使用 JDBC 或其他类似框架的经验，你就能体会到根据不同条件拼接 SQL 语句有多么痛苦。拼接的时候要确保不能忘了必要的空格，还要注意省掉列名列表最后的逗号。利用动态 SQL 这一特性可以彻底摆脱这种痛苦。例如：之前要进行条件查询，（有些条件可以有也可以没有的时候涉及sql的判断以及sql的拼接）

StringBuffer sb=new StringBuffer("SELECT * from  bills INNER JOIN  providers ON providers.providerId=bills.pid where 1=1");
if(search_title!=null&&!search_title.equals("")){
sb.append(" and title like '%"+search_title+"%'");
}
if(search_pid!=-1){ //一定选了查询条件的！
sb.append(" and pid="+search_pid);
}
if(search_pay!=-1){ //一定选了查询条件的！
sb.append(" and pay="+search_pay);
}
String sql = sb.toString();
System.out.println("SQL语句是:"+sql);

 通常使用动态 SQL 不可能是独立的一部分,MyBatis 当然使用一种强大的动态 SQL 语言来改进这种情形,这种语言可以被用在任意的 SQL 映射语句中。
 动态 SQL 元素和使用 JSTL 或其他类似基于 XML 的文本处理器相似。在 MyBatis 之前的版本中,有很多的元素需要来了解。MyBatis 3 大大提升了它们,现在用不到原先一半的元素就可以了。MyBatis 采用功能强大的基于 OGNL（Struts2语法） 的表达式来消除其他元素。
 mybatis 的动态sql语句是基于OGNL表达式的。可以方便的在 sql 语句中实现某些逻辑. 总体说来mybatis 动态SQL 语句主要有以下几类:

• if 语句 (简单的条件判断)
• choose (when,otherwise) ,相当于java 语言中的 switch ,与 jstl 中的choose 很类似.
• trim (对包含的内容加上 prefix,或者 suffix 等，前缀，后缀)
• where (主要是用来简化sql语句中where条件判断的，能智能的处理 and or ,不必担心多余导致语法错误)
• set (主要用于更新时)
• foreach (在实现 mybatis in 语句查询时特别有用)

2.分支判断

2.1 if元素

根据 username 和 sex 来查询数据。如果username为空，那么将只根据sex来查询；反之只根据username来查询
首先不使用 动态SQL 来书写

<select id="selectUserByUsernameAndSex" resultType="user" parameterType="User">
		select * from user where username=#{username} and sex=#{sex}
</select>

上面的查询语句，我们可以发现，如果 #{username} 为空，那么查询结果也是空，如何解决这个问题呢？使用 if 来判断

	<select id="selectUserByUsernameAndSex" resultType="user"
		parameterType="User">
		select * from user where
		<if test="username != null">
			username=#{username}
		</if>
		<if test="sex!= null">
			and sex=#{sex}
		</if>
	</select>

这样写我们可以看到，如果 sex 等于 null，那么查询语句为 select * from user where username=#{username},但是如果usename 为空呢？那么查询语句为 select * from user where and sex=#{sex}，这是错误的 SQL 语句，如何解决呢？请看下面的 where 语句

2.2 动态SQL:if+where 语句

<select id="selectUserByUsernameAndSex" resultType="User"
		parameterType="User">
		select * from user
		<where>
			<if test="username != null">
				username=#{username}
			</if>
			<if test="sex != null">
				and sex=#{sex}
			</if>
		</where>
	</select>

这个“where”标签会知道如果它包含的标签中有返回值的话，它就插入一个‘where’。此外，如果标签返回的内容是以AND 或OR 开头的，则它会剔除掉。

2.2 动态SQL:if+where 语句

<select id="selectUserByUsernameAndSex" resultType="User"
		parameterType="User">
		select * from user
		<where>
			<if test="username != null">
				username=#{username}
			</if>
			<if test="sex != null">
				and sex=#{sex}
			</if>
		</where>
	</select>

这个“where”标签会知道如果它包含的标签中有返回值的话，它就插入一个‘where’。此外，如果标签返回的内容是以AND 或OR 开头的，则它会剔除掉。

2.3 动态SQL:if+set 语句

同理，上面的对于查询 SQL 语句包含 where 关键字，如果在进行更新操作的时候，含有 set 关键词，我们怎么处理呢？

<!-- 根据 id 更新 user 表的数据 -->
	<update id="updateUserById" parameterType="User">
		update user u
		<set>
			<if test="username != null and username != ''">
				u.username = #{username},
			</if>
			<if test="sex != null and sex != ''">
				u.sex = #{sex},
			</if>
		</set>
		where id=#{id}
	</update>

这样写，如果第一个条件 username 为空，那么 sql 语句为：update user u set u.sex=? where id=?
如果第一个条件不为空，那么 sql 语句为：update user u set u.username = ? ,u.sex = ? where id=?
如果出现多余逗号 会自动去掉！！

2.4 动态SQL:choose(when,otherwise) 语句 了解

有时候，我们不想用到所有的查询条件，只想选择其中的一个，查询条件有一个满足即可，使用 choose 标签可以解决此类问题，类似于 Java 的 switch 语句

	<select id="selectUserByChoose" resultType="User" parameterType="User">
		select * from user
		<where>
			<choose>
				<when test="id !='' and id != null">
					id=#{id}
				</when>
				<when test="username !='' and username != null">
					and username=#{username}
				</when>
				<otherwise>
					and sex=#{sex}
				</otherwise>
			</choose>
		</where>
	</select>

也就是说，这里我们有三个条件，id,username,sex，只能选择一个作为查询条件
如果 id 不为空，那么查询语句为：select * from user where id=?
如果 id 为空，那么看username 是否为空，如果不为空，那么语句为 select * from user where username=?;
如果 username 为空，那么查询语句为 select * from user where sex=?

2.5 动态SQL:trim 语句 了解

trim标记是一个格式化的标记，可以完成set或者是where标记的功能
①、用 trim 改写上面第二点的 if+where 语句

	<select id="selectUserByUsernameAndSex" resultType="user" parameterType="User">
		select * from user
		<trim prefix="where" prefixOverrides="and | or">
			<if test="username != null">
				and username=#{username}
			</if>
			<if test="sex != null">
				and sex=#{sex}
			</if>
		</trim>
	</select>

prefix：前缀　　　　　　
prefixoverride：去掉第一个and或者是or
②、用 trim 改写上面第三点的 if+set 语句

	<!-- 根据 id 更新 user 表的数据 -->
	<update id="updateUserById" parameterType="User">
		update user u
		<trim prefix="set" suffixOverrides=",">
			<if test="username != null and username != ''">
				u.username = #{username},
			</if>
			<if test="sex != null and sex != ''">
				u.sex = #{sex},
			</if>
		</trim>
		where id=#{id}
	</update>

suffix：后缀　　
suffixoverride：去掉最后一个逗号（也可以是其他的标记，就像是上面前缀中的and一样）

2.6 动态SQL: SQL 片段

有时候可能某个 sql 语句我们用的特别多，为了增加代码的重用性，简化代码，我们需要将这些代码抽取出来，然后使用时直接调用。
比如：假如我们需要经常根据用户名和性别来进行联合查询，那么我们就把这个代码抽取出来，如下：

<!--公有的代码抽象出去 -->
    <sql id="querySQL">
        <if test="username!=null and username!=''">
            and username like #{username}
        </if>
        <if test="sex!=null and sex!=''">
            and sex=#{sex}
        </if>
    </sql>

引用 sql 片段

<select id="selectUserByUsernameAndSex" resultType="user" parameterType="User">
		select * from user where 1=1
		<!--引入SQL片段-->
		<include refid="querySQL"/>
    </select>


    <select id="selectUserByUsernameAndSex1" resultType="user" parameterType="User">
        select * from user
        <!--自动的去掉多余的 And 或者 OR -->
        <where>
            <!--引入SQL片段-->
            <include refid="querySQL"/>
        </where>
    </select>

    <select id="selectUserByUsernameAndSex2" resultType="user" parameterType="User">
        select  * from  user
        <!--去掉前面多余AND或者OR-->
        <trim prefix="WHERE" prefixOverrides="AND|OR">
            <!--引入SQL片段-->
            <include refid="querySQL"/>
        </trim>
    </select>

注意：
①、最好基于 单表来定义 sql 片段，提高片段的可重用性
②、在 sql 片段中不要包括 where

2.7 动态SQL: foreach 语句 有可能用！

https://www.cnblogs.com/hooly/p/9090167.html

需求：我们需要查询 user 表中 id 分别为1,2,3的用户
sql语句：select * from user where id=1 or id=2 or id=3
　　　　 select * from user where id in (1,2,3)

• 单参数List的类型

<select id="dynamicForeachTest" resultType="User">
		select * from user where id in
		<foreach collection="list" index="index" item="item" open="("
			separator="," close=")">
			#{item}
		</foreach>
	</select>

• 测试

 public List<User> dynamicForeachTest(List<Integer> ids);

	@Test
	public void testSelectUserByListId1(){
	    List<Integer> ids = new ArrayList<Integer>();
	    ids.add(1);
	    ids.add(2);
	    ids.add(3);
	    List<User> listUser = mapper.dynamicForeachTest(ids);
	    for(User u : listUser){
	        System.out.println(u);
	    }
	}

• 单参数array数组的类型

	<select id="dynamicForeach2Test" resultType="User">
		select * from user where id in
		<foreach collection="array" index="index" item="item" open="("
			separator="," close=")">
			#{item}
		</foreach>
	</select>

public List<User> dynamicForeach2Test(Integer[] ids);

	@Test
	public void dynamicForeach2Test(){
	    Integer[] ids={1,2,3};
		List<User> listUser = mapper.dynamicForeach2Test(ids);
	    for(User u : listUser){
	        System.out.println(u);
	    }
	}

• 将参数封装成Map的类型

<select id="dynamicForeach3Test" resultType="User">
		select * from user where username like "%"#{username}"%" and id in
		<foreach collection="ids" index="index" item="item" open="("
			separator="," close=")">
			#{item}
		</foreach>
	</select>

public List<User> dynamicForeach3Test(Map params);

• 测试

	@Test
	public void dynamicForeach3Test() {
		List ids = new ArrayList();
		ids.add(28);
		ids.add(29);
		ids.add(30);
		
		Map params = new HashMap();
		params.put("ids", ids);
		params.put("username", "张");
		
		List<User> listUser = mapper.dynamicForeach3Test(params);
		for (User u : listUser) {
			System.out.println(u);
		}
	}

3.动态增加

   <insert id="addUser" parameterType="com.swjd.bean.User">
        insert into user
        <trim prefix="(" suffix=")" suffixOverrides=",">
            <if test="id!=null">
            id,
            </if>
            <if test="username!=null">
                username,
            </if>
            <if test="sex!=null">
                sex,
            </if>
            <if test="birthday!=null">
                birthday,
            </if>
            <if test="address!=null">
                address,
            </if>
        </trim>
        <trim prefix="values (" suffix=")" suffixOverrides=",">
            <if test="id!=null">
                #{id,jdbcType=INTEGER},
            </if>
            <if test="username!=null">
                #{userName,jdbcType=VARCHAR},
            </if>
            <if test="sex!=null">
                #{sex,jdbcType=VARCHAR},
            </if>
            <if test="birthday!=null">
                #{birthday,jdbcType=DATE},
            </if>
            <if test="address!=null">
                #{address,jdbcType=VARCHAR},
            </if>
        </trim>
    </insert>

4.动态查询

4.1根据姓名和性别查询用户(if元素)

条件是(姓名(模糊查)，年龄)，如果都有值就两个条件查询，只有一个就单条件查询，如果都没有就查询全部：
方法一：

  <select id="selectUserNameAndSex" resultType="com.swjd.bean.User">
        select * from user where 1=1
        /*调用sql片段*/
        <include refid="querySQL"></include>
  </select>

方法二：

  <select id="selectUserNameAndSex2" resultType="com.swjd.bean.User">
        select * from user
       /* where可以在语句后连接where关键词 并且去电多余的and或者or*/
        <where>
            <include refid="querySQL"></include>
        </where>
   </select>

方法三：

<!--prefix:表示你要添加的前缀(写在条件之前的) prefixOverrides:去掉第一个多余的and和or-->
   
  <select id="selectUserNameAndSex3" resultType="com.swjd.bean.User">
        select * from user
        <trim prefix="WHERE" prefixOverrides="AND|or">
            <include refid="querySQL"></include>
        </trim>
   </select>

4.2单条件查询(条件: id,name (模糊查) ,sex) 选其中一个条件，如果都没有就查全部

    <select id="selectUser" resultType="com.swjd.bean.User">
        select * from user where 1=1
        <include refid="querySQL"></include>
    </select>

4.3查询id或者username或者sex 进行优先级

   <select id="selectUsers" resultType="com.swjd.bean.User">
        select * from user where
        <choose>
            <when test="id!=null ">
                and id=#{id}
            </when>
            <when test="userName!=null and userName!=''">
                and username=#{userName}
            </when>
            <when test="sex!=null and sex!=''">
                sex=#{sex},
            </when>
            <otherwise>
               1=1
            </otherwise>
        </choose>
    </select>

5.动态修改

根据id更新user表的内容
方法一：

  <update id="updateUser">
        update user
        /*set可以在语句后面拼接一个set并且去掉多余的逗号*/
        <set>
            <if test="username!=null and userName!=''">
                username=#{userName},
            </if>
            <if test="sex!=null and sex!=''">
                sex=#{sex},
            </if>
            <if test="birthday!=null and birthday!=''">
                birthday=#{birthday},
            </if>
            <if test="address!=null and address!=''">
                address=#{address},
            </if>
        </set>
        where id=#{id}
    </update>

方法二：

  <update id="updateUser2">
        update user
        <trim prefix="set" suffixOverrides=",">
            <if test="username!=null and userName!=''">
                username=#{userName},
            </if>
            <if test="sex!=null and sex!=''">
                sex=#{sex},
            </if>
            <if test="birthday!=null and birthday!=''">
                birthday=#{birthday},
            </if>
            <if test="address!=null and address!=''">
                address=#{address},
            </if>
        </trim>
        where id=#{id}
    </update>

6.批量删除

方法一：

   <delete id="deleteMoreUser" >
        delete from user where
        <foreach collection="array" item="arr" separator="or" >
            id=#{arr}
        </foreach>
    </delete>

方法二：

<!-- collection:表示参数的类型 separator:分隔符 open:遍历前添加的字符串
   close:遍历后添加的字符串 item:遍历的变量-->
 <delete id="deleteMoreUser2" >
        delete from user where id in
        <foreach collection="list" item="xx" index="id" open="("
                 separator="," close=")">
            #{xx}
        </foreach>
    </delete>