Mybatis 中的 DAO 接口和 XML 文件里的 SQL 是如何建立关系的？

男娘i 2024-03-27 18:16 4阅读 0赞

### 一、解析XML: ###

首先，Mybatis 在初始化`SqlSessionFactoryBean`时，会找到`mapperLocations`配置的路径下中所有的XML文件并进行解析，这里我们重点关注两部分：

#### 1、创建SqlSource： ####

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

![图片][2d9e6ffa3c14e35e7b5217e8e00a34d5.png]

假如我们有这样一个SQL：

<select id="getUserById" resultType="user">
        select * from user 
        <where>
            <if test="uid!=null">
                and uid=#{uid}
            </if>
        </where>
    </select>

它对应的`SqlSource`对象看起来应该是这样的：

![图片][ce93a8040818acc85f394756245ca420.png]

#### 2、创建MappedStatement： ####

接下来，Mybatis会为XML中的每个SQL标签都生成一个`MappedStatement`对象，这里面有两个属性很重要：

*  id：全限定类名+方法名组成的ID
 *  sqlSource：当前SQL标签对应的`SqlSource`对象

创建完的`MappedStatement`对象会被添加到`Configuration`中，`Configuration`对象就是Mybatis中的大管家，基本所有的配置信息都维护在这里。当把所有的XML都解析完成之后，`Configuration`就包含了所有的SQL信息。

![图片][31171a03acfaca44e2cdea243ca212e1.png]

到目前为止，XML就解析完成了，当我们执行Mybatis方法的时候，就可以通过 “`全限定类名+方法名`” 找到`MappedStatement`对象，然后解析里面的SQL内容并进行执行即可。

### 二、Dao接口代理： ###

但是Dao接口并没有具体的实现类，那么在被调用时，最终又是怎样找到我们的SQL语句的呢？

首先，我们在Spring配置文件中，一般会这样配置：

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
     <property name="basePackage" value="com.viewscenes.netsupervisor.dao" />
     <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>
    </bean>

或者你的项目是基于SpringBoot的，那么肯定也见过这种：`@MapperScan("com.xxx.dao")`，

它们的作用是一样的，就是将包路径下的所有类注册到 Spring Bean 中，并将它们的`beanClass`设置为`MapperFactoryBean`，`MapperFactoryBean`实现了`FactoryBean`接口，俗称工厂Bean。那么，当我们通过`@Autowired`注入这个Dao接口时，返回的对象就是`MapperFactoryBean`这个工厂Bean中的`getObject()`方法对象。

那么，这个方法干了些什么呢？简单来说，它就是通过JDK动态代理，返回了一个Dao接口的代理对象`MapperProxy`，当我们通过`@Autowired`注入Dao接口时，注入的就是这个代理对象，我们调用 Dao接口中的方法时，则会调用到`MapperProxy`对象的`invoke()`方法。

那么，目前为止，我们通过Dao接口也有了代理实现，所以就可以执行到它里面的方法了。

### 三、执行： ###

如上所述，当我们调用Dao接口方法的时候，实际调用到代理对象的`invoke()`方法。在这里，实际上调用的就是`SqlSession`里面的东西了。

public class DefaultSqlSession implements SqlSession {
     
     public <E> List<E> selectList(String statement, Object parameter, RowBounds rowBounds) {
      try {
       MappedStatement ms = configuration.getMappedStatement(statement);
       return executor.query(ms, 
        wrapCollection(parameter), rowBounds, Executor.NO_RESULT_HANDLER);
      }
     }
    }

看到以上代码，说明我们想的不错。它就是通过`statement`（全限定类型+方法名）拿到`MappedStatement`对象，然后通过执行器`Executor`去执行具体SQL并返回。

![图片][63577345e8f739c912ebdae07d851c21.png]

### 四、总结： ###

1、针对Mybatis中的Dao接口和XML文件里的SQL是如何建立关系的问题，主要可以归纳为下面几点小点：

*  `SqlSource`以及动态标签SqlNode
 *  `MappedStatement`对象
 *  Spring 工厂Bean 以及动态代理
 *  `SqlSession`以及执行器

2、针对有两个XML文件和这个Dao建立关系是否会冲突的问题：不管有几个XML和Dao建立关系，只要保证`namespace+id`唯一即可。

[2d9e6ffa3c14e35e7b5217e8e00a34d5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/b3a4efaeeed94ef5b3b8093fdc4fdf7a.png
[ce93a8040818acc85f394756245ca420.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/0816c627b5a1434aa6dbb5199ca5abd9.png
[31171a03acfaca44e2cdea243ca212e1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/489e04b262c34be790f66e4ce29c5661.png
[63577345e8f739c912ebdae07d851c21.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/11/26e60f24c6f4471e8274bc72a5e206d9.png