component-scan标签的use-default-filters属性的作用以及原理分析

提示：扫一扫查出行
【扫一扫了解最新限行尾号】
复制提示

一、背景

我们在Spring+SpringMVC+Mybatis的集成开发中，经常会遇到事务配置不起作用等问题，有时候就是因为包扫描出了问题，其中component-scan的标签的use-default-filters属性坑了很多人，那么本文就来分析下出现这种问题可能的原因以及解决方式。

二、分析及原理窥探

项目结构

我们在spring-mvc.xml文件中进行如下配置，这种方式会成功扫描到带有 @Controller 注解的Bean，不会扫描带有 @Service 、 @Repository 注解的Bean，是正确的。

<context:component-scan base-package="com.hafiz.www.controller">

     <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>

</context:component-scan>

但是如下方式配置不仅仅扫描到带有 @Controller 注解的Bean，还扫描到带有 @Service 、 @Repository 注解的Bean，可能造成事务不起作用等问题。

<context:component-scan base-package="com.hafiz.www"></context:component-scan>

这是因为什么呢？下面让我们来从源码进行分析:

<context:component-scan/> 会交给 org.springframework.context.config.ContextNamespaceHandler 处理.
```
registerBeanDefinitionParser("component-scan", new ComponentScanBeanDefinitionParser());
```
ComponentScanBeanDefinitionParser 会读取配置文件信息并组装成 org.springframework.context.annotation.ClassPathBeanDefinitionScanner 进行处理。

如果没有配置


      <context:component-scan>

的


      use-default-filters

属性，则默认为true，在创建


      ClassPathBeanDefinitionScanner

时会根据


      use-default-filters

是否为true来调用如下代码：

protected void registerDefaultFilters() {

　　this.includeFilters.add(new AnnotationTypeFilter(Component.class));

　　ClassLoader cl = ClassPathScanningCandidateComponentProvider.class.getClassLoader();

　　try {

　　　　this.includeFilters.add(new AnnotationTypeFilter(

　　　　　　((Class<? extends Annotation>) cl.loadClass("javax.annotation.ManagedBean")), false));

　　　 logger.info("JSR-250 'javax.annotation.ManagedBean' found and supported for component scanning");

　　}

　　catch (ClassNotFoundException ex) {

　　　　// JSR-250 1.1 API (as included in Java EE 6) not available - simply skip.

　　}

　　try {

　　　　this.includeFilters.add(new AnnotationTypeFilter(

　　　　　　((Class<? extends Annotation>) cl.loadClass("javax.inject.Named")), false));

　　　　logger.info("JSR-330 'javax.inject.Named' annotation found and supported for component scanning");

　　}

　　catch (ClassNotFoundException ex) {

　　　　// JSR-330 API not available - simply skip.

　　}

}

从以上源码我们可以看出默认 ClassPathBeanDefinitionScanner 会自动注册对 @Component 、 @ManagedBean 、 @Named 注解的Bean进行扫描。

在进行扫描时会通过include-filter/exclude-filter来判断你的Bean类是否是合法的：
```
protected boolean isCandidateComponent(MetadataReader metadataReader) throws IOException {

 for (TypeFilter tf : this.excludeFilters) {

   if (tf.match(metadataReader, this.metadataReaderFactory)) {

      return false;

   }

 }

 for (TypeFilter tf : this.includeFilters) {

   if (tf.match(metadataReader, this.metadataReaderFactory)) {

      AnnotationMetadata metadata = metadataReader.getAnnotationMetadata();

      if (!metadata.isAnnotated(Profile.class.getName())) {

         return true;

      }

      AnnotationAttributes profile = MetadataUtils.attributesFor(metadata, Profile.class);

      return this.environment.acceptsProfiles(profile.getStringArray("value"));

    }

  }

 return false;

}
```
从以上源码可看出：扫描时首先通过exclude-filter 进行黑名单过滤，然后通过include-filter 进行白名单过滤，否则默认排除。

三、结论

在spring-mvc.xml中进行如下配置：
```
<context:component-scan base-package="com.hafiz.www">

    <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>

</context:component-scan>
```
则SpringMVC容器不仅仅扫描并注册带有 @Controller 注解的Bean，而且还扫描并注册了带有 @Component 的子注解 @Service 、 @Reposity 的Bean。因为 use-default-filters 默认为true。所以如果不需要默认的，则 use-default-filters=“false” 禁用掉。叉车价格
当我们进行上面的配置时，SpringMVC容器会把service、dao层的bean重新加载，从而造成新加载的bean覆盖了老的bean，但事务的AOP代理没有配置在spring-mvc.xml配置文件中，造成事务失效。解决办法是：在spring-mvc.xml配置文件中的context:component-scan标签中使用use-default-filters=“false”禁用掉默认的行为。