MyBatis+Springboot 启动到SQL执行全流程

举报
战斧 发表于 2023/09/21 19:00:21 2023/09/21
【摘要】 前言本文我们将讲解Mybatis的动态sql是什么,以及如何解析,最终执行的全流程一、MyBatis的Sql类型1. 静态SQLmybatis 静态sql 在编译期就已经确定其样子,就是可直接执行,或者填入参数即可执行的,如SELECT * FROM users WHERE username = 'admin' AND password = #{password};这种静态的sql在程序启动...

前言

本文我们将讲解Mybatis的动态sql是什么,以及如何解析,最终执行的全流程


一、MyBatis的Sql类型

1. 静态SQL

mybatis 静态sql 在编译期就已经确定其样子,就是可直接执行,或者填入参数即可执行的,如

SELECT * FROM users WHERE username = 'admin' AND password = #{password};

这种静态的sql在程序启动时,扫描到就可以生成对应的sqlsource。

2. 动态SQL

MyBatis的动态Sql是指在编写Sql语句时根据不同的条件动态地生成不同的Sql语句的技术。它可以根据不同的条件来选择不同的查询语句、修改语句、插入语句和删除语句等,减少了Sql语句的重复编写和维护成本,提高了Sql语句执行的效率

MyBatis的动态Sql包括 if、choose、when、otherwise、trim、set、where、foreach 等标签,通过这些标签可以构建出多样化的Sql语句。因为语句最终样子不确定,需要根据入参的情况来动态生成不同样子的sql,所以叫动态sql

示例:

<select id="getUser" resultMap="UserMap">
  SELECT * FROM user
  <where>
    <if test="id != null">
      AND id = #{id}
    </if>
    <if test="name != null and name != ''">
      AND name = #{name}
    </if>
    <if test="age != null">
      AND age = #{age}
    </if>
  </where>
</select>

<insert id="addUser" parameterType="com.example.seeu.entity.User" >
        insert  into user(id,username,password) values
        <foreach collection="list" item="item" separator=",">
            (#{item.id}, #{item.username},#{item.password})
        </foreach>
</insert>

如上图,就是一段动态Sql,其中的 if 语句会先进行判断入参字段是否为空,如果不为空,才会在Sql中添加对应的的筛选条件;同时,我们也关注下 where 标签,这也是个动态标签,会帮我们检查筛选条件,帮我们补齐多个条件之间的 AND,如果是首条件前面带AND,也会自动帮我们去除

二、流程1 —— 文件扫描并解析

1. 扫描xml文件

第一步肯定是先寻找,并加载到所有文件,但在此之前,我们必须配置好路径,否则Mybatis是无法加载到文件的

#mybatis的相关配置
mybatis:
  #mapper配置文件【重点】
  mapper-locations: classpath:mapper/*.xml
  #开启驼峰命名
  configuration:
    map-underscore-to-camel-case: true
    cache-enabled: true

下图为SqlSessionFactoryBean.java 源码的主方法 buildSqlSessionFactory(),负责了遍历与解析xml的功能。
在这里插入图片描述
我们这里强调两个步骤,
第一个就是命名空间绑定,这里主要是通过xml文件里的命名空间,找到其对应的Mapper接口,解析接口上的各类注解,最终将该Mapper接口及信息注册给Mybatis,需要注意的是,这里的注册与这些Mapper接口上的@Mapper注解无关,这里主要是收集Mapper实际的配置,注册进MyBatisConfiguration,最终会生成一个代理对象,并交由Mybatis管理和操作。而@Mapper则是一个桥梁,使得Spring容器也能获得该代理对象,进而在Spring的体系下,能使用上Mybatis的成果
第二个,就是对xml文件内容的解析,主要还是各个标签进行解析,我们下面会说到。

在这里插入图片描述

2. 动态Sql解析

在这里插入图片描述
handler.handleNode 里面其实也调用 parseDynamicTags 方法,实现递归,此处实际上是将这些动态内容处理完后拼接成正常语法的Sql,如果嵌套的内容为动态,那么本层也标记为动态,注意,此时#{} 内容仅判断为动态SQL,并未做任何操作,所以拼接完仍然以#{} 形式存在
在这里插入图片描述
我们拿个简单的例子来说明

    <insert id="addUser" parameterType="com.zhanfu.springboot.demo.entity.User" >
        insert  into user(id,username,password) values
        <foreach collection="list" item="item">
            (#{item.id}, #{item.username},#{item.password})
        </foreach>
    </insert>

很明显,我们能看到这里面用了foreach标签,意味着是一个动态Sql,那么它最终会被解析成什么样呢?我们来看下图
在这里插入图片描述

3. 保存解析结果

我们上面看到的最后,对每一个Mapper层的方法,都能解析出一个MappedStatement,这个东西最后会存在哪呢?其实它们会以Map的形式存在一个MyBatis单例配置类 Configuration 里。而这个配置类,毫无疑问也载入了容器中。
在这里插入图片描述
在这里插入图片描述


三、流程2 —— 生成代理并暴露

流程1主要是为了做一个准备,扫描Mapper文件并解析保存。但是仅仅这样是不够的,你还需要给系统暴露一个入口,这样别人才能调用该sql,java中,我们总是通过对象来调用放啊,因此这里我们就需要对Mapper接口去生成代理对象了。不过,对象不需要我们手动创建,在mybatis-spring包中,mybatis已经对结合Spring的场景做了处理,会自动扫描并创建代理,并存储进spring容器中

1. 扫描Mapper并创建Bean定义

同扫描xml文件一样,这也需要指定扫描的Mapper接口的位置
在这里插入图片描述
然后就到了一个重点类: MapperScannerConfigurer,我们都知道,Spring启动的核心方法是Refresh,而其中有一步就是调用各工厂后置处理器
在这里插入图片描述
而 MapperScannerConfigurer 实现了 BeanDefinitionRegistryPostProcessor 接口,BeanDefinitionRegistryPostProcessor 继承自工厂后置处理器(BeanFactoryPostProcessor),所以,其在这一步内会被调用,最终的结果就是执行扫描方法
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
生成的Bean定义们,最后自然会放入注册器中,等待实例化。

2. 实例化并注入

上面,我们说注册了个Bean定义,bean名字还叫Mapper,其实际的类已经变成了FactoryBeanFactory,如下图:
在这里插入图片描述

但是,如果各位学习过前面我们关于factoryBean的内容,就应该知道,当我们从spring容器里获取这类Bean的时候,取的并不是该Bean,而是该Bean生产出来的其他对象

  // MapperFactyoryBean.java
  @Override
  public T getObject() throws Exception {
    return getSqlSession().getMapper(this.mapperInterface);
  }

不难看出,最后是在会话中去获取一个对象,所谓会话中获取,其实最终还是要到我们上面提到的Configuration里去取,该配置对象里面有一个MapperRegistry,而从(二、1. 扫描xml文件)里,我们就提过,在扫描解析xml的时候,会向myBatisConfiguration里注册命名空间,就是存在着个位置的。此刻,就要通过这个地方,创建代理了。

在这里插入图片描述创建代理的详情如下,最终我们将返还一个Proxy代理对象。最终这个对象会被注入到各其他Bean里面
在这里插入图片描述
我们可以看到,最终注入的确实是一个代理对象,而非所谓的mapperFactoryBean对象

在这里插入图片描述

四、流程3 —— 获取会话并执行

上面两个流程,我们其实已经做了相当多的准备,我们已经创建了 sqlSessionFactory,也把各sql解析成了MapperStatement,也在各个调用方那边注入了一个代理对象。至此三方都完成,接下来可以通过代理对象进行真正的执行了。
这里引用一张时序图:前面的步骤我们已经完成,关键在于最后的invoke
在这里插入图片描述
如果看不清,可以直接下载 mybatis sql执行时序图
总体来说,执行可分为 获取会话->会话执行->执行器执行->statement->jdbc ,其中statement是java定义的接口,用来执行sql的,而mybatis 和 springboot 都提供了实现类。
执行器的扩展相关内容详见 Mybatis的CachingExecutor与二级缓存

需要注意的是,mybatis为用户留下了一些“”插件空间“,用户可以按规则制定一些插件,从而在上述执行的某个阶段,做出一些操作,其实现原来类似于“切面增强”,关于这部分插件,我们下次会详细说明

五、 总结

总体来说,sql执行过程分三块,

  1. 一块是mybatis自己的读取xml和配置,生成会话工厂;解析出sql内容并注册起来,并生成代理(下图左框部分 + 中间两个对象)
  2. 二是为spring服务的,暴露代理对象给spring使用(下图jdkProxy)
  3. 三是通过代理对象,拿到sqlSession会话真正执行sql (下图9、10、11步)
    在这里插入图片描述
【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。