《深入明白Mybatis原理》MyBatis动态SQL原理

引入

我们在使用mybatis的时候，会在xml中编写sql语句。比如这段动态sql代码：

1. <update id="update" parameterType="org.format.dynamicproxy.mybatis.bean.User">
2.     UPDATE users
3.     <trim prefix="SET" prefixOverrides=",">
4.         <if test="name != null and name != ''">
5. <bean id="sqlSessionFactory" >
6.     <property name="dataSource" ref="dataSource"/>
7.     <property name="configLocation" value="classpath:mybatisConfig.xml"/>
8.     <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
9. </bean>name = #{name}
10.         </if>
11.         <if test="age != null and age != ''">
12. <bean id="sqlSessionFactory" >
13.     <property name="dataSource" ref="dataSource"/>
14.     <property name="configLocation" value="classpath:mybatisConfig.xml"/>
15.     <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
16. </bean>, age = #{age}
17.         </if>
18.         <if test="birthday != null and birthday != ''">
19. <bean id="sqlSessionFactory" >
20.     <property name="dataSource" ref="dataSource"/>
21.     <property name="configLocation" value="classpath:mybatisConfig.xml"/>
22.     <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
23. </bean>, birthday = #{birthday}
24.         </if>
25.     </trim>
26.     where id = ${id}
27. </update>

复制代码

mybatis底层是如何构造这段sql的？
关于动态SQL的接口和类

SqlNode接口，简朴明白就是xml中的每个标签，比如上述sql的update,trim,if标签：

1. public interface SqlNode {
2.     boolean apply(DynamicContext context);
3. }

复制代码

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

1. public interface SqlSource {
2.     BoundSql getBoundSql(Object parameterObject);
3. }

复制代码

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部分。
源码分析

Spring与Mybatis整合的时候必要配置SqlSessionFactoryBean，该配置会参加数据源和mybatis xml配置文件路径等信息：

1. <bean id="sqlSessionFactory" >
2.     <property name="dataSource" ref="dataSource"/>
3.     <property name="configLocation" value="classpath:mybatisConfig.xml"/>
4.     <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
5. </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。
实例分析

以下面的xml解析大概说下parseDynamicTags的解析过程：

1. <update id="update" parameterType="org.format.dynamicproxy.mybatis.bean.User">
2.     UPDATE users
3.     <trim prefix="SET" prefixOverrides=",">
4.         <if test="name != null and name != ''">
5. <bean id="sqlSessionFactory" >
6.     <property name="dataSource" ref="dataSource"/>
7.     <property name="configLocation" value="classpath:mybatisConfig.xml"/>
8.     <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
9. </bean>name = #{name}
10.         </if>
11.         <if test="age != null and age != ''">
12. <bean id="sqlSessionFactory" >
13.     <property name="dataSource" ref="dataSource"/>
14.     <property name="configLocation" value="classpath:mybatisConfig.xml"/>
15.     <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
16. </bean>, age = #{age}
17.         </if>
18.         <if test="birthday != null and birthday != ''">
19. <bean id="sqlSessionFactory" >
20.     <property name="dataSource" ref="dataSource"/>
21.     <property name="configLocation" value="classpath:mybatisConfig.xml"/>
22.     <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
23. </bean>, birthday = #{birthday}
24.         </if>
25.     </trim>
26.     where id = ${id}
27. </update>

复制代码

parseDynamicTags方法的返回值是一个List，也就是一个Sql节点集合。SqlNode本文一开始已经介绍，分析完解析过程之后会说一下各个SqlNode类型的作用。
首先根据update节点(Node)得到所有的子节点，分别是3个子节点：

• 文本节点 \n UPDATE users
  
• trim子节点 ...
  
• 文本节点 \n where id = #
  

遍历各个子节点：

• 如果节点类型是文本或者CDATA，构造一个TextSqlNode或StaticTextSqlNode；
  
• 如果节点类型是元素，说明该update节点是个动态sql，然后会使用NodeHandler处理各个类型的子节点。这里的NodeHandler是XMLScriptBuilder的一个内部接口，其实现类包括TrimHandler、WhereHandler、SetHandler、IfHandler、ChooseHandler等。看类名也就明白了这个Handler的作用，比如我们分析的trim节点，对应的是TrimHandler；if节点，对应的是IfHandler...这里子节点trim被TrimHandler处理，TrimHandler内部也使用parseDynamicTags方法解析节点。
  

碰到子节点是元素的话，重复以上步骤：
trim子节点内部有7个子节点，分别是文本节点、if节点、是文本节点、if节点、是文本节点、if节点、文本节点。文本节点跟之前一样处理，if节点使用IfHandler处理。遍历步骤如上所示，下面我们看下几个Handler的实现细节。
IfHandler处理方法也是使用parseDynamicTags方法，然后加上if标签必要的属性：

1. private class IfHandler implements NodeHandler {
2.     public void handleNode(XNode nodeToHandle, List<SqlNode> targetContents) {
3.       List<SqlNode> contents = parseDynamicTags(nodeToHandle);
4.       MixedSqlNode mixedSqlNode = new MixedSqlNode(contents);
5.       String test = nodeToHandle.getStringAttribute("test");
6.       IfSqlNode ifSqlNode = new IfSqlNode(mixedSqlNode, test);
7.       targetContents.add(ifSqlNode);
8.     }
9. }

复制代码

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

1. private class TrimHandler implements NodeHandler {
2.     public void handleNode(XNode nodeToHandle, List<SqlNode> targetContents) {
3.       List<SqlNode> contents = parseDynamicTags(nodeToHandle);
4.       MixedSqlNode mixedSqlNode = new MixedSqlNode(contents);
5.       String prefix = nodeToHandle.getStringAttribute("prefix");
6.       String prefixOverrides = nodeToHandle.getStringAttribute("prefixOverrides");
7.       String suffix = nodeToHandle.getStringAttribute("suffix");
8.       String suffixOverrides = nodeToHandle.getStringAttribute("suffixOverrides");
9.       TrimSqlNode trim = new TrimSqlNode(configuration, mixedSqlNode, prefix, prefixOverrides, suffix, suffixOverrides);
10.       targetContents.add(trim);
11.     }
12. }

复制代码

以上update方法最终通过parseDynamicTags方法得到的SqlNode集合如下：

trim节点：

由于这个update方法是个动态节点，因此构造出了DynamicSqlSource。DynamicSqlSource内部就可以构造sql了:

DynamicSqlSource内部的SqlNode属性是一个MixedSqlNode。然后我们看看各个SqlNode实现类的apply方法。下面分析一下各个SqlNode实现类的apply方法实现：
MixedSqlNode：MixedSqlNode会遍历调用内部各个sqlNode的apply方法。

1. public boolean apply(DynamicContext context) {
2.    for (SqlNode sqlNode : contents) {
3.      sqlNode.apply(context);
4.    }
5.    return true;
6. }

复制代码

StaticTextSqlNode：直接append sql文本。

1. public boolean apply(DynamicContext context) {
2.    context.appendSql(text);
3.    return true;
4. }

复制代码

IfSqlNode：这里的evaluator是一个ExpressionEvaluator类型的实例，内部使用了OGNL处理表达式逻辑。

1. public boolean apply(DynamicContext context) {
2.    if (evaluator.evaluateBoolean(test, context.getBindings())) {
3.      contents.apply(context);
4.      return true;
5.    }
6.    return false;
7. }

复制代码

TrimSqlNode：

1. 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) {<bean id="sqlSessionFactory" >
2.     <property name="dataSource" ref="dataSource"/>
3.     <property name="configLocation" value="classpath:mybatisConfig.xml"/>
4.     <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
5. </bean>for (String toRemove : prefixesToOverride) {<bean id="sqlSessionFactory" >
6.     <property name="dataSource" ref="dataSource"/>
7.     <property name="configLocation" value="classpath:mybatisConfig.xml"/>
8.     <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
9. </bean>    if (trimmedUppercaseSql.startsWith(toRemove)) {<bean id="sqlSessionFactory" >
10.     <property name="dataSource" ref="dataSource"/>
11.     <property name="configLocation" value="classpath:mybatisConfig.xml"/>
12.     <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
13. </bean>        sql.delete(0, toRemove.trim().length());<bean id="sqlSessionFactory" >
14.     <property name="dataSource" ref="dataSource"/>
15.     <property name="configLocation" value="classpath:mybatisConfig.xml"/>
16.     <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
17. </bean>        break;<bean id="sqlSessionFactory" >
18.     <property name="dataSource" ref="dataSource"/>
19.     <property name="configLocation" value="classpath:mybatisConfig.xml"/>
20.     <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
21. </bean>    }<bean id="sqlSessionFactory" >
22.     <property name="dataSource" ref="dataSource"/>
23.     <property name="configLocation" value="classpath:mybatisConfig.xml"/>
24.     <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
25. </bean>}        }        if (prefix != null) {<bean id="sqlSessionFactory" >
26.     <property name="dataSource" ref="dataSource"/>
27.     <property name="configLocation" value="classpath:mybatisConfig.xml"/>
28.     <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
29. </bean>sql.insert(0, " ");<bean id="sqlSessionFactory" >
30.     <property name="dataSource" ref="dataSource"/>
31.     <property name="configLocation" value="classpath:mybatisConfig.xml"/>
32.     <property name="mapperLocations" value="classpath*:org/format/dao/*.xml"/>
33. </bean>sql.insert(0, prefix);        }   }}

复制代码

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

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。