前言
mybatis mapperscannerconfigurer 自动扫描 将mapper接口生成代理注入到spring mybatis在与spring集成的时候可以配置 mapperfactorybean来生成mapper接口的代理。
例如：
|
1 2 3 4 |
<bean id= "usermapper" class = "org.mybatis.spring.mapper.mapperfactorybean" > <property name= "mapperinterface" value= "com.bijian.study.dao" /> <property name= "sqlsessionfactory" ref= "sqlsessionfactory" /> </bean> |
mapperfactorybean创建的代理类实现了 usermapper 接口,并且注入到应用程序中。 因为代理创建在运行时环境中(runtime,译者注) ,那么指定的映射器必须是一个接口,而 不是一个具体的实现类。
上面的配置有一个很大的缺点，就是系统有很多的配置文件时 全部需要手动编写，所以上述的方式已经很用了。
没有必要在 spring 的 xml 配置文件中注册所有的映射器。相反,你可以使用一个 mapperscannerconfigurer，它 将 会 查 找 类 路 径 下 的 映 射 器 并 自 动 将 它 们 创 建 成 mapperfactorybean。
要创建 mapperscannerconfigurer，可以在 spring 的配置中添加如下代码：
|
1 2 3 4 |
<bean id= "usermapper" class = "org.mybatis.spring.mapper.mapperfactorybean" > <property name= "mapperinterface" value= "com.bijian.study.dao" /> <property name= "sqlsessionfactory" ref= "sqlsessionfactory" /> </bean> |
basepackage 属性是让你为映射器接口文件设置基本的包路径。 你可以使用分号或逗号 作为分隔符设置多于一个的包路径。每个映射器将会在指定的包路径中递归地被搜索到。
注意 ，没 有 必 要 去 指 定 sqlsessionfactory 或 sqlsessiontemplate , 因 为 mapperscannerconfigurer 将会创建 mapperfactorybean,之后自动装配。但是,如果你使 用了一个 以上的 datasource ,那 么自动 装配可 能会失效 。这种 情况下 ,你可 以使用 sqlsessionfactorybeanname 或 sqlsessiontemplatebeanname 属性来设置正确的 bean 名 称来使用。这就是它如何来配置的,注意 bean 的名称是必须的,而不是 bean 的引用,因 此,value 属性在这里替代通常的ref。
|
1 |
<property name= "sqlsessionfactorybeanname" value= "sqlsessionfactory" /> |
整体配置如下所示：
|
1 2 3 4 5 6 7 8 9 10 |
<bean id= "sqlsessionfactory" class = "org.mybatis.spring.sqlsessionfactorybean" > <property name= "datasource" ref= "datasource" /> <property name= "mapperlocations" value= "classpath*:**/*dao*.xml" ></property> </bean>
<!-- dao配置 --> <bean class = "org.mybatis.spring.mapper.mapperscannerconfigurer" > <property name= "basepackage" value= "com.bijian.study.dao" /> <property name= "sqlsessionfactorybeanname" value= "sqlsessionfactory" /> </bean> |
mapperscannerconfigurer 支 持 过 滤 由 指 定 的 创 建 接 口 或 注 解 创 建 映 射 器 。 annotationclass 属性指定了要寻找的注解名称。 markerinterface 属性指定了要寻找的父 接口。如果两者都被指定了，加入到接口中的映射器会匹配两种标准。默认情况下，这两个 属性都是 null,所以在基包中给定的所有接口可以作为映射器加载。
被发现的映射器将会使用 spring 对自动侦测组件(参考 spring 手册的 3.14.4)默认的命 名策略来命名。也就是说,如果没有发现注解,它就会使用映射器的非大写的非完全限定类 名。但是如果发现了@component 或 jsr-330 的@named 注解,它会获取名称。注意你可以 配 置 到 org.springframework.stereotype测试数据ponent , javax.inject.named(如果你使用 jse 6 的话)或你自己的注解(肯定是自我注解)中,这 样注解将会用作生成器和名称提供器。
接下来让我们看一下mapperscannerconfigurer类的源码 看看是如何自动扫描的。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
/** * {@inheritdoc} * * @since 1.0.2 */ @override public void postprocessbeandefinitionregistry(beandefinitionregistry registry) { 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); 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)); } |
把mapper接口转换成mapperfactorybean的代码在scanner.scan方法里，让我们跟踪进去看一下。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
/** * perform a scan within the specified base packages. * @param basepackages the packages to check for annotated classes * @return number of beans registered */ public int scan(string... basepackages) { int beancountatscanstart = this .registry.getbeandefinitioncount();
doscan(basepackages);
// register annotation config processors, if necessary. if ( this .includeannotationconfig) { annotationconfigutils.registerannotationconfigprocessors( this .registry); }
return ( this .registry.getbeandefinitioncount() - beancountatscanstart); } |
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 |
/** * perform a scan within the specified base packages, * returning the registered bean definitions. * <p>this method does <i>not</i> register an annotation config processor * but rather leaves this up to the caller. * @param basepackages the packages to check for annotated classes * @return set of beans registered if any for tooling registration purposes (never {@code null}) */ protected set<beandefinitionholder> doscan(string... basepackages) { assert .notempty(basepackages, "at least one base package must be specified" ); set<beandefinitionholder> beandefinitions = new linkedhashset<beandefinitionholder>(); for (string basepackage : basepackages) { set<beandefinition> candidates = findcandidatecomponents(basepackage); for (beandefinition candidate : candidates) { scopemetadata scopemetadata = this .scopemetadataresolver.resolvescopemetadata(candidate); candidate.setscope(scopemetadata.getscopename()); string beanname = this .beannamegenerator.generatebeanname(candidate, this .registry); if (candidate instanceof abstractbeandefinition) { postprocessbeandefinition((abstractbeandefinition) candidate, beanname); } if (candidate instanceof annotatedbeandefinition) { annotationconfigutils.processcommondefinitionannotations((annotatedbeandefinition) candidate); } if (checkcandidate(beanname, candidate)) { beandefinitionholder definitionholder = new beandefinitionholder(candidate, beanname); definitionholder = annotationconfigutils.applyscopedproxymode(scopemetadata, definitionholder, this .registry); beandefinitions.add(definitionholder); registerbeandefinition(definitionholder, this .registry); } } } return beandefinitions; } |
总结
以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，谢谢大家对的支持。
原文链接：https://bijian1013.iteye测试数据/blog/2318860
查看更多关于Mybatis MapperScannerConfigurer自动扫描Mapper接口生成代理注入到的详细内容...