【深刻浅出MyBatis系列四】强大的动态SQL

时间  2019-11-06
标签 深刻浅出MyBatis系列四 强大 动态 sql 栏目 SQL 繁體版
原文   原文链接

#0 系列目录#java

#1 动态SQL# 那么，问题来了： 什么是动态SQL? 动态SQL有什么做用？node

传统的使用JDBC的方法，相信你们在组合复杂的的SQL语句的时候，须要去拼接，稍不注意哪怕少了个空格，都会致使错误。Mybatis的动态SQL功能正是为了解决这种问题， 其经过 if, choose, when, otherwise, trim, where, set, foreach标签，可组合成很是灵活的SQL语句，从而提升开发人员的效率。下面就去感觉Mybatis动态SQL的魅力吧。spring

#2 if: 大家能判断，我也能判断！# 做为程序猿，谁不懂 if ! 在mybatis中也能用 if 啦：sql

<select id="findUserById" resultType="user">
    select * from user where 
        <if test="id != null">
               id=#{id}
        </if>
    and deleteFlag=0;
</select>

上面例子： 若是传入的id 不为空， 那么才会SQL才拼接id = #{id}。 这个相信你们看同样就能明白，很少说。细心的人会发现一个问题：“你这不对啊！ 要是你传入的id为null, 那么你这最终的SQL语句不就成了 select * from user where and deleteFlag=0, 这语句有问题！”数组

是啊，这时候，mybatis的 where 标签就该隆重登场啦。 #3 where, 有了我，SQL语句拼接条件神马的都是浮云！# 我们经过where改造一下上面的例子：缓存

<select id="findUserById" resultType="user">
    select * from user 
        <where>
            <if test="id != null">
                id=#{id}
            </if>
            and deleteFlag=0;
        </where>
</select>

有些人就要问了： “你这都是些什么玩意儿！ 跟上面的相比， 不就是多了个where标签嘛！ 那这个还会不会出现 select * from user where and deleteFlag=0 ？”mybatis

的确，从表面上来看，就是多了个where标签而已， 不过实质上， mybatis是对它作了处理，当它遇到AND或者OR这些，它知道怎么处理。其实咱们能够经过 trim 标签去自定义这种处理规则。app

#4 trim : 个人地盘，我作主！# 上面的where标签，其实用trim 能够表示以下：dom

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

它的意思就是：当WHERE后紧随AND或则OR的时候，就去除AND或者OR。 除了WHERE之外， 其实还有一个比较经典的实现，那就是SET。ide

#5 set: 信我，不出错！#

<update id="updateUser" parameterType="com.dy.entity.User">
    update user set 
        <if test="name != null">
            name = #{name},
        </if> 
        <if test="password != null">
            password = #{password},
        </if> 
        <if test="age != null">
            age = #{age}
        </if> 
        <where>
            <if test="id != null">
                id = #{id}
            </if>
            and deleteFlag = 0;
        </where>
</update>

问题又来了： “若是我只有name不为null, 那么这SQL不就成了 update set name = #{name}, where ........ ? 你那name后面那逗号会致使出错啊！”

是的，这时候，就能够用mybatis为咱们提供的set 标签了。下面是经过set标签改造后：

<update id="updateUser" parameterType="com.dy.entity.User">
    update user
        <set>
            <if test="name != null">name = #{name},</if> 
            <if test="password != null">password = #{password},</if> 
            <if test="age != null">age = #{age},</if> 
        </set>
        <where>
            <if test="id != null">
                id = #{id}
            </if>
            and deleteFlag = 0;
        </where>
</update>

这个用trim 可表示为：

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

WHERE是使用的 prefixOverrides（前缀）， SET是使用的 suffixOverrides （后缀）， 看明白了吧！

#6 foreach: 你有for, 我有foreach, 不要觉得就你才屌！# java中有for, 可经过for循环， 一样， mybatis中有foreach, 可经过它实现循环，循环的对象固然主要是java容器和数组。

<select id="selectPostIn" resultType="domain.blog.Post">
    SELECT *
    FROM POST P
    WHERE ID in
    <foreach item="item" index="index" collection="list"
        open="(" separator="," close=")">
        #{item}
    </foreach>
</select>

**将一个 List 实例或者数组做为参数对象传给 MyBatis：**当这么作的时候，MyBatis 会自动将它包装在一个 Map 中并以名称为键。List 实例将会以“list”做为键，而数组实例的键将是“array”。一样，当循环的对象为map的时候，index其实就是map的key。

#7 choose: 我选择了你，你选择了我！# Java中有switch, mybatis有choose。

<select id="findActiveBlogLike"
     resultType="Blog">
    SELECT * FROM BLOG WHERE state = ‘ACTIVE’
    <choose>
        <when test="title != null">
            AND title like #{title}
        </when>
        <when test="author != null and author.name != null">
            AND author_name like #{author.name}
        </when>
        <otherwise>
            AND featured = 1
        </otherwise>
    </choose>
</select>

以上例子中： 当title和author都不为null的时候， 那么选择二选一（前者优先）， 若是都为null, 那么就选择 otherwise中的， 若是tilte和author只有一个不为null, 那么就选择不为null的那个。

#8 动态SQL解析原理# 咱们在使用mybatis的时候，会在xml中编写sql语句。好比这段动态sql代码：

<update id="update" parameterType="org.format.dynamicproxy.mybatis.bean.User">
    UPDATE users
    <trim prefix="SET" prefixOverrides=",">
        <if test="name != null and name != ''">
            name = #{name}
        </if>
        <if test="age != null and age != ''">
            , age = #{age}
        </if>
        <if test="birthday != null and birthday != ''">
            , birthday = #{birthday}
        </if>
    </trim>
    where id = ${id}
</update>

mybatis底层是如何构造这段sql的？下面带着这个疑问，咱们一步一步分析。

##8.1 关于动态SQL的接口和类## SqlNode接口，简单理解就是xml中的每一个标签，好比上述sql的update,trim,if标签：

public interface SqlNode {
    boolean apply(DynamicContext context);
}

输入图片说明

SqlSource Sql源接口，表明从xml文件或注解映射的sql内容，主要就是用于建立BoundSql，有实现类DynamicSqlSource(动态Sql源)，StaticSqlSource(静态Sql源)等：

public interface SqlSource {
    BoundSql getBoundSql(Object parameterObject);
}

输入图片说明

BoundSql类，封装mybatis最终产生sql的类，包括sql语句，参数，参数源数据等参数：

输入图片说明

XNode，一个Dom API中的Node接口的扩展类：

输入图片说明

BaseBuilder接口及其实现类(属性，方法省略了，你们有兴趣的本身看),这些Builder的做用就是用于构造sql：

输入图片说明

下面咱们简单分析下其中4个Builder：

XMLConfigBuilder：解析mybatis中configLocation属性中的全局xml文件，内部会使用XMLMapperBuilder解析各个xml文件。

XMLMapperBuilder：遍历mybatis中mapperLocations属性中的xml文件中每一个节点的Builder，好比user.xml，内部会使用XMLStatementBuilder处理xml中的每一个节点。

XMLStatementBuilder：解析xml文件中各个节点，好比select,insert,update,delete节点，内部会使用XMLScriptBuilder处理节点的sql部分，遍历产生的数据会丢到Configuration的mappedStatements中。

XMLScriptBuilder：解析xml中各个节点sql部分的Builder。

LanguageDriver接口及其实现类(属性，方法省略了，你们有兴趣的本身看)，该接口主要的做用就是构造sql:

输入图片说明

简单分析下XMLLanguageDriver(处理xml中的sql，RawLanguageDriver处理静态sql)：XMLLanguageDriver内部会使用XMLScriptBuilder解析xml中的sql部分。

##8.2 源码分析走起## Spring与Mybatis整合的时候须要配置SqlSessionFactoryBean，该配置会加入数据源和mybatis xml配置文件路径等信息：

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
    <property name="dataSource" ref="dataSource"/>
    <property name="configLocation" value="classpath:mybatisConfig.xml"/>
    <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
</bean>

咱们就分析这一段配置背后的细节：

SqlSessionFactoryBean实现了Spring的InitializingBean接口，InitializingBean接口的afterPropertiesSet方法中会调用buildSqlSessionFactory方法 该方法内部会使用XMLConfigBuilder解析属性configLocation中配置的路径，还会使用XMLMapperBuilder属性解析mapperLocations属性中的各个xml文件。部分源码以下：

输入图片说明

因为XMLConfigBuilder内部也是使用XMLMapperBuilder，咱们就看看XMLMapperBuilder的解析细节：

输入图片说明

输入图片说明

咱们关注一下，增删改查节点的解析：

输入图片说明

XMLStatementBuilder的解析：

输入图片说明

默认会使用XMLLanguageDriver建立SqlSource（Configuration构造函数中设置）。

XMLLanguageDriver建立SqlSource：

输入图片说明

XMLScriptBuilder解析sql：

输入图片说明

获得SqlSource以后，会放到Configuration中，有了SqlSource，就能拿BoundSql了，BoundSql能够获得最终的sql。

##8.3 实例分析## 如下面的xml解析大概说下parseDynamicTags的解析过程：

<update id="update" parameterType="org.format.dynamicproxy.mybatis.bean.User">
    UPDATE users
    <trim prefix="SET" prefixOverrides=",">
        <if test="name != null and name != ''">
            name = #{name}
        </if>
        <if test="age != null and age != ''">
            , age = #{age}
        </if>
        <if test="birthday != null and birthday != ''">
            , birthday = #{birthday}
        </if>
    </trim>
    where id = ${id}
</update>

parseDynamicTags方法的返回值是一个List，也就是一个Sql节点集合。SqlNode本文一开始已经介绍，分析完解析过程以后会说一下各个SqlNode类型的做用。

  1. 首先根据update节点(Node)获得全部的子节点，分别是3个子节点：

(1) 文本节点 \n UPDATE users

(2) trim子节点 ...

(3) 文本节点 \n where id = #{id}

  1. 遍历各个子节点：

(1) 若是节点类型是文本或者CDATA，构造一个TextSqlNode或StaticTextSqlNode；

(2) 若是节点类型是元素，说明该update节点是个动态sql，而后会使用NodeHandler处理各个类型的子节点。这里的NodeHandler是XMLScriptBuilder的一个内部接口，其实现类包括TrimHandler、WhereHandler、SetHandler、IfHandler、ChooseHandler等。看类名也就明白了这个Handler的做用，好比咱们分析的trim节点，对应的是TrimHandler；if节点，对应的是IfHandler...这里子节点trim被TrimHandler处理，TrimHandler内部也使用parseDynamicTags方法解析节点。

  1. 遇到子节点是元素的话，重复以上步骤：

trim子节点内部有7个子节点，分别是文本节点、if节点、是文本节点、if节点、是文本节点、if节点、文本节点。文本节点跟以前同样处理，if节点使用IfHandler处理。遍历步骤如上所示，下面咱们看下几个Handler的实现细节。

IfHandler处理方法也是使用parseDynamicTags方法，而后加上if标签必要的属性：

private class IfHandler implements NodeHandler {
    public void handleNode(XNode nodeToHandle, List<SqlNode> targetContents) {
      List<SqlNode> contents = parseDynamicTags(nodeToHandle);
      MixedSqlNode mixedSqlNode = new MixedSqlNode(contents);
      String test = nodeToHandle.getStringAttribute("test");
      IfSqlNode ifSqlNode = new IfSqlNode(mixedSqlNode, test);
      targetContents.add(ifSqlNode);
    }
}

TrimHandler处理方法也是使用parseDynamicTags方法，而后加上trim标签必要的属性：

private class TrimHandler implements NodeHandler {
    public void handleNode(XNode nodeToHandle, List<SqlNode> targetContents) {
      List<SqlNode> contents = parseDynamicTags(nodeToHandle);
      MixedSqlNode mixedSqlNode = new MixedSqlNode(contents);
      String prefix = nodeToHandle.getStringAttribute("prefix");
      String prefixOverrides = nodeToHandle.getStringAttribute("prefixOverrides");
      String suffix = nodeToHandle.getStringAttribute("suffix");
      String suffixOverrides = nodeToHandle.getStringAttribute("suffixOverrides");
      TrimSqlNode trim = new TrimSqlNode(configuration, mixedSqlNode, prefix, prefixOverrides, suffix, suffixOverrides);
      targetContents.add(trim);
    }
}

以上update方法最终经过parseDynamicTags方法获得的SqlNode集合以下：

输入图片说明

trim节点：

输入图片说明

因为这个update方法是个动态节点，所以构造出了DynamicSqlSource。DynamicSqlSource内部就能够构造sql了:

输入图片说明

DynamicSqlSource内部的SqlNode属性是一个MixedSqlNode。而后咱们看看各个SqlNode实现类的apply方法。下面分析一下各个SqlNode实现类的apply方法实现：

  1. MixedSqlNode：MixedSqlNode会遍历调用内部各个sqlNode的apply方法。
public boolean apply(DynamicContext context) {
   for (SqlNode sqlNode : contents) {
     sqlNode.apply(context);
   }
   return true;
}
  1. StaticTextSqlNode：直接append sql文本。
public boolean apply(DynamicContext context) {
   context.appendSql(text);
   return true;
}
  1. IfSqlNode：这里的evaluator是一个ExpressionEvaluator类型的实例，内部使用了OGNL处理表达式逻辑。
public boolean apply(DynamicContext context) {
   if (evaluator.evaluateBoolean(test, context.getBindings())) {
     contents.apply(context);
     return true;
   }
   return false;
}
  1. TrimSqlNode：
public boolean apply(DynamicContext context) {
    FilteredDynamicContext filteredDynamicContext = new FilteredDynamicContext(context);
    boolean result = contents.apply(filteredDynamicContext);
    filteredDynamicContext.applyAll();
    return result;
}

public void applyAll() {
    sqlBuffer = new StringBuilder(sqlBuffer.toString().trim());
    String trimmedUppercaseSql = sqlBuffer.toString().toUpperCase(Locale.ENGLISH);
    if (trimmedUppercaseSql.length() > 0) {
        applyPrefix(sqlBuffer, trimmedUppercaseSql);
        applySuffix(sqlBuffer, trimmedUppercaseSql);
    }
    delegate.appendSql(sqlBuffer.toString());
}

private void applyPrefix(StringBuilder sql, String trimmedUppercaseSql) {
    if (!prefixApplied) {
        prefixApplied = true;
        if (prefixesToOverride != null) {
            for (String toRemove : prefixesToOverride) {
                if (trimmedUppercaseSql.startsWith(toRemove)) {
                    sql.delete(0, toRemove.trim().length());
                    break;
                }
            }
        }
        if (prefix != null) {
            sql.insert(0, " ");
            sql.insert(0, prefix);
        }
   }
}

TrimSqlNode的apply方法也是调用属性contents(通常都是MixedSqlNode)的apply方法，按照实例也就是7个SqlNode，都是StaticTextSqlNode和IfSqlNode。 最后会使用FilteredDynamicContext过滤掉prefix和suffix。

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程