源码分析Mybatis MapperProxy初始化之Mapper对象的扫描与构建
public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
if (this.processPropertyPlaceHolders) {
processPropertyPlaceHolders();
}
ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);
scanner.setAddToConfig(this.addToConfig);
scanner.setAnnotationClass(this.annotationClass);
scanner.setMarkerInterface(this.markerInterface);
scanner.setSqlSessionFactory(this.sqlSessionFactory); // @1
scanner.setSqlSessionTemplate(this.sqlSessionTemplate);
scanner.setSqlSessionFactoryBeanName(this.sqlSessionFactoryBeanName);
scanner.setSqlSessionTemplateBeanName(this.sqlSessionTemplateBeanName);
scanner.setResourceLoader(this.applicationContext);
scanner.setBeanNameGenerator(this.nameGenerator);
scanner.registerFilters();
scanner.scan(StringUtils.tokenizeToStringArray(this.basePackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS)); // @2
}
代码@1：首先设置SqlSessionFactory，从该Scan器生成的Mapper最终都是受该SqlSessionFactory的管辖。
代码@2：调用ClassPathMapperScanner的scan方法进行扫描动作，接下来详细介绍。
[](()ClassPathMapperScanner#doScan
public Set doScan(String… basePackages) {
Set beanDefinitions = super.doScan(basePackages); //@1
if (beanDefinitions.isEmpty()) {
logger.warn(“No MyBatis mapper was found in '” + Arrays.toString(basePackages) + “’ package. Please check your configuration.”);
} else {
processBeanDefinitions(beanDefinitions); // @2
}
return beanDefinitions;
}
代码@1：首先调用父类(org.springframework.context.annotation.ClassPathBeanDefinitionScanner)方法，根据扫描的文件，构建对应的BeanDefinitionHolder对象。
代码@2：对这些BeanDefinitions进行处理，对Bean进行加工，加入Mybatis特性。
[](()ClassPathMapperScanner#processBeanDefinitions
private void processBeanDefinitions(Set beanDefinitions) {
GenericBeanDefinition definition;
for (BeanDefinitionHolder holder : beanDefinitions) {
definition = (GenericBeanDefinition) holder.getBeanDefinition();
if (logger.isDebugEnabled()) {
logger.debug(“Creating MapperFactoryBean with name '” + holder.getBeanName()
- “’ and '” + definition.getBeanClassName() + “’ mapperInterface”);
}
// the mapper interface is the original class of the bean
// but, the actual class of the bean is MapperFactoryBean
definition.getPropertyValues().add(“mapperInterface”, definition.getBeanClassName());
definition.setBeanClass(this.mapperFactoryBean.getClass()); // @1
definition.getPropertyValues().add(“addToConfig”, this.addToConfig);
boolean explicitFactoryUsed = false;
if (StringUtils.hasText(this.sqlSessionFactoryBeanName)) { // @2 start
definition.getPropertyValues().add(“sqlSessionFactory”, new RuntimeBeanReference(this.sqlSessionFactoryBeanName));
explicitFactoryUsed = true;
} else if (this.sqlSessionFactory != null) {
definition.getPropertyValues().add(“sqlSessionFactory”, this.sqlSessionFactory);
explicitFactoryUsed = true;
} // @2 end
if (StringUtils.hasText(this.sqlSessionTemplateBeanName)) { // @3
if (explicitFactoryUsed) {
logger.warn(“Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.”);
}
definition.getPropertyValues().add(“sqlSessionTemplate”, new RuntimeBeanReference(this.sqlSessionTemplateBeanName));
explicitFactoryUsed = true;
} else if (this.sqlSessionTemplate != null) {
if (explicitFactoryUsed) {
logger.warn(“Cannot use both: sqlSessionTemplate and sqlSessionFactory together. sqlSessionFactory is ignored.”);
}
definition.getPropertyValues().add(“sqlSessionTemplate”, this.sqlSessionTemplate);
explicitFactoryUsed = true;
}
if (!explicitFactoryUsed) {
if (logger.isDebugEnabled()) {
logger.debug(“Enabling autowire by type for MapperFactoryBean with name '” + holder.getBeanName() + “'.”);
}
definition.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
}
}
}
该方法有3个关键点：
代码@1：BeanDefinition中的beanClass设置的类为MapperFactoryBean，即该BeanDefinition初始化的实例为MapperFactoryBean，其名字可以看出，这是一个FactoryBean对象，会通过其getObject方法进行构建具体实例。
代码@2：将为MapperFactoryBean设置属性，将SqlSessionFactory放入其属性中，在实例化时可以自动获取到该SqlSessionFactory。
代码@3：如果sqlSessionTemplate不为空，则放入到属性中，以便Spring在实例化MapperFactoryBean时可以得到对应的SqlSessionTemplate。
分析到这里，MapperScannerConfigurer的doScan方法就结束了，但并没有初始化Mapper，只是创建了很多的BeanDefinition,并且其beanClass为MapperFactoryBean，那我们将目光转向MapperFactoryBean。
[](()1.3 MapperFactoryBean
MapperFactoryBean的类图如下：
先对上述核心类做一个简述：
[](()DaoSupport
Dao层的基类，定义一个模板方法，供其子类实 《一线大厂Java面试题解析+后端开发学习笔记+最新架构讲解视频+实战项目源码讲义》无偿开源 威信搜索公众号【编程进阶路】 现具体的逻辑，DaoSupport的模板方法如下：
public final void afterPropertiesSet() throws IllegalArgumentException, BeanInitializationException {
// Let abstract subclasses check their configuration.
checkDaoConfig(); // @1
// Let concrete implementations initialize themselves.
try {
initDao(); // @2
} catch (Exception ex) {
throw new BeanInitializationException(“Initialization of DAO failed”, ex);
}
}
代码@1：检查或构建dao的配置信息，该方法为抽象类，供子类实现，等下我们本节的主角MapperFactoryBean主要实现该方法，从而实现与Mybatis相关的整合信息。
代码@2：初始化Dao相关的方法，该方法为一个空实现。
[](()SqlSessionDaoSupport
SqlSession支持父类，通过使用SqlSessionFactory或SqlSessionTemplate创建SqlSession，那下面两个方法会在什么时候被调用呢？
public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory)
public void setSqlSessionTemplate(SqlSessionTemplate sqlSessionTemplate)
不知道大家还记不记得，在创建MapperFactoryBean的时候，其属性里会设置SqlSessionFacotry或SqlSessionTemplate，见上文代码(processBeanDefinitions)，这样的话在示例化Bean时，Spring会自动注入实例，即在实例化Bean时，上述方法中的一个或多个会被调用。
[](()MapperFactoryBean
主要看它是如何实现checkDaoConfig的。
MapperFactoryBean#checkDaoConfig
protected void checkDaoConfig() {
super.checkDaoConfig(); // @1
notNull(this.mapperInterface, “Property ‘mapperInterface’ is required”);
Configuration configuration = getSqlSession().getConfiguration();
if (this.addToConfig && !configuration.hasMapper(this.mapperInterface)) { // @2
try {
configuration.addMapper(this.mapperInterface);
} catch (Throwable t) {
logger.error(“Error while adding the mapper '” + this.mapperInterface + “’ to configuration.”, t);
throw new IllegalArgumentException(t);
} finally {
ErrorContext.instance().reset();
}
}
}
代码@1：首先先调用父类的checkDaoConfig方法。
代码@2：mapperInterface，就是具体的Mapper的接口类，例如com.demo.dao.UserMapper，如果以注册，则抛出异常，否则调用configuration增加Mapper。
接下来进入到org.apache.ibatis.session.Configuration中。
public void addMapper(Class type) {
mapperRegistry.addMapper(type);
}
public T getMapper(Class type, SqlSession sqlSession) {
return mapperRegistry.getMapper(type, sqlSession);
}
public boolean hasMapper(Class type) {
return mapperRegistry.hasMapper(type);
}
从上面代码可以看出，正在注册(添加)、查询、获取Mapper的核心类为MapperRegistry。
[](()1.4 MapperRegistry
其核心类图如下所示：
对其属性做个简单的介绍：
- Configuration config
Mybatis全局配置对象。
- Map
已注册Map，这里的键值为mapper接口，例如com.demo.dao.UserMapper，值为MapperProxyFactory，创建MapperProxy的工厂。
下面简单介绍MapperRegistry的几个方法，其实现都比较简单。