Mybatis的动态SQL

动态SQL

什么是动态SQL：就是指根据不同条件生成不同的SQL语句

使用动态 SQL 并非一件易事，但借助可用于任何 SQL 映射语句中的强大的动态 SQL 语言，MyBatis 显著地提升了这一特性的易用性。

如果你之前用过 JSTL 或任何基于类 XML 语言的文本处理器，你对动态 SQL 元素可能会感觉似曾相识。在 MyBatis 之前的版本中，需要花时间了解大量的元素。借助功能强大的基于 OGNL 的表达式，MyBatis 3 替换了之前的大部分元素，大大精简了元素种类，现在要学习的元素种类比原来的一半还要少。

if
choose (when, otherwise)
trim (where, set)
foreach

搭建环境

 CREATE TABLE `blog`(
`id` VARCHAR(50) NOT NULL COMMENT '博客id',
`title` VARCHAR(100) NOT NULL COMMENT '博客标题',
`author` VARCHAR(30) NOT NULL COMMENT '博客作者',
`create_time` DATETIME NOT NULL COMMENT '创建时间',
`views` INT(30) NOT NULL COMMENT '浏览量'
)ENGINE=INNODB DEFAULT CHARSET=utf8;

创建一个基础工程

1.导包

2.编写配置文件
​ 这里注意核心配置文件的一个设置：

像数据库中是下划线命名的，而实体类是标准驼峰命名的这种经典的，就没必要使用resultMap做映射了，只需要在核心配置文件加上下面的配置就行:

<settings>
    <!--标准的日志工厂实现-->
    <setting name="logImpl" value="STDOUT_LOGGING"/>
    <!--是否开启驼峰命名自动映射-->
    <setting name="mapUnderscoreToCamelCase" value="true"/>
</settings>

3.编写实体类

@Data
public class Blog {
    private String id;
    private String title;
    private String author;
    private Date createTime;
    private int views;
}

4.编写实体类对应Mapper接口和Mapper.xml文件,并通过接口插入数据

@Test
public void addBlogTest() {
    SqlSession sqlSession = MybatisUtils.getSqlSession();
    BlogMapper mapper = sqlSession.getMapper(BlogMapper.class);
    Blog blog = new Blog();
    blog.setId(IDUtils.getId());
    blog.setTitle("Mybatis如此简单");
    blog.setAuthor("狂神说");
    blog.setCreateTime(new Date());
    blog.setViews(9999);

    mapper.addBlog(blog);

    blog.setId(IDUtils.getId());
    blog.setTitle("Java如此简单");
    mapper.addBlog(blog);

    blog.setId(IDUtils.getId());
    blog.setTitle("Spring如此简单");
    mapper.addBlog(blog);

    blog.setId(IDUtils.getId());
    blog.setTitle("微服务如此简单");
    mapper.addBlog(blog);

    sqlSession.close();
}

IF

注意: IF标签能包含多个条件，但是choose标签只能匹配一个条件!

<select id="queryBlogIF" parameterType="map" resultType="Blog">
    select * from blog where 1=1
    <if test="title != null">
        and title = #{title}
    </if>
    <if test="author != null">
        and author = #{author}
    </if>
</select>

choose (when, otherwise)

choose(when,otherwise)：相当于java里面的switch语句，只选择匹配的一个条件来执行，而且第一个when匹配上了就直接返回sql子语句，根java里面的switch语句一个原理!

<select id="queryBlogChoose" parameterType="map" resultType="Blog">
    select * from blog
    <where>
        <choose>
            <when test="title != null">
                title = #{title}
            </when>
            <when test="author != null">
                and author = #{author}
            </when>
            <otherwise>
                and views = #{views}
            </otherwise>
        </choose>
    </where>
</select>

trim (where, set)

where标签：平常我们写sql要动态拼接得话，要保证sql不拼接错，会使用where 1=1来保证，但是Mybatis中还可以用where标签，它会检测它标签中返回的子语句的若以and或or开头，where标签会将它们去掉，保证sql拼接无误，若没有则直接拼上！

而且where标签内没有sql子语句返回，则where关键词都不会拼上！

select * from blog
<where>
    <if test="title != null">
        title = #{title}
    </if>
    <if test="author != null">
        and author = #{author}
    </if>
</where>

set标签: 它会将set标签里面的sql子语句拼接到主sql中，如果sql子语句的最后有逗号的情况下，它会将子sql语句最后的逗号给自动去除，保证sql的正确拼接!

<update id="updateBlog" parameterType="map">
    update blog
    <set>
        <if test="title != null">
            title = #{title},
        </if>
        <if test="author != null">
            author = #{author}
        </if>
    </set>
    where id= #{id}
</update>

trim标签：其实where和set标签都是属于trim标签，trim标签可以自定义像where标签和set标签一样的功能，

<trim prefix="" prefixOverrides="" suffix="" suffixOverrides="">

</trim>

比如：

下面这条trim标签的意思：

​ 这个相当于where标签，prefix是为trim标签里面的sql子语句加上前缀where，prefixOverrides表示如果子语句以and或者or开始，则用where覆盖掉!

prefix:前缀

prefixOverrides ：前缀覆盖

<trim prefix="WHERE" prefixOverrides="AND |OR ">
  ...
</trim>

这条trim意思：相当于set标签，prefix是为trim标签里面的sql子语句加上前缀where,suffixOverrides表示如果子语句以逗号结尾，由于没有指定suffix，好像的意思就是用suffix=""把逗号给覆盖掉，也即去除结尾的逗号!

<trim prefix="SET" suffixOverrides=",">
  ...
</trim>

所谓的动态SQL,本质还是SQL语句，只是我们可以在SQL层面去执行逻辑代码！

SQL片段

说foreach标签之前先看一下SQL片段：

有的时候，我们可能会将一些功能公共的部分抽取出来，方便复用!

1.使用SQL标签抽取公共的部分

<sql id="if-title-author">
    <if test="title != null">
        title = #{title}
    </if>
    <if test="author != null">
        and author = #{author}
    </if>
</sql>

2.在需要使用的地方使用Include标签引用即可

<select id="queryBlogIF" parameterType="map" resultType="Blog">
    select * from blog
    <where>
        <include refid="if-title-author"></include>
    </where>
</select>

注意事项:

• 最好基于单表来定义SQL片段!
• SQL片段内不要存在where标签

Foreach标签：

select * from user where 1=1 and (id=1 or id=2 or id=3)

@Test
public void queryBlogForeachTest(){
    SqlSession sqlSession = MybatisUtils.getSqlSession();
    BlogMapper mapper = sqlSession.getMapper(BlogMapper.class);
    HashMap map = new HashMap();
    ArrayList<Integer> ids = new ArrayList<>();
    ids.add(1);
    ids.add(2);
    ids.add(3);
    map.put("ids",ids);
    List<Blog> blogs = mapper.queryBolgForeach(map);
    for (Blog blog : blogs) {
        System.out.println(blog);
    }
    sqlSession.close();
}

<!--
   select * from user where 1=1 and (id=1 or id=2 or id=3)
-->
<select id="queryBolgForeach" parameterType="map" resultType="Blog">
    select * from blog
    <where>
        <foreach collection="ids" item="id" open="and (" close=")" separator="or">
            id=#{id}
        </foreach>
    </where>
</select>

foreach标签比较好理解，这里做的例子是parameterType为一个map，map里边是一个key为ids的list集合，然后foreach标签遍历就行了！

这里的and写不写其实都没太大关系，因为where标签之前说过了，如果标签里面的SQL子语句以and或者or开头，是会被去除的!

这里用foreach标签在我个人工作中遇到一个常见错误：在写业务代码的时候，发现foreach标签的sql语句日志根本没打印出来(并没报错)，这时候肯定是传过来的list根本就是为空或者size为0， 其实仔细想想，其实动态SQL本就是拼接SQL，SQL没拼接完全，那肯定是传过来的数据为空，SQL没拼上的原因！

所以出现程序错误，要从多个角度思考原因，要么就是程序代码写的有问题，要么程序运行时数据的原因!

建议：

• 先写出完整的SQL，再对应的去修改成为我们的动态SQL实现通用即可!

码云地址：https://gitee.com/mo18/Mybatis-Study.git 这篇文章在mybatis-08模块!