MyBatis3-动态SQL语句

时间 2019-11-24

标签 mybatis3 mybatis 动态 sql 语句栏目 MyBatis 繁體版

原文原文链接

MyBatis的动态SQL语句是基于OGNL表达式的。能够方便的在SQL语句中实现某些逻辑，整体说来MyBatis动态SQL语句主要有如下几类：html

一、if语句（简单的条件判断）。java

二、choose（when，otherwize），至关于Java语言中的switch，与JSTL中的choose很相似。git

三、trim（对包含的内容加上prefix，或者suffix等，前缀，后缀）。github

四、where（主要是用来简化SQL语句中where条件判断的，能智能的处理and or，没必要担忧多余致使语法错误）。数据库

五、set（主要用于更新时）。数组

六、foreach（在实现MyBatis in语句查询时特别有用）。session

下面分别介绍这几种处理方式：mybatis

注意：如下测试工程使用的是http://www.cnblogs.com/EasonJim/p/7052368.html这章的例子进行改造的。框架

1、if语句less

在User.xml配置：

    <select id="dynamicIfTest" parameterType="Article" resultType="Article">
        select * from article where 1 = 1
        <if test="title != null">
            and title = #{title}
        </if>
        <if test="content != null">
            and content = #{content}
        </if>
        limit 1
    </select>

说明：这条语句的意思很是简单，若是提供了title参数，那么就要知足title=#{title}，一样若是提供了Content的时候，它们也须要知足相应的条件，以后就是返回知足这些条件的全部Article，这是很是有用的一个功能，以往使用其余类型框架或者直接使用JDBC的时候，若是要达到一样的选择效果的时候，就须要拼SQL语句，这是极其麻烦的，比起来，上述的动态SQL就要简单多了，而且这些参数所有是防止SQL注入的。

在IUserOperation.java配置：

public Article dynamicIfTest(Article article);

测试代码：

                Article inArticle = new Article();
                inArticle.setTitle("test_title");
                Article outArticle = userOperation.dynamicIfTest(inArticle);
                System.out.println("id:"+outArticle.getId()+" title:"+outArticle.getTitle()+" content:"+outArticle.getContent());

2、choose（when，otherwize），至关于Java语言中的switch，与JSTL中的choose很相似

在User.xml配置：

    <select id="dynamicChooseTest" resultType="Article">
        select * from article where 1 = 1
        <choose>
            <when test="title != null">
                and title = #{title}
            </when>
            <when test="content != null">
                and content = #{content}
            </when>
            <otherwise>
                and tile = "test_title"
            </otherwise>
        </choose>
    </select>

说明：when元素表示当when中的条件知足的时候就输出其中的内容，跟JAVA中的switch效果差很少的是按照条件的顺序，当when中有条件知足的时候，就会跳出choose，即全部的when和otherwise条件中，只有一个会输出，当全部的我很条件都不知足的时候就输出otherwise中的内容。因此上述语句的意思很是简单，当title!=null的时候就输出and titlte = #{title}，再也不往下判断条件，当title为空且content!=null的时候就输出and content = #{content}，当全部条件都不知足的时候就输出otherwise中的内容。且这里没有指定参数的类型parameterType，那么下面的接口文件须要特殊处理。

在IUserOperation.java配置：

public Article dynamicChooseTest(
            @Param("title")
            String title, 
            @Param("content")
            String content);

说明，@Param指定了参数的名称，若是存在多个参数时，必须使用此注解进行标注，否则没法识别参数，除非参数改为arg0,arg1的顺序形式。

测试代码：

                Article outArticle2 = userOperation.dynamicChooseTest("test_title",null);
                System.out.println("id:"+outArticle2.getId()+" title:"+outArticle2.getTitle()+" content:"+outArticle2.getContent());

3、trim（对包含的内容加上prefix，或者suffix等，前缀，后缀）

在User.xml配置：

    <select id="dynamicTrimTest" parameterType="Article" resultType="Article">
        select * from article
        <trim prefix="where" prefixOverrides="and | or">
            <if test="title != null">
                title = #{title}
            </if>
            <if test="content != null">
                and content = #{content}
            </if>
            <if test="id != null">
                or id = #{id}
            </if>
        </trim>
    </select>

说明：trim元素的主要功能是能够在本身包含的内容前加上某些前缀，也能够在其后加上某些后缀，与之对应的属性是prefix和suffix；能够把包含内容的首部某些内容覆盖，即忽略，也能够把尾部的某些内容覆盖，对应的属性是prefixOverrides和suffixOverrides；正由于trim有这样的功能，因此也能够很是简单的利用trim来代替where元素的功能。

在IUserOperation.java配置：

public Article dynamicTrimTest(Article article);

测试代码：

                Article inArticle3 = new Article();
                inArticle3.setContent("test_content");
                Article outArticle3 = userOperation.dynamicTrimTest(inArticle3);
                System.out.println("id:"+outArticle3.getId()+" title:"+outArticle3.getTitle()+" content:"+outArticle3.getContent());

4、where（主要是用来简化SQL语句中where条件判断的，能智能的处理and or，没必要担忧多余致使语法错误）

在User.xml配置：

    <select id="dynamicWhereTest" parameterType="Article" resultType="Article">
        select * from article
        <where>
            <if test="title != null">
                title = #{title}
            </if>
            <if test="content != null">
                and content = #{content}
            </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给忽略。

在IUserOperation.java配置：

public Article dynamicWhereTest(Article article);

测试代码：

                Article inArticle4 = new Article();
                inArticle4.setContent("test_content");
                Article outArticle4 = userOperation.dynamicWhereTest(inArticle4);
                System.out.println("id:"+outArticle4.getId()+" title:"+outArticle4.getTitle()+" content:"+outArticle4.getContent());

5、set（主要用于更新时）

在User.xml配置：

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

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

在IUserOperation.java配置：

public int dynamicSetTest(Article article);

测试代码：

                Article inArticle5 = new Article();
                inArticle5.setContent("test_content");
                inArticle5.setId(1);
                int updateRetCout = userOperation.dynamicSetTest(inArticle5);
                session.commit();//更新必须提交事务，否则不会写入数据库
                System.out.println("更新受影响的行数："+updateRetCout);

6、foreach（在实现MyBatis in语句查询时特别有用）

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

一、单参数List的类型：

在User.xml配置：

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

在IUserOperation.java配置：

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

测试代码：

                List<Integer> ids = new ArrayList<Integer>();
                ids.add(1);
                ids.add(3);
                ids.add(6);
                List<Article> articless = userOperation.dynamicForeachTest(ids);
                for (Article articleTemp : articless)
                    System.out.println("id:"+articleTemp.getId()+" title:"+articleTemp.getTitle()+" content:"+articleTemp.getContent());

二、数组类型的参数：

在User.xml配置：

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

在IUserOperation.java配置：

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

测试代码：

                int[] ids2 = {1,3,6};                
                List<Article> articless2 = userOperation.dynamicForeach2Test(ids2);
                for (Article articleTemp : articless2)
                    System.out.println("id:"+articleTemp.getId()+" title:"+articleTemp.getTitle()+" content:"+articleTemp.getContent());

三、Map类型的参数：

在User.xml配置：

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

在IUserOperation.java配置：

public List<Article> dynamicForeach3Test(Map<String, Object> params);

测试代码：

                HashMap<String, Object> map = new HashMap<String, Object>();
                map.put("title", "title");
                map.put("ids", new int[]{1,3,6});                
                List<Article> articless3 = userOperation.dynamicForeach3Test(map);
                for (Article articleTemp : articless3)
                    System.out.println("id:"+articleTemp.getId()+" title:"+articleTemp.getTitle()+" content:"+articleTemp.getContent());

测试工程：https://github.com/easonjim/5_java_example/tree/master/mybatis/test8

参考：

http://www.yihaomen.com/article/java/328.htm