Spring對注解(Annotation)處理【轉】


1.從Spring2.0以后的版本中,spring也引入了基於注解(Annotation)方式的配置,注解(Annotation)是JDK1.5中引入的一個新特性,用於簡化Bean的配置,某些場合可以取代XML配置文件。開發人員對注解(Annotation)的態度也是蘿卜青菜各有所愛,個人認為注解可以大大簡化配置,提高開發速度,同時也不能完全取代XML配置方式,XML 方式更加靈活,並且發展的相對成熟,這種配置方式為大多數 Spring 開發者熟悉;注解方式使用起來非常簡潔,但是尚處於發展階段,XML配置文件和注解(Annotation)可以相互配合使用。

Spring IoC容器對於類級別的注解和類內部的注解分以下兩種處理策略:

(1).類級別的注解:如@Component、@Repository、@Controller、@Service以及JavaEE6的@ManagedBean和@Named注解,都是添加在類上面的類級別注解,Spring容器根據注解的過濾規則掃描讀取注解Bean定義類,並將其注冊到Spring IoC容器中。

(2).類內部的注解:如@Autowire、@Value、@Resource以及EJB和WebService相關的注解等,都是添加在類內部的字段或者方法上的類內部注解,SpringIoC容器通過Bean后置注解處理器解析Bean內部的注解。

下面將根據這兩種處理策略,分別分析Spring處理注解相關的源碼。

2.AnnotationConfigApplicationContext對注解Bean初始化:

Spring中,管理注解Bean定義的容器有兩個:AnnotationConfigApplicationContext和 AnnotationConfigWebApplicationContex。這兩個類是專門處理Spring注解方式配置的容器,直接依賴於注解作為容器配置信息來源的IoC容器。 AnnotationConfigWebApplicationContext是AnnotationConfigApplicationContext的web版本,兩者的用法以及對注解的處理方式幾乎沒有什么差別,因此本文將以AnnotationConfigApplicationContext為例進行講解。

AnnotationConfigApplicationContext的源碼如下:

 1 public class AnnotationConfigApplicationContext extends GenericApplicationContext {  
 2     //創建一個讀取注解的Bean定義讀取器,並將其設置到容器中  
 3     private final AnnotatedBeanDefinitionReader reader = new AnnotatedBeanDefinitionReader(this);  
 4     //創建一個掃描指定類路徑中注解Bean定義的掃描器,並將其設置到容器中  
 5     private final ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(this);  
 6 //默認構造函數,初始化一個空容器,容器不包含任何 Bean 信息,需要在稍后通過調用其register() //方法注冊配置類,並調用refresh()方法刷新容器,觸發容器對注解Bean的載入、解析和注冊過程  
 7     public AnnotationConfigApplicationContext() {  
 8     }  
 9     //最常用的構造函數,通過將涉及到的配置類傳遞給該構造函數,以實現將相應配置類中的Bean  
10 //自動注冊到容器中  
11     public AnnotationConfigApplicationContext(Class<?>... annotatedClasses) {  
12         register(annotatedClasses);  
13         refresh();  
14     }  
15 //該構造函數會自動掃描以給定的包及其子包下的所有類,並自動識別所有的Spring Bean,將其  
16 //注冊到容器中  
17     public AnnotationConfigApplicationContext(String... basePackages) {  
18         scan(basePackages);  
19         refresh();  
20     }  
21     //為容器的注解Bean讀取器和注解Bean掃描器設置Bean名稱產生器  
22     public void setBeanNameGenerator(BeanNameGenerator beanNameGenerator) {  
23         this.reader.setBeanNameGenerator(beanNameGenerator);  
24         this.scanner.setBeanNameGenerator(beanNameGenerator);  
25     }  
26     //為容器的注解Bean讀取器和注解Bean掃描器設置作用范圍元信息解析器  
27     public void setScopeMetadataResolver(ScopeMetadataResolver scopeMetadataResolver) {  
28         this.reader.setScopeMetadataResolver(scopeMetadataResolver);  
29         this.scanner.setScopeMetadataResolver(scopeMetadataResolver);  
30     }  
31     //為容器注冊一個要被處理的注解Bean,新注冊的Bean,必須手動調用容器的  
32 //refresh()方法刷新容器,觸發容器對新注冊的Bean的處理  
33     public void register(Class<?>... annotatedClasses) {  
34         this.reader.register(annotatedClasses);  
35     }  
36     //掃描指定包路徑及其子包下的注解類,為了使新添加的類被處理,必須手動調用  
37     //refresh()方法刷新容器  
38     public void scan(String... basePackages) {  
39         this.scanner.scan(basePackages);  
40     }  
41 }  

通過對AnnotationConfigApplicationContext的源碼分析,我們了解到Spring對注解的處理分為兩種方式:

(1).直接將注解Bean注冊到容器中:

可以在初始化容器時注冊;也可以在容器創建之后手動調用注冊方法向容器注冊,然后通過手動刷新容器,使得容器對注冊的注解Bean進行處理。

(2).通過掃描指定的包及其子包下的所有類:

在初始化注解容器時指定要自動掃描的路徑,如果容器創建以后向給定路徑動態添加了注解Bean,則需要手動調用容器掃描的方法,然后手動刷新容器,使得容器對所注冊的Bean進行處理。

接下來,將會對兩種處理方式詳細分析其實現過程。

3.AnnotationConfigApplicationContext注冊注解Bean:

當創建注解處理容器時,如果傳入的初始參數是具體的注解Bean定義類時,注解容器讀取並注冊。

(1).AnnotationConfigApplicationContext通過調用注解Bean定義讀取器AnnotatedBeanDefinitionReader的register方法向容器注冊指定的注解Bean,注解Bean定義讀取器向容器注冊注解Bean的源碼如下:

 1 //注冊多個注解Bean定義類  
 2 public void register(Class<?>... annotatedClasses) {  
 3         for (Class<?> annotatedClass : annotatedClasses) {  
 4             registerBean(annotatedClass);  
 5         }  
 6     }  
 7     //注冊一個注解Bean定義類  
 8     public void registerBean(Class<?> annotatedClass) {  
 9         registerBean(annotatedClass, null, (Class<? extends Annotation>[]) null);  
10     }  
11     //Bean定義讀取器注冊注解Bean定義的入口方法  
12     public void registerBean(Class<?> annotatedClass, Class<? extends Annotation>... qualifiers) {  
13         registerBean(annotatedClass, null, qualifiers);  
14     }  
15     //Bean定義讀取器向容器注冊注解Bean定義類  
16     public void registerBean(Class<?> annotatedClass, String name, Class<? extends Annotation>... qualifiers) {  
17         //根據指定的注解Bean定義類,創建Spring容器中對注解Bean的封裝的<a href="http://lib.csdn.net/base/datastructure" class='replace_word' title="算法與數據結構知識庫" target='_blank' style='color:#df3434; font-weight:bold;'>數據結構</a>  
18         AnnotatedGenericBeanDefinition abd = new AnnotatedGenericBeanDefinition(annotatedClass);  
19         //解析注解Bean定義的作用域,若@Scope("prototype"),則Bean為原型類型;  
20         //若@Scope("singleton"),則Bean為單態類型  
21         ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(abd);  
22         //為注解Bean定義設置作用域  
23         abd.setScope(scopeMetadata.getScopeName());  
24         //為注解Bean定義生成Bean名稱  
25         String beanName = (name != null ? name : this.beanNameGenerator.generateBeanName(abd, this.registry));  
26         //處理注解Bean定義中的通用注解  
27         AnnotationConfigUtils.processCommonDefinitionAnnotations(abd);  
28         //如果在向容器注冊注解Bean定義時,使用了額外的限定符注解,則解析限定符注解。  
29     //主要是配置的關於autowiring自動依賴注入裝配的限定條件,即@Qualifier  
30 //注解,Spring自動依賴注入裝配默認是按類型裝配,如果使用@Qualifier則按名稱  
31         if (qualifiers != null) {  
32             for (Class<? extends Annotation> qualifier : qualifiers) {  
33 //如果配置了@Primary注解,設置該Bean為autowiring自動依賴注入裝//配時的首選  
34                 if (Primary.class.equals(qualifier)) {  
35                     abd.setPrimary(true);  
36                 }  
37                 //如果配置了@Lazy注解,則設置該Bean為非延遲初始化,如果沒有配置,  
38                 //則該Bean為預實例化  
39                 else if (Lazy.class.equals(qualifier)) {  
40                     abd.setLazyInit(true);  
41                 }  
42                 //如果使用了除@Primary和@Lazy以外的其他注解,則為該Bean添加一  
43 //個autowiring自動依賴注入裝配限定符,該Bean在進autowiring  
44 //自動依賴注入裝配時,根據名稱裝配限定符指定的Bean  
45                 else {  
46                     abd.addQualifier(new AutowireCandidateQualifier(qualifier));  
47                 }  
48             }  
49         }  
50         //創建一個指定Bean名稱的Bean定義對象,封裝注解Bean定義類數據  
51         BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(abd, beanName);  
52         //根據注解Bean定義類中配置的作用域,創建相應的代理對象  
53         definitionHolder = AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);  
54     //向IoC容器注冊注解Bean類定義對象   BeanDefinitionReaderUtils.registerBeanDefinition(definitionHolder, this.registry);  
55     }  

從上面的源碼我們可以看出,注冊注解Bean定義類的基本步驟:

a,需要使用注解元數據解析器解析注解Bean中關於作用域的配置。

b,使用AnnotationConfigUtils的processCommonDefinitionAnnotations方法處理注解Bean定義類中通用的注解。

c,使用AnnotationConfigUtils的applyScopedProxyMode方法創建對於作用域的代理對象。

d,通過BeanDefinitionReaderUtils向容器注冊Bean。

下面我們繼續分析這3步的具體實現過程

(2).AnnotationScopeMetadataResolver解析作用域元數據:

AnnotationScopeMetadataResolver通過processCommonDefinitionAnnotations方法解析注解Bean定義類的作用域元信息,即判斷注冊的Bean是原生類型(prototype)還是單態(singleton)類型,其源碼如下:

 1 //解析注解Bean定義類中的作用域元信息  
 2 public ScopeMetadata resolveScopeMetadata(BeanDefinition definition) {  
 3         ScopeMetadata metadata = new ScopeMetadata();  
 4         if (definition instanceof AnnotatedBeanDefinition) {  
 5             AnnotatedBeanDefinition annDef = (AnnotatedBeanDefinition) definition;  
 6             //從注解Bean定義類的屬性中查找屬性為”Scope”的值,即@Scope注解的值  
 7             // annDef.getMetadata().getAnnotationAttributes方法將Bean  
 8 //中所有的注解和注解的值存放在一個map集合中  
 9             Map<String, Object> attributes =  
10     annDef.getMetadata().getAnnotationAttributes(this.scopeAnnotationType.getName());  
11             //將獲取到的@Scope注解的值設置到要返回的對象中  
12             if (attributes != null) {  
13                 metadata.setScopeName((String) attributes.get("value"));  
14                 //獲取@Scope注解中的proxyMode屬性值,在創建代理對象時會用到  
15                 ScopedProxyMode proxyMode = (ScopedProxyMode) attributes.get("proxyMode");  
16                 //如果@Scope的proxyMode屬性值為null、DEFAULT或者NO  
17                 if (proxyMode == null || proxyMode == ScopedProxyMode.DEFAULT) {  
18                     //設置proxyMode為NO  
19                     proxyMode = this.defaultProxyMode;  
20                 }  
21                 //為返回的元數據設置proxyMode  
22                 metadata.setScopedProxyMode(proxyMode);  
23             }  
24         }  
25         //返回解析的作用域元信息對象  
26         return metadata;  
27     }  

上述代碼中的annDef.getMetadata().getAnnotationAttributes方法就是獲取對象中指定類型的注解的值。

(3).AnnotationConfigUtils處理注解Bean定義類中的通用注解:

AnnotationConfigUtils類的processCommonDefinitionAnnotations在向容器注冊Bean之前,首先對注解Bean定義類中的通用Spring注解進行處理,源碼如下:

 1 //處理Bean定義中通用注解  
 2 static void processCommonDefinitionAnnotations(AnnotatedBeanDefinition abd) {  
 3 //如果Bean定義中有@Primary注解,則為該Bean設置為autowiring自動依賴注入//裝配的首選對象  
 4         if (abd.getMetadata().isAnnotated(Primary.class.getName())) {  
 5             abd.setPrimary(true);  
 6         }  
 7         //如果Bean定義中有@Lazy注解,則將該Bean預實例化屬性設置為@lazy注解的值  
 8         if (abd.getMetadata().isAnnotated(Lazy.class.getName())) {  
 9             Boolean value = (Boolean) abd.getMetadata().getAnnotationAttributes(Lazy.class.getName()).get("value");  
10             abd.setLazyInit(value);  
11         }  
12         //如果Bean定義中有@ DependsOn注解,則為該Bean設置所依賴的Bean名稱,  
13 //容器將確保在實例化該Bean之前首先實例化所依賴的Bean  
14  if (abd.getMetadata().isAnnotated(DependsOn.class.getName())) {  
15             String[] value = (String[]) abd.getMetadata().getAnnotationAttributes(DependsOn.class.getName()).get("value");  
16             abd.setDependsOn(value);  
17         }  
18     }  

(4).AnnotationConfigUtils根據注解Bean定義類中配置的作用域為其應用相應的代理策略:

AnnotationConfigUtils類的applyScopedProxyMode方法根據注解Bean定義類中配置的作用域@Scope注解的值,為Bean定義應用相應的代理模式,主要是在Spring面向切面編程(AOP)中使用。源碼如下:

 1 //根據作用域為Bean應用引用的代碼模式  
 2 static BeanDefinitionHolder applyScopedProxyMode(  
 3             ScopeMetadata metadata, BeanDefinitionHolder definition, BeanDefinitionRegistry registry) {  
 4         //獲取注解Bean定義類中@Scope注解的proxyMode屬性值  
 5         ScopedProxyMode scopedProxyMode = metadata.getScopedProxyMode();  
 6         //如果配置的@Scope注解的proxyMode屬性值為NO,則不應用代理模式  
 7         if (scopedProxyMode.equals(ScopedProxyMode.NO)) {  
 8             return definition;  
 9         }  
10 //獲取配置的@Scope注解的proxyMode屬性值,如果為TARGET_CLASS,則返  
11 //回true,如果為INTERFACES,則返回false  
12         boolean proxyTargetClass = scopedProxyMode.equals(ScopedProxyMode.TARGET_CLASS);  
13         //為注冊的Bean創建相應模式的代理對象  
14         return ScopedProxyCreator.createScopedProxy(definition, registry, proxyTargetClass);  
15     }   

這段為Bean引用創建相應模式的代理,如果在Spring面向切面編程(AOP)中涉及到再詳細分析,這里不做深入的分析。

(5).BeanDefinitionReaderUtils向容器注冊Bean:

BeanDefinitionReaderUtils向容器注冊載入的Bean我們在第4篇博客中已經分析過,主要是校驗Bean定義,然后將Bean添加到容器中一個管理Bean定義的HashMap中,這里就不做分析。

4.AnnotationConfigApplicationContext掃描指定包及其子包下的注解Bean:

當創建注解處理容器時,如果傳入的初始參數是注解Bean定義類所在的包時,注解容器將掃描給定的包及其子包,將掃描到的注解Bean定義載入並注冊。

(1).Spring中常用的注解:

 

a.Component注解:

1 @Target(ElementType.TYPE)  
2 @Retention(RetentionPolicy.RUNTIME)  
3 @Documented  
4 public @interface Component {  
5     String value() default "";  
6 }  

b.Service注解:

1 @Target({ElementType.TYPE})  
2 @Retention(RetentionPolicy.RUNTIME)  
3 @Documented  
4 @Component  
5 public @interface Service {  
6     String value() default "";  
7 }  

c.Controller注解:

1 @Target({ElementType.TYPE})  
2 @Retention(RetentionPolicy.RUNTIME)  
3 @Documented  
4 @Component  
5 public @interface Controller {  
6     String value() default "";  
7 }  

d.Repository注解:

1 @Target({ElementType.TYPE})  
2 @Retention(RetentionPolicy.RUNTIME)  
3 @Documented  
4 @Component  
5 public @interface Repository {  
6     String value() default "";  
7 }  

通過分析Spring這4個常用的注解源碼,我們看到:@Service、@Controller和@Repository注解都添加了一個@Component注解,因此他們都屬於@Component

注解。

(2).ClassPathBeanDefinitionScanner掃描給定的包及其子包:

AnnotationConfigApplicationContext通過調用類路徑Bean定義掃描器ClassPathBeanDefinitionScanner掃描給定包及其子包下的所有類,主要源碼如下:

 1 public class ClassPathBeanDefinitionScanner extends ClassPathScanningCandidateComponentProvider {  
 2 //創建一個類路徑Bean定義掃描器  
 3 public ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry) {  
 4         this(registry, true);  
 5     }  
 6 //為容器創建一個類路徑Bean定義掃描器,並指定是否使用默認的掃描過濾規則。  
 7 //即Spring默認掃描配置:@Component、@Repository、@Service、@Controller  
 8 //注解的Bean,同時也支持JavaEE6的@ManagedBean和JSR-330的@Named注解  
 9     public ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry, boolean useDefaultFilters) {  
10 //調用父類ClassPathScanningCandidateComponentProvider構造方法設置過濾規則  
11         super(useDefaultFilters);  
12         Assert.notNull(registry, "BeanDefinitionRegistry must not be null");  
13         //為容器設置加載Bean定義的注冊器  
14         this.registry = registry;  
15         //如果注冊器是資源加載器,則為容器設置資源加載器  
16         if (this.registry instanceof ResourceLoader) {  
17             setResourceLoader((ResourceLoader) this.registry);  
18         }  
19     }  
20 //調用類路徑Bean定義掃描器入口方法  
21 public int scan(String... basePackages) {  
22         //獲取容器中已經注冊的Bean個數  
23         int beanCountAtScanStart = this.registry.getBeanDefinitionCount();  
24         //啟動掃描器掃描給定包  
25         doScan(basePackages);  
26         //注冊注解配置(Annotation config)處理器  
27         if (this.includeAnnotationConfig) {  
28     AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry);  
29         }  
30         //返回注冊的Bean個數  
31         return this.registry.getBeanDefinitionCount() - beanCountAtScanStart;  
32     }  
33 //類路徑Bean定義掃描器掃描給定包及其子包  
34 protected Set<BeanDefinitionHolder> doScan(String... basePackages) {  
35         //創建一個集合,存放掃描到Bean定義的封裝類  
36         Set<BeanDefinitionHolder> beanDefinitions = new LinkedHashSet<BeanDefinitionHolder>();  
37         //遍歷掃描所有給定的包  
38         for (String basePackage : basePackages) {  
39             //調用父類ClassPathScanningCandidateComponentProvider的方法  
40 //掃描給定類路徑,獲取符合條件的Bean定義  
41             Set<BeanDefinition> candidates = findCandidateComponents(basePackage);  
42             //遍歷掃描到的Bean  
43             for (BeanDefinition candidate : candidates) {  
44                 //獲取Bean定義類中@Scope注解的值,即獲取Bean的作用域  
45                 ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate);  
46                 //為Bean設置注解配置的作用域  
47                 candidate.setScope(scopeMetadata.getScopeName());  
48                 //為Bean生成名稱  
49                 String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry);  
50             //如果掃描到的Bean不是Spring的注解Bean,則為Bean設置默認值,  
51 //設置Bean的自動依賴注入裝配屬性等  
52                 if (candidate instanceof AbstractBeanDefinition) {  
53                     postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName);  
54                 }  
55                 //如果掃描到的Bean是Spring的注解Bean,則處理其通用的Spring注解  
56                 if (candidate instanceof AnnotatedBeanDefinition) {  
57     //處理注解Bean中通用的注解,在分析注解Bean定義類讀取器時已經分析過  AnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate);  
58                 }  
59             //根據Bean名稱檢查指定的Bean是否需要在容器中注冊,或者在容器中沖突  
60 if (checkCandidate(beanName, candidate)) {  
61                     BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName);  
62                     //根據注解中配置的作用域,為Bean應用相應的代理模式  
63                     definitionHolder = AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);  
64                     beanDefinitions.add(definitionHolder);  
65                     //向容器注冊掃描到的Bean  
66                     registerBeanDefinition(definitionHolder, this.registry);  
67                 }  
68             }                         
69         }  
70         return beanDefinitions;  
71     }  
72 ……  
73 } 

類路徑Bean定義掃描器ClassPathBeanDefinitionScanner主要通過findCandidateComponents方法調用其父類ClassPathScanningCandidateComponentProvider類來掃描獲取給定包及其子包下的類。

(3).ClassPathScanningCandidateComponentProvider掃描給定包及其子包的類:

ClassPathScanningCandidateComponentProvider類的findCandidateComponents方法具體實現掃描給定類路徑包的功能,主要源碼如下:

  1 public class ClassPathScanningCandidateComponentProvider implements ResourceLoaderAware {  
  2 //保存過濾規則要包含的注解,即Spring默認的@Component、@Repository、@Service、//@Controller注解的Bean,以及JavaEE6的@ManagedBean和JSR-330的@Named注解  
  3 private final List<TypeFilter> includeFilters = new LinkedList<TypeFilter>();  
  4 //保存過濾規則要排除的注解  
  5 private final List<TypeFilter> excludeFilters = new LinkedList<TypeFilter>();  
  6 //構造方法,該方法在子類ClassPathBeanDefinitionScanner的構造方法中被調用  
  7 public ClassPathScanningCandidateComponentProvider(boolean useDefaultFilters) {  
  8         //如果使用Spring默認的過濾規則,則向容器注冊過濾規則  
  9         if (useDefaultFilters) {  
 10             registerDefaultFilters();  
 11         }  
 12     }  
 13 //向容器注冊過濾規則  
 14 protected void registerDefaultFilters() {  
 15 //向要包含的過濾規則中添加@Component注解類,注意Spring中@Repository  
 16 //@Service和@Controller都是Component,因為這些注解都添加了@Component注解  
 17         this.includeFilters.add(new AnnotationTypeFilter(Component.class));  
 18         //獲取當前類的類加載器  
 19         ClassLoader cl = ClassPathScanningCandidateComponentProvider.class.getClassLoader();  
 20         try {  
 21             //向要包含的過濾規則添加JavaEE6的@ManagedBean注解  
 22             this.includeFilters.add(new AnnotationTypeFilter(  
 23                     ((Class<? extends Annotation>) cl.loadClass("javax.annotation.ManagedBean")), false));  
 24             logger.info("JSR-250 'javax.annotation.ManagedBean' found and supported for component scanning");  
 25         }  
 26         catch (ClassNotFoundException ex) {  
 27             // JSR-250 1.1 API (as included in <a href="http://lib.csdn.net/base/java" class='replace_word' title="Java 知識庫" target='_blank' style='color:#df3434; font-weight:bold;'>Java </a>EE 6) not available - simply skip.  
 28         }  
 29         try {  
 30             //向要包含的過濾規則添加@Named注解  
 31             this.includeFilters.add(new AnnotationTypeFilter(  
 32                     ((Class<? extends Annotation>) cl.loadClass("javax.inject.Named")), false));  
 33             logger.info("JSR-330 'javax.inject.Named' annotation found and supported for component scanning");  
 34         }  
 35         catch (ClassNotFoundException ex) {  
 36             // JSR-330 API not available - simply skip.  
 37         }  
 38     }  
 39 //掃描給定類路徑的包  
 40 public Set<BeanDefinition> findCandidateComponents(String basePackage) {  
 41         //創建存儲掃描到的類的集合  
 42         Set<BeanDefinition> candidates = new LinkedHashSet<BeanDefinition>();  
 43         try {  
 44             //解析給定的包路徑,this.resourcePattern=” **/*.class”,  
 45     //ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX=“classpath:”  
 46     //resolveBasePackage方法將包名中的”.”轉換為文件系統的”/”  
 47             String packageSearchPath = ResourcePatternResolver.CLASSPATH_ALL_URL_PREFIX +  
 48                     resolveBasePackage(basePackage) + "/" + this.resourcePattern;  
 49             //將給定的包路徑解析為Spring資源對象  
 50             Resource[] resources = this.resourcePatternResolver.getResources(packageSearchPath);  
 51             boolean traceEnabled = logger.isTraceEnabled();  
 52             boolean debugEnabled = logger.isDebugEnabled();  
 53             //遍歷掃描到的資源  
 54             for (Resource resource : resources) {  
 55                 if (traceEnabled) {  
 56                     logger.trace("Scanning " + resource);  
 57                 }  
 58                 if (resource.isReadable()) {  
 59                     try {  
 60 //為指定資源獲取元數據讀取器,元信息讀取器通過匯編(ASM)讀//取資源元信息  
 61                         MetadataReader metadataReader = this.metadataReaderFactory.getMetadataReader(resource);  
 62                         //如果掃描到的類符合容器配置的過濾規則  
 63                         if (isCandidateComponent(metadataReader)) {  
 64                             //通過匯編(ASM)讀取資源字節碼中的Bean定義元信息  
 65                             ScannedGenericBeanDefinition sbd = new ScannedGenericBeanDefinition(metadataReader);  
 66                             //設置Bean定義來源於resource  
 67                             sbd.setResource(resource);  
 68                             //為元數據元素設置配置資源對象  
 69                             sbd.setSource(resource);  
 70                             //檢查Bean是否是一個可實例化的對象  
 71                             if (isCandidateComponent(sbd)) {  
 72                                 if (debugEnabled) {  
 73                                     logger.debug("Identified candidate component class: " + resource);  
 74                                 }  
 75                                 candidates.add(sbd);  
 76                             }  
 77                             else {  
 78                                 if (debugEnabled) {  
 79                                     logger.debug("Ignored because not a concrete top-level class: " + resource);  
 80                                 }  
 81                             }  
 82                         }  
 83                         else {  
 84                             if (traceEnabled) {  
 85                                 logger.trace("Ignored because not matching any filter: " + resource);  
 86                             }  
 87                         }  
 88                     }  
 89                     catch (Throwable ex) {  
 90                         throw new BeanDefinitionStoreException(  
 91                                 "Failed to read candidate component class: " + resource, ex);  
 92                     }  
 93                 }  
 94                 else {  
 95                     if (traceEnabled) {  
 96                         logger.trace("Ignored because not readable: " + resource);  
 97                     }  
 98                 }  
 99             }  
100         }  
101         catch (IOException ex) {  
102             throw new BeanDefinitionStoreException("I/O failure during classpath scanning", ex);  
103         }  
104         return candidates;  
105     }  
106 //判斷元信息讀取器讀取的類是否符合容器定義的注解過濾規則  
107 protected boolean isCandidateComponent(MetadataReader metadataReader) throws IOException {  
108         //如果讀取的類的注解在排除注解過濾規則中,返回false  
109         for (TypeFilter tf : this.excludeFilters) {  
110             if (tf.match(metadataReader, this.metadataReaderFactory)) {  
111                 return false;  
112             }  
113         }  
114         //如果讀取的類的注解在包含的注解的過濾規則中,則返回ture  
115         for (TypeFilter tf : this.includeFilters) {  
116             if (tf.match(metadataReader, this.metadataReaderFactory)) {  
117                 return true;  
118             }  
119         }  
120         //如果讀取的類的注解既不在排除規則,也不在包含規則中,則返回false  
121         return false;  
122     }  
123 ……  
124 }  

5.AnnotationConfigWebApplicationContext載入注解Bean定義:

AnnotationConfigWebApplicationContext是AnnotationConfigApplicationContext的Web版,它們對於注解Bean的注冊和掃描是基本相同的,但是AnnotationConfigWebApplicationContext對注解Bean定義的載入稍有不同,AnnotationConfigWebApplicationContext注入注解Bean定義源碼如下:

 1 //載入注解Bean定義資源  
 2 protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) {  
 3         //為容器設置注解Bean定義讀取器  
 4         AnnotatedBeanDefinitionReader reader = new AnnotatedBeanDefinitionReader(beanFactory);  
 5         //為容器設置類路徑Bean定義掃描器  
 6         ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(beanFactory);  
 7         //獲取容器的Bean名稱生成器  
 8         BeanNameGenerator beanNameGenerator = getBeanNameGenerator();  
 9         //獲取容器的作用域元信息解析器  
10         ScopeMetadataResolver scopeMetadataResolver = getScopeMetadataResolver();  
11         //為注解Bean定義讀取器和類路徑掃描器設置Bean名稱生成器  
12         if (beanNameGenerator != null) {  
13             reader.setBeanNameGenerator(beanNameGenerator);  
14             scanner.setBeanNameGenerator(beanNameGenerator);  
15         }  
16 //為注解Bean定義讀取器和類路徑掃描器設置作用域元信息解析器  
17         if (scopeMetadataResolver != null) {  
18             reader.setScopeMetadataResolver(scopeMetadataResolver);  
19             scanner.setScopeMetadataResolver(scopeMetadataResolver);  
20         }  
21         //獲取容器定義的Bean定義資源路徑  
22         String[] configLocations = getConfigLocations();  
23         //如果定位的Bean定義資源路徑不為空  
24         if (configLocations != null) {  
25             for (String configLocation : configLocations) {  
26                 try {  
27                     //使用當前容器的類加載器加載定位路徑的字節碼類文件  
28                     Class<?> clazz = getClassLoader().loadClass(configLocation);  
29                     if (logger.isInfoEnabled()) {  
30                         logger.info("Successfully resolved class for [" + configLocation + "]");  
31                     }  
32                     reader.register(clazz);  
33                 }  
34                 catch (ClassNotFoundException ex) {  
35                     if (logger.isDebugEnabled()) {  
36                         logger.debug("Could not load class for config location [" + configLocation +  
37                                 "] - trying package scan. " + ex);  
38                     }  
39                     //如果容器類加載器加載定義路徑的Bean定義資源失敗,則啟用  
40 //容器類路徑掃描器掃描給定路徑包及其子包中的類  
41                     int count = scanner.scan(configLocation);  
42                     if (logger.isInfoEnabled()) {  
43                         if (count == 0) {  
44                             logger.info("No annotated classes found for specified class/package [" + configLocation + "]");  
45                         }  
46                         else {  
47                             logger.info("Found " + count + " annotated classes in package [" + configLocation + "]");  
48                         }  
49                     }  
50                 }  
51             }  
52         }  
53     }  


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM