MyBatis执行流程及源码解析

我们在日常工作中广泛使用mybatis作为数据持久层框架&＃xff0c;但是mybatis的执行流程是怎么样的&＃xff0c;你了解过吗。本文将从源码角度&＃xff0c;带你分析mybatis的工作原理。

先看一个简单的例子&＃xff0c;以Service调用Mapper接口为&＃xff0c;先写一个简单的Mapper&＃xff1a;

public interface StudentMapper {&＃64;Select("select * from student")public List> query();
}

在Servie中调用Mapper的方法&＃xff1a;

&＃64;Service("studentService")
public class StudentServiceImpl implements StudentService {&＃64;AutowiredStudentMapper studentMapper;&＃64;Overridepublic List> query() {return studentMapper.select();}
}

向Service中注入这个Mapper并调用时&＃xff0c;你知道这时注入的是什么吗&＃xff1f;

通过调试&＃xff0c;可以知道这时实际的studentMapper是一个类型为MapperProxy的代理对象&＃xff0c;下面将从myabtis环境初始化开始&＃xff0c;具体分析代理对象的产生过程。

一、配置SqlSessionFactoryBean 时都做了什么&＃xff1f;

在进行spring和mybatis整合时&＃xff0c;会用xml或者注解的方式去配置一个SqlSessionFactoryBean&＃xff0c;本文中以注解方式为例&＃xff1a;

&＃64;Bean
public SqlSessionFactoryBean sqlSessionFactoryBean(DataSource dataSource){SqlSessionFactoryBean sqlSessionFactoryBean&＃61;new SqlSessionFactoryBean();sqlSessionFactoryBean.setDataSource(dataSource);return sqlSessionFactoryBean;
}

看一下SqlSessionFactoryBean的继承实现关系&＃xff1a;

先铺垫一下spring中两个非常重要的接口&＃xff0c;FactoryBean和InitializingBean。

FactoryBean&＃xff1a;

FactoryBean是一个spring中比较特殊的Bean&＃xff0c;通过它的getObject()方法可以返回一个对象实例。SqlSessionFactoryBean中getObject()方法的实现&＃xff1a;

在这里用于创建并返回一个SqlSessionFactory&＃xff0c;在 spring &＃43;mybatis 的环境下&＃xff0c;我们使用SqlSessionFactoryBean来充当SqlSessionFactory。

InitializingBean&＃xff1a;

InitializingBean接口中只有一个方法&＃xff0c;afterPropertiesSet()&＃xff0c;所有实现了该接口的类&＃xff0c;在bean的初始化之前都要调用这个方法。可以看出在上面的getObject方法中&＃xff0c;如果SqlSessionFactory为空&＃xff0c;会调用这个方法创建SqlSessionFactory。

通过调用SqlSessionFactoryBuilder的build方法&＃xff0c;最终返回了一个DefaultSqlSessionFactory实例&＃xff0c;这个DefaultSqlSessionFactory中保存了一个非常重要的Configuration对象。

二、&＃64;MapperScan都做了什么&＃xff1f;

在注解配置mybatis时&＃xff0c;通过&＃64;MapperScan指定Mapper存放的包&＃xff0c;就能自动为我们把接口实现成类。那么这是怎么实现的呢&＃xff1f;

点开&＃64;MapperScan的源码&＃xff0c;发现上面还有一行非常重要的注解&＃xff1a;

&＃64;Import(MapperScannerRegistrar.class)

ImportBeanDefinitionRegistrar接口提供registerBeanDefinitions方法向用户暴露了BeanDefinitionRegistry&＃xff0c;也就是说可以让用户手动创建BeanDefinition并使用该注册器注册到spring容器中。

查看MappercannerRegistrar的方法registerBeanDefinitions中的核心代码&＃xff1a;

ClassPathMapperScanner scanner &＃61; new ClassPathMapperScanner(registry);
……
scanner.doScan(StringUtils.toStringArray(basePackages));

主要是创建了一个Mapper扫描器&＃xff0c;开启扫描。看看ClassPathMapperScanner中doScan方法&＃xff1a;

这里对生成的mapper的bean定义做了进一步处理。进入processBeanDefinitions()方法&＃xff1a;

注意画框代码及上方的注释&＃xff0c;先看一下从BeanDefinitionHolder获得BeanDefinition时beanClass初始的值&＃xff1a;

等待setBeanClass执行完毕&＃xff1a;

通过definition.setBeanClass()把原来的BeanClass的类型替换成了MapperFactoryBean类型。到这&＃xff0c;完成了Mapper接口加载定义阶段中非常重要的一步&＃xff0c;而这也是生成代理对象MapperProxy的关键。

三、mybatis如何生成代理对象&＃xff1f;

看一下MapperFactoryBean的继承关系&＃xff1a;

MapperFactoryBean继承的SqlSessionDaoSupport类实现了InitializingBean接口&＃xff0c;那么我们还是首先找afterPropertiesSet()方法&＃xff1a;

DaoSupport中&＃xff0c;最终调用MapperFactoryBean中的方法&＃xff1a;

首先通过获取sqlSession获得了非常重要的配置类Configuration&＃xff0c;然后查看一下addMapper方法&＃xff0c;最终调用的是MapperRegistry的addMapper方法&＃xff1a;

红框中的代码为我们创建了Mapper 的代理工厂对象&＃xff08;还不是Mapper的代理对象&＃xff09;&＃xff0c;并把它放入了knownMappers这个Map中。

在这一步&＃xff0c;只是简单初始化了MapperProxyFactory&＃xff0c;把我们自己的mapper的类型传给了它&＃xff0c;还并没有真正产生代理对象。

MapperRegistry并在之后的parse()方法中完成了xml文件的解析&＃xff0c;每一个sql方法都被解析成了一个MappedStatement对象&＃xff0c;并添加到了配置类Configuration对象中。

MapperFactoryBean最终返回了什么&＃xff1f;

因为MapperFactoryBean实现了FactoryBean接口&＃xff0c;所以我们看看getObject方法究竟返回了什么&＃xff1a;

最终调用MapperRegistry的getMapper方法&＃xff1a;

这里调用的了mybatis刚才生成的MapperProxyFactory&＃xff0c;帮助我们实例化并返回了一个代理对象。

MapperProxyFactory中使用newInstance方法&＃xff0c;实例化MapperProxy&＃xff0c;用于生成代理&＃xff1a;

至此&＃xff0c;我们已经弄明白了文章开头的MapperProxy是如何生成的。

四、MapperProxy代理对象如何执行sql语句&＃xff1f;

在StudentServiceImpl中的query方法中打一个断点跟踪语句&＃xff0c;你会发现实际执行的就是代理类MapperProxy中的invoke()方法。

MapperProxy在作为代理类的同时&＃xff0c;自身实现了InvocationHandler接口&＃xff0c;所以invoke方法就是真正执行的代理逻辑。

在这里最终调用了MapperMethod的execute方法实际去执行了sql语句。

在该方法中&＃xff0c;根据sql语句执行类型&＃xff0c;调用sqlSession对应的方法执行并将结果返回给用户。至此&＃xff0c;mybatis在spring环境下一次调用全部完成。

作者&＃xff1a;Hydra
链接&＃xff1a;https://juejin.cn/post/7018360428178702366
来源&＃xff1a;稀土掘金