springmvc配置文件中context:component-scan扫描使用上的容易忽略的use-default-filters

问题

如下方式可以成功扫描到@Controller注解的Bean，不会扫描@Service/@Repository的Bean。正确

 

Java代码  

1.  <context:component-scan base-package="org.bdp.system.test.controller">   
2.      <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>   
3. </context:component-scan>  

  

但是如下方式，不仅仅扫描@Controller，还扫描@Service/@Repository的Bean，可能造成一些问题

 

Java代码  

1.  <context:component-scan base-package="org.bdp">   
2.      <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>   
3. </context:component-scan>  

 

这个尤其在springmvc+spring+hibernate等集成时最容易出问题的地，最典型的错误就是：

事务不起作用

 

这是什么问题呢？

分析

1、<context:component-scan>会交给org.springframework.context.config.ContextNamespaceHandler处理；

 

Java代码  

1. registerBeanDefinitionParser("component-scan", new ComponentScanBeanDefinitionParser());  

 

2、ComponentScanBeanDefinitionParser会读取配置文件信息并组装成org.springframework.context.annotation.ClassPathBeanDefinitionScanner进行处理；

3、如果没有配置<context:component-scan>的use-default-filters属性，则默认为true，在创建ClassPathBeanDefinitionScanner时会根据use-default-filters是否为true来调用如下代码：

 

Java代码  

1.   protected void registerDefaultFilters() {  
2. this.includeFilters.add(new AnnotationTypeFilter(Component.class));  
3. ClassLoader cl = ClassPathScanningCandidateComponentProvider.class.getClassLoader();  
4. try {  
5.     this.includeFilters.add(new AnnotationTypeFilter(  
6.             ((Class<? extends Annotation>) cl.loadClass("javax.annotation.ManagedBean")), false));  
7.     logger.info("JSR-250 'javax.annotation.ManagedBean' found and supported for component scanning");  
8. }  
9. catch (ClassNotFoundException ex) {  
10.     // JSR-250 1.1 API (as included in Java EE 6) not available - simply skip.  
11. }  
12. try {  
13.     this.includeFilters.add(new AnnotationTypeFilter(  
14.             ((Class<? extends Annotation>) cl.loadClass("javax.inject.Named")), false));  
15.     logger.info("JSR-330 'javax.inject.Named' annotation found and supported for component scanning");  
16. }  
17. catch (ClassNotFoundException ex) {  
18.     // JSR-330 API not available - simply skip.  
19. }  

 

 

可以看到默认ClassPathBeanDefinitionScanner会自动注册对@Component、@ManagedBean、@Named注解的Bean进行扫描。如果细心，到此我们就找到问题根源了。

 

 

4、在进行扫描时会通过include-filter/exclude-filter来判断你的Bean类是否是合法的：

 

Java代码  

1. protected boolean isCandidateComponent(MetadataReader metadataReader) throws IOException {  
2.     for (TypeFilter tf : this.excludeFilters) {  
3.         if (tf.match(metadataReader, this.metadataReaderFactory)) {  
4.             return false;  
5.         }  
6.     }  
7.     for (TypeFilter tf : this.includeFilters) {  
8.         if (tf.match(metadataReader, this.metadataReaderFactory)) {  
9.             AnnotationMetadata metadata = metadataReader.getAnnotationMetadata();  
10.             if (!metadata.isAnnotated(Profile.class.getName())) {  
11.                 return true;  
12.             }  
13.             AnnotationAttributes profile = MetadataUtils.attributesFor(metadata, Profile.class);  
14.             return this.environment.acceptsProfiles(profile.getStringArray("value"));  
15.         }  
16.     }  
17.     return false;  
18. }  

 

即

首先通过exclude-filter 进行黑名单过滤；

然后通过include-filter 进行白名单过滤；

否则默认排除。

 

结论

Java代码  

1. <context:component-scan base-package="org.bdp">   
2.      <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>   
3. </context:component-scan>  

 

为什么这段代码不仅仅扫描@Controller注解的Bean，而且还扫描了@Component的子注解@Service、@Reposity。因为use-default-filters默认为true。所以如果不需要默认的，则use-default-filters=“false”禁用掉。