mybatis的动态sql

时间  2019-11-16
标签 mybatis 动态 sql 栏目 MyBatis 繁體版
原文   原文链接

MyBatis的动态SQL是基于OGNL表达式的，它能够帮助咱们方便的在SQL语句中实现某些逻辑。java

MyBatis中用于实现动态SQL的元素主要有：数组

 

  • if
  • choose（when，otherwise）
  • trim
  • where
  • set
  • foreach
if就是简单的条件判断，利用if语句咱们能够实现某些简单的条件选择。先来看以下一个例子： 
    <select id="dynamicIfTest" parameterType="Blog" resultType="Blog">  
        select * from t_blog where 11 = 1  
        <if test="title != null">  
            and title = #{title}  
        </if>  
        <if test="content != null">  
            and content = #{content}  
        </if>  
        <if test="owner != null">  
            and owner = #{owner}  
        </if>  
    </select>
这条语句的意思很是简单，若是你提供了title参数，那么就要知足title=#{title}，一样若是你提供了Content和Owner的时候，它们也须要知足相应的条件，以后就是返回知足这些条件的全部Blog，这是很是有用的一个功能，以往咱们使用其余类型框架或者直接使用JDBC的时候， 若是咱们要达到一样的选择效果的时候，咱们就须要拼SQL语句，这是极其麻烦的，比起来，上述的动态SQL就要简单多了。
 
choose元素的做用就至关于JAVA中的switch语句，基本上跟JSTL中的choose的做用和用法是同样的，一般都是与when和otherwise搭配的。看以下一个例子： 
    <select id="dynamicChooseTest" parameterType="Blog" resultType="Blog">  
        select * from t_blog where 11 = 1   
        <choose>  
            <when test="title != null">  
                and title = #{title}  
            </when>  
            <when test="content != null">  
                and content = #{content}  
            </when>  
            <otherwise>  
                and owner = "owner1"  
            </otherwise>  
        </choose>  
    </select>
when元素表示当when中的条件知足的时候就输出其中的内容，跟JAVA中的switch效果差很少的是按照条件的顺序，当when中有条件知足的时候，就会跳出choose，即全部的when和otherwise条件中，只有一个会输出，当全部的我很条件都不知足的时候就输出otherwise中的内容。因此上述语句的意思很是简单， 当title!=null的时候就输出and titlte = #{title}，再也不往下判断条件，当title为空且content!=null的时候就输出and content = #{content}，当全部条件都不知足的时候就输出otherwise中的内容。
 
where语句的做用主要是简化SQL语句中where中的条件判断的，先看一个例子，再解释一下where的好处。 
    <select id="dynamicWhereTest" parameterType="Blog" resultType="Blog">  
        select * from t_blog   
        <where>  
            <if test="title != null">  
                title = #{title}  
            </if>  
            <if test="content != null">  
                and content = #{content}  
            </if>  
            <if test="owner != null">  
                and owner = #{owner}  
            </if>  
        </where>  
    </select>

where元素的做用是会在写入where元素的地方输出一个where，另一个好处是你不须要考虑where元素里面的条件输出是什么样子的，MyBatis会智能的帮你处理，若是全部的条件都不知足那么MyBatis就会查出全部的记录，若是输出后是and 开头的，MyBatis会把第一个and忽略，固然若是是or开头的，MyBatis也会把它忽略；此外，在where元素中你不须要考虑空格的问题，MyBatis会智能的帮你加上。像上述例子中，若是title=null， 而content != null，那么输出的整个语句会是select * from t_blog where content = #{content}，而不是select * from t_blog where and content = #{content}，由于MyBatis会智能的把首个and 或 or 给忽略。session

 
trim元素的主要功能是能够在本身包含的内容前加上某些前缀，也能够在其后加上某些后缀，与之对应的属性是prefix和suffix；能够把包含内容的首部某些内容覆盖，即忽略，也能够把尾部的某些内容覆盖，对应的属性是prefixOverrides和suffixOverrides；正由于trim有这样的功能，因此咱们也能够很是简单的利用trim来代替where元素的功能，示例代码以下： 
<select id="dynamicTrimTest" parameterType="Blog" resultType="Blog">  
    select * from t_blog   
    <trim prefix="where" prefixOverrides="and |or">  
        <if test="title != null">  
            title = #{title}  
        </if>  
        <if test="content != null">  
            and content = #{content}  
        </if>  
        <if test="owner != null">  
            or owner = #{owner}  
        </if>  
    </trim>  
</select>

set元素主要是用在更新操做的时候，它的主要功能和where元素实际上是差很少的，主要是在包含的语句前输出一个set，而后若是包含的语句是以逗号结束的话将会把该逗号忽略，若是set包含的内容为空的话则会出错。有了set元素咱们就能够动态的更新那些修改了的字段。下面是一段示例代码：app

<update id="dynamicSetTest" parameterType="Blog">  
    update t_blog  
    <set>  
        <if test="title != null">  
            title = #{title},  
        </if>  
        <if test="content != null">  
            content = #{content},  
        </if>  
        <if test="owner != null">  
            owner = #{owner}  
        </if>  
    </set>  
    where id = #{id}  
</update>

上述示例代码中，若是set中一个条件都不知足，即set中包含的内容为空的时候就会报错。框架

 

 

foreach的主要用在构建in条件中，它能够在SQL语句中进行迭代一个集合。foreach元素的属性主要有item，index，collection，open，separator，close。item表示集合中每个元素进行迭代时的别名，index指定一个名字，用于表示在迭代过程当中，每次迭代到的位置，open表示该语句以什么开始，separator表示在每次进行迭代之间以什么符号做为分隔符，close表示以什么结束，在使用foreach的时候最关键的也是最容易出错的就是collection属性，该属性是必须指定的，可是在不一样状况下，该属性的值是不同的，主要有一下3种状况：
  1. 若是传入的是单参数且参数类型是一个List的时候，collection属性值为list
  2. 若是传入的是单参数且参数类型是一个array数组的时候，collection的属性值为array
  3. 若是传入的参数是多个的时候，咱们就须要把它们封装成一个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是这样的ide

public List<Blog> dynamicForeachTest(List<Integer> ids); 
    @Test  
    public void dynamicForeachTest() {  
        SqlSession session = Util.getSqlSessionFactory().openSession();  
        BlogMapper blogMapper = session.getMapper(BlogMapper.class);  
        List<Integer> ids = new ArrayList<Integer>();  
        ids.add(1);  
        ids.add(3);  
        ids.add(6);  
        List<Blog> blogs = blogMapper.dynamicForeachTest(ids);  
        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代码：spa

public List<Blog> dynamicForeach2Test(int[] ids);

java测试代码code

    @Test  
    public void dynamicForeach2Test() {  
        SqlSession session = Util.getSqlSessionFactory().openSession();  
        BlogMapper blogMapper = session.getMapper(BlogMapper.class);  
        int[] ids = new int[] {1,3,6,9};  
        List<Blog> blogs = blogMapper.dynamicForeach2Test(ids);  
        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<String, Object> params);

java测试代码

    @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();  
    }

基于3.3.1版本验证的新特性

 本文是基于Mybatis 3.0.6版本所写，笔者最近在查看新版Mybatis（3.3.1）时发现其对动态SQL的支持较之前的3.0.6版本的区别不大，基本一致，但笔者仍是发现有如下新特性：
一、foreach标签遍历的集合元素类型是Map.Entry类型时，index属性指定的变量表明对应的Map.Entry的key，item属性指定的变量表明对应的Map.Entry的value。此时若是对应的集合是Map.entrySet，则对应的collection属性用collection。foreach在进行遍历的时候若是传入的参数是List类型，则其collection属性的值能够是list或collection，但若是传入的参数是Set类型，则collection属性的值只能用collection。 
    <select id="dynamicForeachTest" resultType="Blog">  
        select * from t_blog where id in  
        <!-- 遍历的对象是Map.Entry时，index表明对应的key，item表明对应的value -->  
        <foreach collection="collection" index="key" item="value" open="(" separator="," close=")">  
            #{key}, #{value}  
        </foreach>  
    </select>

 其对应的接口方法大概是以下这样：

public List<Blog> dynamicForeachTest(Set<Map.Entry<Integer, Integer>> ids);

二、bind标签，动态SQL中已经包含了这样一个新的标签，它的功能是在当前OGNL上下文中建立一个变量并绑定一个值。有了它之后咱们之前的模糊查询就能够改为这个样子：

 <select id="fuzzyQuery" resultType="Blog" parameterType="java.lang.String">    
    <!-- bind标签用于建立新的变量 -->  
<bind name="titleLike" value="'%'+_parameter+'%'"/>  
      select * from t_blog where title like #{titleLike}    
  </select>
相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程