目的
MyBatis的XML配置文件解析成JAVA类并在内存中存储,但是在程序运行时需要对应的类去调用,而相应的调用类还没有实例化,现在流行的都是使用Spring去管理需要的对象,Spring提供2种方式,分别为XML与注解。下面来分析调用类的实例化及与配置绑定。
1 XML方式
1<bean id="menuMapper" class="org.mybatis.spring.mapper.MapperFactoryBean"> 2 <property name="sqlSessionFactory" ref="sqlSessionFactory" /> 3 <property name="mapperInterface" value="cn.vansky.schedule.time.menu.dao.MenuMapper" /> 4</bean>
这里相等于实例一个id为menuMapper的对象,这个对象实际类是MapperFactoryBean,里面包含2个属性。当需要使用此对象时,直接使用id注入即可。下面来看看类里面做了哪些操作?
1protected void checkDaoConfig() { 2 super.checkDaoConfig(); 3 notNull(this.mapperInterface, "Property 'mapperInterface' is required"); 4 Configuration configuration = getSqlSession().getConfiguration(); 5 if (this.addToConfig && !configuration.hasMapper(this.mapperInterface)) { 6 try { 7 configuration.addMapper(this.mapperInterface); 8 } catch (Throwable t) { 9 logger.error("Error while adding the mapper '" + this.mapperInterface + "' to configuration.", t); 10 throw new IllegalArgumentException(t); 11 } finally { 12 ErrorContext.instance().reset(); 13 } 14 } 15} 16 17protected void checkDaoConfig() { 18 notNull(this.sqlSession, "Property 'sqlSessionFactory' or 'sqlSessionTemplate' are required"); 19} 20 21@Autowired(required = false) 22 public final void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory) { 23 if (!this.externalSqlSession) { 24 this.sqlSession = new SqlSessionTemplate(sqlSessionFactory); 25 } 26} 27 28@Autowired(required = false) 29public final void setSqlSessionTemplate(SqlSessionTemplate sqlSessionTemplate) { 30 this.sqlSession = sqlSessionTemplate; 31 this.externalSqlSession = true; 32}
自身校验接口类不能为空,父类校验SqlSession不能为空,说明SqlSessionFactory与SqlSessionTemplate必须存在一个。
在MyBatis整合Spring的实现(17)中分析已经知道,SQL对应的Mapper文件已经解析并添加到Configuration(全局配置类)中,为什么这里还会添加Mapper呢?因为前面分析的是对XML的解析,如果我们的配置使用的注解方式,那么这里,我的Mapper是没有解析的,当没有解析时,这里就会去解析注解并添加到Configuration(全局配置类)中。
2 注解方式
1<bean name="mapperScannerConfigurer_one" class="org.mybatis.spring.mapper.MapperScannerConfigurer"> 2 <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" /> 3 <property name="basePackage" value="cn.vansky.schedule.time" /> 4 <property name="annotationClass" value="cn.vansky.framework.core.orm.mybatis.annotation.SqlMapper" /> 5 <property name="markerInterface" value="org.mybatis.spring.mapper.MapperFactoryBean" /> 6</bean>
这里使用注解方式,把包cn.vansky.schedule.time下面的所有JAVA类全部实例化,但是这样实例的话,那么实际类型就是对应JAVA类的类型,也就相当于下面的配置。
1<bean id="menuMapper" class="cn.vansky.schedule.time.menu.dao.MenuMapper"> 2</bean>
这里如果要是直接使用id注入,那么就调用不到MyBatis的配置,所以分析MapperScannerConfigurer类做了哪些操作?
1public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry beanDefinitionRegistry) throws BeansException { 2 if (this.processPropertyPlaceHolders) { 3 processPropertyPlaceHolders(); 4 } 5 Scanner scanner = new Scanner(beanDefinitionRegistry); 6 scanner.setResourceLoader(this.applicationContext); 7 scanner.scan(StringUtils.tokenizeToStringArray(this.basePackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS)); 8}

MapperScannerConfigurer类实现BeanDefinitionRegistryPostProcessor,需要执行postProcessBeanDefinitionRegistry方法。上图红框中,Spring把接口MenuMapper类的属性修改了,使此类的实例化最终的Bean变成MapperFactoryBean并注入MapperFactoryBean类的属性mapperInterface。也就相当于XML的配置(查看本章节1)。
3 BEAN注入

JAVA代码里面注入使用注解@Autowired,此注解默认使用类型获取对应的对象。
这里类型MenuMapper,而实际类型为MapperFactoryBean,应该会出现类型转换异常呀!
MyBatis做了进一步处理,MapperFactoryBean实现FactoryBean,必须实现getObject方法。

这里是获取最终的对象,mapperInterface属性就是实际的类型MenuMapper。

SqlSession是SqlSessionTemplate,SqlSessionTemplate的getMapper方法。


通过代理工厂,实际的对象就通过代理实例化完成。最终的代理类就是MapperProxy。
总结
注解方式就是对XML的整合,把多个Bean实例化整合成一个XML配置,这样省去多余的配置信息,而且还提供了注解方式来配置SQL的Mapper信息。