MyBatis 的 DAO 接口跟 XML 文件里面的 SQL 是如何建立关系的?

我们在使用 MyBatis 的时候,都用的是 Dao 接口和 XML 文件里的 SQL 一一对应来进行使用的。那你是否思考过二者是如何建立关系的?

在开始正文之前,首先解释 Dao 接口和 XML 文件里的 SQL 是如何一一对应的?

一句话讲完就是:MyBatis 会先解析这些 XML 文件,通过 XML 文件里面的命名空间 (namespace)跟 DAO 建立关系;然后 XML 中的每段 SQL 会有一个id 跟 DAO 中的接口进行关联。

那么问题来了: "如果我有两个这个 XML 文件都跟这个 DAO 建立关系了,那不是就是冲突了?"

带着这个疑问我们就要开始下面的正题了!

一、初始化

首先我们要知道每个基于 MyBatis 的应用都是以一个 SqlSessionFactory 的实例为中心的,SqlSessionFactory 的实例可以通过 SqlSessionFactoryBuilder 获得。

但 SqlSessionFactory 是一个接口,它里面其实就两个方法:openSession、getConfiguration

其中,openSession 方法是为了获取一个 SqlSession 对象,完成必要数据库增删改查功能。但是,SqlSessionFactory 属性太少了,所以需要getConfiguration 的配合;来配置 mapper 映射文件、SQL 参数、返回值类型、缓存等属性。

MyBatis 的 DAO 接口跟 XML 文件里面的 SQL 是如何建立关系的?

可以看到 getConfiguration 是属于 Configuration 类的一个方法。你可以把它当成一个配置管家。MyBatis 所有的配置信息都维持在 Configuration 对象之中,基本每个对象都会持有它的引用。

但日常开发中我们都是将 MyBatis 与 Spring 一起使用的,所以把实例化交给 Spring 处理。

因此我们可以看下 org.MyBatis.spring.SqlSessionFactoryBean,它实现了 InitializingBean 接口。这说明,在这个类被实例化之后会调用到 afterPropertiesSet()。它只有一个方法

MyBatis 的 DAO 接口跟 XML 文件里面的 SQL 是如何建立关系的?

而这个 afterPropertiesSet 方法只有一个动作,就是buildSqlSessionFactory。它可以分为两部分来看:

  • 1、从配置文件的 property 属性中加载各种组件,解析配置到 configuration 中
  • 2、加载 mapper 文件,解析 SQL 语句,封装成 MappedStatement 对象,配置到 configuration 中。

二、mapper 接口方法是怎样被调用到的?

大致有如下两种方式:

  • MyBatis 提供的 API

使用 MyBatis 提供的 API 进行操作,通过获取 SqlSession 对象,然后根据 Statement Id 和参数来操作数据库。

MyBatis 的 DAO 接口跟 XML 文件里面的 SQL 是如何建立关系的?

  • mapper 接口

定义 Mapper 接口,并在里面定义一系列业务数据操作方法。在 Service 层通过注入 mapper 属性,调用其方法就可以执行数据库操作。就像下面这样

MyBatis 的 DAO 接口跟 XML 文件里面的 SQL 是如何建立关系的?

那么,MemberMapper 只是个接口,并没有任何实现类。我们在调用它的时候,它是怎样最终执行到我们的 SQL 语句的呢?

三、Mapper 接口的代理创建过程

3.1、首先我们会配置需要扫描的基本包路径

通过注解的方式配置:

@MapperScan({"com.mmzsblog.business.DAO"})

或者xml的方式配置:

MyBatis 的 DAO 接口跟 XML 文件里面的 SQL 是如何建立关系的?

3.2、开始扫描

我们来到 org.MyBatis.spring.mapper.MapperScannerConfigurer 这个类,可以看到它实现了几个接口。

其中的重点是 BeanDefinitionRegistryPostProcessor。它可以动态的注册 Bean 信息,方法为 postProcessBeanDefinitionRegistry()。

MyBatis 的 DAO 接口跟 XML 文件里面的 SQL 是如何建立关系的?

ClassPathMapperScanner 继承自 Spring 中的类ClassPathBeanDefinitionScanner,所以它的 scan 方法会调用到父类 ClassPathBeanDefinitionScanner 的 scan 方法,

MyBatis 的 DAO 接口跟 XML 文件里面的 SQL 是如何建立关系的?

而在父类的 scan 方法中又调用到子类 ClassPathMapperScanner 重写的 doScan方法。

MyBatis 的 DAO 接口跟 XML 文件里面的 SQL 是如何建立关系的?

此处 super.doScan(basePackages) 是 Spring 中的方法,就不贴代码多叙述了,想详细了解的话,可以自己翻一下源码哦。

3.3、bean 注册完成并创建 sqlSession 代理

并且经过上面这些步骤,此时已经扫描到了所有的 Mapper 接口,并将其注册为 BeanDefinition 对象。而注册的时候就是用到了上面 doScan 方法中的 processBeanDefinitions 方法。

MyBatis 的 DAO 接口跟 XML 文件里面的 SQL 是如何建立关系的?

MyBatis 的 DAO 接口跟 XML 文件里面的 SQL 是如何建立关系的?


处理的过程相对比较简单,只是往 BeanDefinition 对象中设置了一些属性。例如:

  • 设置 beanClass

设置 BeanDefinition 对象的 BeanClass 为 MapperFactoryBean<?> 。这就相当于使用 MemberMapper 注册时:当前的 mapper 接口在 Spring 容器中,beanName 是 memberMapper,beanClass 是 MapperFactoryBean.class。故在Spring 的 IOC 初始化的时候,实例化的对象就是 MapperFactoryBean 对象。

  • 设置 sqlSessionFactory 属性

为 BeanDefinition 对象添加属性 sqlSessionFactory,是为了 BeanDefinition对象设置 PropertyValue 的时候,方便调用到 setSqlSessionFactory()。

MyBatis 的 DAO 接口跟 XML 文件里面的 SQL 是如何建立关系的?

3.4、创建 sqlSession 代理类

最终在 setSqlSessionFactory 这个方法里,sqlSession 获取到的是 SqlSessionTemplate 实例。而在 SqlSessionTemplate 对象中,主要包含sqlSessionFactory 和 sqlSessionProxy,而 sqlSessionProxy 实际上是 SqlSession 接口的代理对象。实际调用的是代理类的 invoke 方法。

MyBatis 的 DAO 接口跟 XML 文件里面的 SQL 是如何建立关系的?

3.5、小结

Mapper 接口的代理创建过程大致如下:

  • 1、扫描 mapper 接口基本包路径下的所有对象,将其注册为BeanDefinition 对象
  • 2、设置 BeanDefinition 的对象的 beanClass 和 sqlSessionFactory 属性(而其中获取 BeanDefinition 对象的时候,调用其工厂方法 getObject,返回 mapper 接口的代理类)
  • 3、设置 sqlSessionFactory 属性的时候,会调用 SqlSessionTemplate 的构造方法,创建 SqlSession 接口的代理类

最后我们在 Service 层,通过

@Resource private MemberMapper memberDao;

注入属性的时候,返回的就是代理类。执行 memberDao 的方法的时候,实际调用的也是代理类的 invoke 方法。

四、回答最开始的问题

MyBatis 在初始化 SqlSessionFactoryBean 的时候,找到配置需要扫描的基本包路径去解析里面所有的 XML 文件。重点就在如下两个地方:

1、创建 SqlSource

MyBatis 会把每个 SQL 标签封装成 SqlSource 对象。然后根据 SQL 语句的不同,又分为动态 SQL 和静态 SQL 。其中,静态 SQL 包含一段 String 类型的 SQL 语句;而动态 SQL 则是由一个个 SqlNode 组成

MyBatis 的 DAO 接口跟 XML 文件里面的 SQL 是如何建立关系的?

2、创建 MappedStatement

XML 文件中的每一个 SQL 标签就对应一个 MappedStatement 对象,这里面有两个属性很重要。

  • id

全限定类名+方法名组成的 ID。

  • sqlSource

当前 SQL 标签对应的 SqlSource 对象。创建完 MappedStatement 对象,会将它缓存到 Configuration#mappedStatements 中。

前面初始化中提到的 Configuration 对象,我们知道它就是 MyBatis 中的配置大管家,基本所有的配置信息都维护在这里。

例如下面这样一段代码:

MyBatis 的 DAO 接口跟 XML 文件里面的 SQL 是如何建立关系的?

把所有的 XML 都解析完成之后,Configuration 就包含了所有的 SQL 信息。然后解析完成的 XML 大概就是这样了:

MyBatis 的 DAO 接口跟 XML 文件里面的 SQL 是如何建立关系的?

看到上面的图示,聪明如你,也许就大概知道了。当我们执行 MyBatis 方法的时候,就通过全限定类名+方法名找到 MappedStatement 对象,然后解析里面的 SQL 内容,执行即可。

您可能还会对下面的文章感兴趣: