详解MyBatis的动态SQL实现原理

分手后的思念是犯贱 2024-03-26 22:00 62阅读 0赞

### 前言 ###

**MyBatis**提供了强大的动态**SQL**语句生成功能，以应对复杂的业务场景，本篇文章将结合**MyBatis**解析**SQL**语句的过程对**MyBatis**中对<**if**>，<**where**>，<**foreach**>等动态**SQL**标签的支持进行分析。

**MyBatis**版本：**3.5.6**

### 正文 ###

#### 一. XML文档中的节点概念 ####

在分析**MyBatis**如何支持**SQL**语句之前，本小节先分析**XML**文档中的节点概念。**XML**文档中的每个成分都是一个节点，**DOM**对**XML**节点的规定如下所示。

*  整个文档是一个**文档节点**；
 *  每个**XML**标签是一个**元素节点**；
 *  包含在元素节点中的文本是**文本节点**。

以一个**XML**文档进行说明，如下所示。

<provinces>
        <province name="四川">
            <capital>成都</capital>
        </province>
        <province name="湖北">
            <capital>武汉</capital>
        </province>
    </provinces>
    复制代码

如上所示，整个**XML**文档是一个文档节点，这个文档节点有一个子节点，就是<**provinces**>元素节点，<**provinces**>元素节点有五个子节点，分别是：

1.  文本节点；
2.  <**province**>元素节点；
3.  文本节点，
4.  <**province**>元素节点；
5.  文本节点。

注意，在<**provinces**>元素节点的子节点中的文本节点的文本值均是`\n`，表示换行符。

同样，<**province**>元素节点有三个子节点，分别是：

1.  文本节点；
2.  <**capital**>元素节点；
3.  文本节点。

这里的文本节点的文本值也是`\n`。

然后<**capital**>元素节点只有一个子节点，为一个文本节点。节点的子节点之间互为兄弟节点，例如<**provinces**>元素的五个子节点之间互为兄弟节点，**name**为"**四川**"的<**province**>元素节点的上一个兄弟节点为文本节点，下一个兄弟节点也为文本节点。

#### 二. 动态SQL解析流程说明 ####

整体的一个解析流程如下所示。

![format_png][]

**也就是写在映射文件中的一条`SQL`，会最终被解析为`DynamicSqlSource`或者`RawSqlSource`，前者表示动态`SQL`，后者表示静态`SQL`**。

上图中的**MixedSqlNode**，其通常的包含关系可以由下图定义。

![format_png 1][]

也就是映射文件中定义一条**SQL**语句的**CRUD**标签里的各种子元素，均会被解析为一个**SqlNode**，比如包含了`${}`的文本，会被解析为**TextSqlNode**，不包含`${}`的文本，会被解析为**StaticTextSqlNode**，<**choose**>标签会被解析为**ChooseSqlNode**等，同时又因为<**choose**>标签中会再有<**when**>和<**otherwise**>子标签，所以**ChooseSqlNode**中又会持有这些子标签的**SqlNode**。

**所以一条`SQL`最终就是由这条`SQL`对应的`CRUD`标签解析成的各种`SqlNode`组合而成**。

#### 三. MyBatis解析动态SQL源码分析 ####

在[详解MyBatis加载映射文件和动态代理][MyBatis]中已经知道，在**XMLStatementBuilder**的**parseStatementNode()** 方法中，会解析映射文件中的<**select**>，<**insert**>，<**update**>和<**delete**>标签（后续统一称为**CURD**标签），并生成**MappedStatement**然后缓存到**Configuration**中。

**CURD**标签的解析由**XMLLanguageDriver**完成，每个标签解析之后会生成一个**SqlSource**，可以理解为**SQL**语句，本小节将对**XMLLanguageDriver**如何完成**CURD**标签的解析进行讨论。

**XMLLanguageDriver**创建**SqlSource**的**createSqlSource()** 方法如下所示。

public SqlSource createSqlSource(Configuration configuration, 
            XNode script, Class<?> parameterType) {
        XMLScriptBuilder builde

[format_png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/64ea6056208847418f51041985c00cdb.png
[format_png 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/f3f3ac4f254047fa976bbe5607bd4f02.png
[MyBatis]: https://juejin.cn/post/7203925850398883896