[Java知识库] 阿昌教你看懂mybatisplus的sql语句的创建过程

开发: C++知识库 Java知识库 JavaScript Python PHP知识库人工智能区块链大数据移动开发嵌入式开发工具数据结构与算法开发测试游戏开发网络协议系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑笔记本显卡显示器固态硬盘硬盘耳机手机 iphone vivo oppo 小米华为单反装机图拉丁

-> Java知识库 -> 阿昌教你看懂mybatisplus的sql语句的创建过程 -> 正文阅读

[Java知识库]阿昌教你看懂mybatisplus的sql语句的创建过程

前言

前置版本：MybatisPlus3.0.5

前些日子，阿昌写过一篇【mybatisplus的SqlSessionFacotry的创建过程】的菜鸡文章，这里我打算再记录一篇，关于mybatisplus的sql语句的创建过程。

前戏

同样，学过springboot的人都知道，如果要整合什么框架，肯定要去找XXXAutoConfiguration。

在MybatisPlusAutoConfiguration中有如下，对SpringIoc容器进行注入sqlSessionFactory

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-CiiVV4rn-1637662782175)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123154534559.png)]$

在这个方法中，他会读取properties/yaml文件中的配置，和给Spring的上下文ApplicationContext进行设置内容。

最后他会调用factory.getObject()

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-fTxpTJ5r-1637662782178)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123154901597.png)]$

刚开始，我们肯定是没有sqlsessionfactory的，所以肯定会执行afterPropertiesSet

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-ITYnu9rS-1637662782180)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123154946023.png)]$

在afterPropertiesSet中，他会调用buildSqlSessionFactory，来创建工厂

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-c3JcPTJX-1637662782181)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123155134256.png)]$

那好，我们已经到了SqlSessionFactory工厂的步骤，算是完成了前戏!!!

正文

buildSqlSessionFactory()是一个很长的方法，他总共有245行。

整体的目的是根据我们在上面前戏中，读取到的配置文件的要求创建对应的工厂。

那我们这次记录的重点是对sql语句的创建注入过程，那么他在buildSqlSessionFactory方法的哪里呢???

因为他很重要，所以他需要充足的条件，所以，在最后面。

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-cChSGPYa-1637662782183)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123155547680.png)]$

在this.mapperLocations中有我们这次读取到的所有mapper.xml文件

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-E4Muce4Z-1637662782184)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123155638261.png)]$

上面，他就先从全局配置中获取，是否有自动刷新配置。

原本我们项目启动一次会加载指定目录下的mapper.xml文件。

自动刷新配置就应该是设定有一个时机，他会再进行加载我们后加的mapper.xml文件。

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-XIlE4Vni-1637662782185)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123160133894.png)]$

然后，他就对加载到的所有的mapper.xml文件进行遍历读取

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-rNEaC1mT-1637662782186)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123160109088.png)]$

这里他通过XMLMapperBuilder来读取对应的mapper.xml文件，通过构造器给this.resource = resource附上值，然后执行bindMapperForNamespace

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-sEsv1QXH-1637662782187)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123160354539.png)]$

bindMapperForNamespace这里为这个mapper.xml绑定对应的Namespace，也就是对应的接口mapper类
之后在根据boundType(类对象Class)，来加入到配置内容中addMapper

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-WHfxm5AH-1637662782188)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123161120443.png)]$

通过给mybatisMapperRegistry添加这个mapper内容

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-iN1qypZv-1637662782188)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123161515061.png)]$

给mybatisMapperRegistry添加，就会对这个mapper进行解析

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-uf5pHmrR-1637662782189)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123162023856.png)]$

他会new MybatisMapperAnnotationBuilder()给传入配置内容和type（也就是大class对象）。进行初始化

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-c3cJukIx-1637662782190)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123162207939.png)]$

拿到上面MybatisMapperAnnotationBuilder的对象，对用parse()方法，对我们上面传入的type（mapper接口类），和对应配置设置进行解析

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-KgicPfKr-1637662782191)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123162352350.png)]$

那最关键的一步出现了，就是这个，就是这里parse()方法，可以通过这个Class对象，通过反射拿到他里面接口的方法

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-EQ1XVURa-1637662782192)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123162633787.png)]$

他会拿到这个mapper接口类，里面的方法，对应接口上面注解的信息，和对应的xml文件的内容
下面这个是mapper接口文件里面的方法，通过.xml配置文件写的sql

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-e7tRYyeX-1637662782193)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123165253543.png)]$

下面也是在mapper接口文件的方法，但是是通过注解的方法写sql的

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-wvHCrq4M-1637662782193)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123165414254.png)]$

这里的每一个方法就对应mapper接口中的一个方法

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-VD8QPfYg-1637662782194)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123165755172.png)]$
然后他会判断是否是桥接方法isBridge()

桥接方法是 JDK 1.5 引入泛型后，为了使Java的泛型方法生成的字节码和 1.5 版本前的字节码相兼容，由编译器自动生成的方法。我们可以通过Method.isBridge()方法来判断一个方法是否是桥接方法。

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-D6TCiHwt-1637662782195)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123165646367.png)]$

通过判断，他如果不是桥接方法，他就会执行parseStatement，去解析sql语句
getSqlSourceFromAnnotations()，会去对应这个方法的信息就获取对应的sql语句了！！！

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-eKvqlXyY-1637662782196)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123165953052.png)]$

先获取都头上的注解，判断是不是注解写的sql
然后他就能拿到注解上的这个具体写的sql，传入buildSqlSourceFromStrings进行解析

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-SUHsvAFa-1637662782197)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123170124086.png)]$

那他是怎么解析的呢？点进去看看。

<script脚本>

发现，他会对这个传入获取的sql进行判断，是否带有script脚本，来判断执行哪个逻辑

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-q9vKeR8A-1637662782199)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123170748818.png)]$

先看script脚本这个，他被包装了一层为XPathParser，然后传入createSqlSource

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-xAEdoWbG-1637662782199)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123170826148.png)]$

在createSqlSource中，他会再进行包装，包装成XMLScriptBuilder，然后就执行parseScriptNode解析里面的内容

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-z7ZAQDXS-1637662782200)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123171041976.png)]$
里面具体是什么样子的呢？？？
解析里面的动态标签，判断他是否是动态的sql

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-WO60p2Bf-1637662782201)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123171208020.png)]$

解析他是否是动态sql，判断里面的node节点，也就是xml标签里面还有xml标签，就认为他是动态sql

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-8XDq2U4x-1637662782202)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123171440863.png)]$

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-fswfKlvw-1637662782203)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123171352923.png)]$

判断完是否是动态sql，后就可以来用哪里SqlSource来封装他

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-YItlUpGS-1637662782203)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123171659826.png)]$

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-g9OviItx-1637662782204)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123171645223.png)]$

没使用<script脚本>

回到之前的地方，如果他不是通过<script>脚本，那他就会走else的下面

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-iSjhsyqO-1637662782205)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123173029068.png)]$

通过PropertyParser的parse来解析，看到熟悉的${}了没有！！！
用${}来解析替换参数

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-xpK5O5eH-1637662782206)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123173143705.png)]$

在parse里面进行出现了过的${}进行拼接

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-JtovrbS8-1637662782206)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123173657820.png)]$

那有个问题，他是如何进行判断是否是动态sql的呢？？？

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-jfSC6PPv-1637662782207)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123173839531.png)]$

上面解析处理完了${}后，new TextSqlNode(script)，然后就进行isDynamic判断是否是动态sql

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-nS2cChsO-1637662782208)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123173928785.png)]$

看上面，他是通过new一个DynamicCheckerTokenParser解析器，来去解析
在parse中

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-b8or335p-1637662782209)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123174334025.png)]$

他是在这里调用handler的handleToken方法

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-rv9cRmAK-1637662782209)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123174357032.png)]$

发现这里给他设置了isDynamic为true，那就可以判断，他是根据是否有存在这样的关键字${}来判断他是否是动态sql

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-ma8JlV4S-1637662782211)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123174426943.png)]$

拿到这里就算解析完了一条sql语句，然后不断的循环解析
下面是一个例子

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-E2oQV8Kf-1637662782211)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123175458159.png)]$

然后他就拼接封装给assistant.addMappedStatement

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-iNincM6d-1637662782212)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123175643458.png)]$

在addMappedStatement方法中，最后会封装成一个MappedStatement.Builder，加入到配置类configuration中

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-tKCUsSDv-1637662782213)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123180059392.png)]$

这个configuration，也就是Configuration接口，这里是MybatisConfiguration

在这里插入图片描述

最后我们看到了，他吧解析完的statement都加到了configuration中

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-2XTeemi6-1637662782215)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123180600458.png)]$

这样子就有了所有需要执行的sql语句信息，mp中的基础的17个基本查询方法他是分散的在里面

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-ZVZtYPRx-1637662782216)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123180829626.png)]$

我们自己写的自定义sql是如下形式

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-9Ag81kdt-1637662782218)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123180932600.png)]$

总结

这样子如上，我们看到了，他是不断的去读取mapper接口去反射回去对应的接口方法，获取头上的注解或者是.xml文件里面对应namespace名称空间的对应方法的xml标签，放入配置类中，并来获取组成遍历mapperLocations

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-tAstJFto-1637662782219)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123181313354.png)]$

然后在里面每一个都有一个methods，同样也是进行遍历，判断解析，是否是动态sql，是否是<script>脚本，还是row原生等

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-sJySpz8Y-1637662782219)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123181239361.png)]$

最后把他放到Mybatis配置类中的mappedStatements中

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-oVTtcf1h-1637662782220)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123181522258.png)]$

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-0zJCPsjB-1637662782221)(C:\Users\admin\AppData\Roaming\Typora\typora-user-images\image-20211123181638802.png)]$