1. 程式人生 > >Spring MVC註解方式service和controller的掃描順序

Spring MVC註解方式service和controller的掃描順序

獲得WebApplicationContext的方法:http://panyongzheng.iteye.com/admin/blogs/1477702

如下方式可以成功掃描到@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. }  

//@Service和@Controller都是Component,因為這些註解都添加了@Component註解

可以看到預設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. }  
預設掃描指定包下的全部 @Component, exclude-filter 指定的不掃描,include-filter指定的掃描, include-filter和exclude-filter 沒有指定的仍然掃描。對;

指定了use-default-filters=“false” 是這樣的
首先通過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”禁用掉。