1.從SPRing2.0以后的版本中，spring也引入了基于注解(Annotation)方式的配置，注解(Annotation)是JDK1.5中引入的一個新特性，用于簡化Bean的配置，某些場合可以取代xml配置文件。開發人員對注解(Annotation)的態度也是蘿卜青菜各有所愛，個人認為注解可以大大簡化配置，提高開發速度，同時也不能完全取代XML配置方式，XML 方式更加靈活，并且發展的相對成熟，這種配置方式為大多數 Spring 開發者熟悉；注解方式使用起來非常簡潔，但是尚處于發展階段，XML配置文件和注解(Annotation)可以相互配合使用。
應某些人員的要求，本文章就分析Spring對注解(Annotation)的解析過程，如果你對注解還不熟悉，請參考：http://blog.csdn.net/chjttony/archive/2010/11/22/6026079.aspx中8以后的對于注解的簡單介紹和前一篇博客中轉載的對Spring注解基本知識介紹：http://blog.csdn.net/chjttony/archive/2011/03/29/6286144.aspx.
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的源碼如下：
[java] view plain copypublic class AnnotationConfigApplicationContext extends GenericApplicationContext { //創建一個讀取注解的Bean定義讀取器，并將其設置到容器中 private final AnnotatedBeanDefinitionReader reader = new AnnotatedBeanDefinitionReader(this); //創建一個掃描指定類路徑中注解Bean定義的掃描器，并將其設置到容器中 private final ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(this); //默認構造函數，初始化一個空容器，容器不包含任何 Bean 信息，需要在稍后通過調用其register() //方法注冊配置類，并調用refresh()方法刷新容器，觸發容器對注解Bean的載入、解析和注冊過程 public AnnotationConfigApplicationContext() { } //最常用的構造函數，通過將涉及到的配置類傳遞給該構造函數，以實現將相應配置類中的Bean //自動注冊到容器中 public AnnotationConfigApplicationContext(Class<?>... annotatedClasses) { register(annotatedClasses); refresh(); } //該構造函數會自動掃描以給定的包及其子包下的所有類，并自動識別所有的Spring Bean，將其 //注冊到容器中 public AnnotationConfigApplicationContext(String... basePackages) { scan(basePackages); refresh(); } //為容器的注解Bean讀取器和注解Bean掃描器設置Bean名稱產生器 public void setBeanNameGenerator(BeanNameGenerator beanNameGenerator) { this.reader.setBeanNameGenerator(beanNameGenerator); this.scanner.setBeanNameGenerator(beanNameGenerator); } //為容器的注解Bean讀取器和注解Bean掃描器設置作用范圍元信息解析器 public void setScopeMetadataResolver(ScopeMetadataResolver scopeMetadataResolver) { this.reader.setScopeMetadataResolver(scopeMetadataResolver); this.scanner.setScopeMetadataResolver(scopeMetadataResolver); } //為容器注冊一個要被處理的注解Bean，新注冊的Bean，必須手動調用容器的 //refresh()方法刷新容器，觸發容器對新注冊的Bean的處理 public void register(Class<?>... annotatedClasses) { this.reader.register(annotatedClasses); } //掃描指定包路徑及其子包下的注解類，為了使新添加的類被處理，必須手動調用 //refresh()方法刷新容器 public void scan(String... basePackages) { this.scanner.scan(basePackages); } }通過對AnnotationConfigApplicationContext的源碼分析，我們了解到Spring對注解的處理分為兩種方式：
(1).直接將注解Bean注冊到容器中：
可以在初始化容器時注冊；也可以在容器創建之后手動調用注冊方法向容器注冊，然后通過手動刷新容器，使得容器對注冊的注解Bean進行處理。
(2).通過掃描指定的包及其子包下的所有類：
在初始化注解容器時指定要自動掃描的路徑，如果容器創建以后向給定路徑動態添加了注解Bean，則需要手動調用容器掃描的方法，然后手動刷新容器，使得容器對所注冊的Bean進行處理。
接下來，將會對兩種處理方式詳細分析其實現過程。
3.AnnotationConfigApplicationContext注冊注解Bean：
當創建注解處理容器時，如果傳入的初始參數是具體的注解Bean定義類時，注解容器讀取并注冊。
(1).AnnotationConfigApplicationContext通過調用注解Bean定義讀取器AnnotatedBeanDefinitionReader的register方法向容器注冊指定的注解Bean，注解Bean定義讀取器向容器注冊注解Bean的源碼如下：
[java] view plain copy//注冊多個注解Bean定義類 public void register(Class<?>... annotatedClasses) { for (Class<?> annotatedClass : annotatedClasses) { registerBean(annotatedClass); } } //注冊一個注解Bean定義類 public void registerBean(Class<?> annotatedClass) { registerBean(annotatedClass, null, (Class<? extends Annotation>[]) null); } //Bean定義讀取器注冊注解Bean定義的入口方法 public void registerBean(Class<?> annotatedClass, Class<? extends Annotation>... qualifiers) { registerBean(annotatedClass, null, qualifiers); } //Bean定義讀取器向容器注冊注解Bean定義類 public void registerBean(Class<?> annotatedClass, String name, Class<? extends Annotation>... qualifiers) { //根據指定的注解Bean定義類，創建Spring容器中對注解Bean的封裝的<a href="http://lib.csdn.net/base/datastructure" class='replace_Word' title="算法與數據結構知識庫" target='_blank' style='color:#df3434; font-weight:bold;'>數據結構</a> AnnotatedGenericBeanDefinition abd = new AnnotatedGenericBeanDefinition(annotatedClass); //解析注解Bean定義的作用域，若@Scope("prototype")，則Bean為原型類型； //若@Scope("singleton")，則Bean為單態類型 ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(abd); //為注解Bean定義設置作用域 abd.setScope(scopeMetadata.getScopeName()); //為注解Bean定義生成Bean名稱 String beanName = (name != null ? name : this.beanNameGenerator.generateBeanName(abd, this.registry)); //處理注解Bean定義中的通用注解 AnnotationConfigUtils.processCommonDefinitionAnnotations(abd); //如果在向容器注冊注解Bean定義時，使用了額外的限定符注解，則解析限定符注解。 //主要是配置的關于autowiring自動依賴注入裝配的限定條件，即@Qualifier //注解，Spring自動依賴注入裝配默認是按類型裝配，如果使用@Qualifier則按名稱 if (qualifiers != null) { for (Class<? extends Annotation> qualifier : qualifiers) { //如果配置了@Primary注解，設置該Bean為autowiring自動依賴注入裝//配時的首選 if (Primary.class.equals(qualifier)) { abd.setPrimary(true); } //如果配置了@Lazy注解，則設置該Bean為非延遲初始化，如果沒有配置， //則該Bean為預實例化 else if (Lazy.class.equals(qualifier)) { abd.setLazyInit(true); } //如果使用了除@Primary和@Lazy以外的其他注解，則為該Bean添加一 //個autowiring自動依賴注入裝配限定符，該Bean在進autowiring //自動依賴注入裝配時，根據名稱裝配限定符指定的Bean else { abd.addQualifier(new AutowireCandidateQualifier(qualifier)); } } } //創建一個指定Bean名稱的Bean定義對象，封裝注解Bean定義類數據 BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(abd, beanName); //根據注解Bean定義類中配置的作用域，創建相應的代理對象 definitionHolder = AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry); //向IoC容器注冊注解Bean類定義對象 BeanDefinitionReaderUtils.registerBeanDefinition(definitionHolder, this.registry); }
從上面的源碼我們可以看出，注冊注解Bean定義類的基本步驟：
a，需要使用注解元數據解析器解析注解Bean中關于作用域的配置。
b，使用AnnotationConfigUtils的processCommonDefinitionAnnotations方法處理注解Bean定義類中通用的注解。
c，使用AnnotationConfigUtils的applyScopedProxyMode方法創建對于作用域的代理對象。
d，通過BeanDefinitionReaderUtils向容器注冊Bean。
下面我們繼續分析這3步的具體實現過程
(2).AnnotationScopeMetadataResolver解析作用域元數據：
AnnotationScopeMetadataResolver通過processCommonDefinitionAnnotations方法解析注解Bean定義類的作用域元信息，即判斷注冊的Bean是原生類型(prototype)還是單態(singleton)類型，其源碼如下：
[java] view plain copy//解析注解Bean定義類中的作用域元信息 public ScopeMetadata resolveScopeMetadata(BeanDefinition definition) { ScopeMetadata metadata = new ScopeMetadata(); if (definition instanceof AnnotatedBeanDefinition) { AnnotatedBeanDefinition annDef = (AnnotatedBeanDefinition) definition; //從注解Bean定義類的屬性中查找屬性為”Scope”的值，即@Scope注解的值 // annDef.getMetadata().getAnnotationAttributes方法將Bean //中所有的注解和注解的值存放在一個map集合中 Map<String, Object> attributes = annDef.getMetadata().getAnnotationAttributes(this.scopeAnnotationType.getName()); //將獲取到的@Scope注解的值設置到要返回的對象中 if (attributes != null) { metadata.setScopeName((String) attributes.get("value")); //獲取@Scope注解中的proxyMode屬性值，在創建代理對象時會用到 ScopedProxyMode proxyMode = (ScopedProxyMode) attributes.get("proxyMode"); //如果@Scope的proxyMode屬性值為null、DEFAULT或者NO if (proxyMode == null || proxyMode == ScopedProxyMode.DEFAULT) { //設置proxyMode為NO proxyMode = this.defaultProxyMode; } //為返回的元數據設置proxyMode metadata.setScopedProxyMode(proxyMode); } } //返回解析的作用域元信息對象 return metadata; }
上述代碼中的annDef.getMetadata().getAnnotationAttributes方法就是獲取對象中指定類型的注解的值。
(3).AnnotationConfigUtils處理注解Bean定義類中的通用注解：
AnnotationConfigUtils類的processCommonDefinitionAnnotations在向容器注冊Bean之前，首先對注解Bean定義類中的通用Spring注解進行處理，源碼如下：
[java] view plain copy//處理Bean定義中通用注解 static void processCommonDefinitionAnnotations(AnnotatedBeanDefinition abd) { //如果Bean定義中有@Primary注解，則為該Bean設置為autowiring自動依賴注入//裝配的首選對象 if (abd.getMetadata().isAnnotated(Primary.class.getName())) { abd.setPrimary(true); } //如果Bean定義中有@Lazy注解，則將該Bean預實例化屬性設置為@lazy注解的值 if (abd.getMetadata().isAnnotated(Lazy.class.getName())) { Boolean value = (Boolean) abd.getMetadata().getAnnotationAttributes(Lazy.class.getName()).get("value"); abd.setLazyInit(value); } //如果Bean定義中有@ DependsOn注解，則為該Bean設置所依賴的Bean名稱， //容器將確保在實例化該Bean之前首先實例化所依賴的Bean if (abd.getMetadata().isAnnotated(DependsOn.class.getName())) { String[] value = (String[]) abd.getMetadata().getAnnotationAttributes(DependsOn.class.getName()).get("value"); abd.setDependsOn(value); } }
(4).AnnotationConfigUtils根據注解Bean定義類中配置的作用域為其應用相應的代理策略：
AnnotationConfigUtils類的applyScopedProxyMode方法根據注解Bean定義類中配置的作用域@Scope注解的值，為Bean定義應用相應的代理模式，主要是在Spring面向切面編程(AOP)中使用。源碼如下：
[java] view plain copy//根據作用域為Bean應用引用的代碼模式 static BeanDefinitionHolder applyScopedProxyMode( ScopeMetadata metadata, BeanDefinitionHolder definition, BeanDefinitionRegistry registry) { //獲取注解Bean定義類中@Scope注解的proxyMode屬性值 ScopedProxyMode scopedProxyMode = metadata.getScopedProxyMode(); //如果配置的@Scope注解的proxyMode屬性值為NO，則不應用代理模式 if (scopedProxyMode.equals(ScopedProxyMode.NO)) { return definition; } //獲取配置的@Scope注解的proxyMode屬性值，如果為TARGET_CLASS，則返 //回true，如果為INTERFACES，則返回false boolean proxyTargetClass = scopedProxyMode.equals(ScopedProxyMode.TARGET_CLASS); //為注冊的Bean創建相應模式的代理對象 return ScopedProxyCreator.createScopedProxy(definition, registry, proxyTargetClass); }
這段為Bean引用創建相應模式的代理，如果在Spring面向切面編程(AOP)中涉及到再詳細分析，這里不做深入的分析。
(5).BeanDefinitionReaderUtils向容器注冊Bean：
BeanDefinitionReaderUtils向容器注冊載入的Bean我們在第4篇博客中已經分析過，主要是校驗Bean定義，然后將Bean添加到容器中一個管理Bean定義的HashMap中，這里就不做分析。
4.AnnotationConfigApplicationContext掃描指定包及其子包下的注解Bean：
當創建注解處理容器時，如果傳入的初始參數是注解Bean定義類所在的包時，注解容器將掃描給定的包及其子包，將掃描到的注解Bean定義載入并注冊。
(1).Spring中常用的注解：
a.Component注解：
[java] view plain copy@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface Component { String value() default ""; }
b.Service注解：
[java] view plain copy@Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented @Component public @interface Service { String value() default ""; }
c.Controller注解：
[java] view plain copy@Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented @Component public @interface Controller { String value() default ""; }
d.Repository注解：
[java] view plain copy@Target({ElementType.TYPE}) @Retention(RetentionPolicy.RUNTIME) @Documented @Component public @interface Repository { String value() default ""; }
通過分析Spring這4個常用的注解源碼，我們看到：@Service、@Controller和@Repository注解都添加了一個@Component注解，因此他們都屬于@Component
注解。
(2).ClassPathBeanDefinitionScanner掃描給定的包及其子包：
AnnotationConfigApplicationContext通過調用類路徑Bean定義掃描器ClassPathBeanDefinitionScanner掃描給定包及其子包下的所有類，主要源碼如下：
[java] view plain copypublic class ClassPathBeanDefinitionScanner extends ClassPathScanningCandidateComponentProvider { //創建一個類路徑Bean定義掃描器 public ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry) { this(registry, true); } //為容器創建一個類路徑Bean定義掃描器，并指定是否使用默認的掃描過濾規則。 //即Spring默認掃描配置：@Component、@Repository、@Service、@Controller //注解的Bean，同時也支持JavaEE6的@ManagedBean和JSR-330的@Named注解 public ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry, boolean useDefaultFilters) { //調用父類ClassPathScanningCandidateComponentProvider構造方法設置過濾規則 super(useDefaultFilters); Assert.notNull(registry, "BeanDefinitionRegistry must not be null"); //為容器設置加載Bean定義的注冊器 this.registry = registry; //如果注冊器是資源加載器，則為容器設置資源加載器 if (this.registry instanceof ResourceLoader) { setResourceLoader((ResourceLoader) this.registry); } } //調用類路徑Bean定義掃描器入口方法 public int scan(String... basePackages) { //獲取容器中已經注冊的Bean個數 int beanCountAtScanStart = this.registry.getBeanDefinitionCount(); //啟動掃描器掃描給定包 doScan(basePackages); //注冊注解配置(Annotation config)處理器 if (this.includeAnnotationConfig) { AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry); } //返回注冊的Bean個數 return this.registry.getBeanDefinitionCount() - beanCountAtScanStart; } //類路徑Bean定義掃描器掃描給定包及其子包 protected Set<BeanDefinitionHolder> doScan(String... basePackages) { //創建一個集合，存放掃描到Bean定義的封裝類 Set<BeanDefinitionHolder> beanDefinitions = new LinkedHashSet<BeanDefinitionHolder>(); //遍歷掃描所有給定的包 for (String basePackage : basePackages) { //調用父類ClassPathScanningCandidateComponentProvider的方法 //掃描給定類路徑，獲取符合條件的Bean定義 Set<BeanDefinition> candidates = findCandidateComponents(basePackage); //遍歷掃描到的Bean for (BeanDefinition candidate : candidates) { //獲取Bean定義類中@Scope注解的值，即獲取Bean的作用域 ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate); //為Bean設置注解配置的作用域 candidate.setScope(scopeMetadata.getScopeName()); //為Bean生成名稱 String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry); //如果掃描到的Bean不是Spring的注解Bean，則為Bean設置默認值， //設置Bean的自動依賴注入裝配屬性等 if (candidate instanceof AbstractBeanDefinition) { postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName); } //如果掃描到的Bean是Spring的注解Bean，則處理其通用的Spring注解 if (candidate instanceof AnnotatedBeanDefinition) { //處理注解Bean中通用的注解，在分析注解Bean定義類讀取器時已經分析過 AnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate); } //根據Bean名稱檢查指定的Bean是否需要在容器中注冊，或者在容器中沖突 if (checkCandidate(beanName, candidate)) { BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName); //根據注解中配置的作用域，為Bean應用相應的代理模式 definitionHolder = AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry); beanDefinitions.add(definitionHolder); //向容器注冊掃描到的Bean registerBeanDefinition(definitionHolder, this.registry); } } } return beanDefinitions; } …… }
類路徑Bean定義掃描器ClassPathBeanDefinitionScanner主要通過findCandidateComponents方法調用其父類ClassPathScanningCandidateComponentProvider類來掃描獲取給定包及其子包下的類。
(3).ClassPathScanningCandidateComponentProvider掃描給定包及其子包的類：
ClassPathScanningCandidateComponentProvider類的findCandidateComponents方法具體實現掃描給定類路徑包的功能，主要源碼如下：
[java] view plain copypublic class ClassPathScanningCandidateComponentProvider implements ResourceLoaderAware { //保存過濾規則要包含的注解，即Spring默認的@Component、@Repository、@Service、//@Controller注解的Bean，以及JavaEE6的@ManagedBean和JSR-330的@Named注解 private final List<TypeFilter> includeFilters = new LinkedList<TypeFilter>(); //保存過濾規則要排除的注解 private final List<TypeFilter> excludeFilters = new LinkedList<TypeFilter>(); //構造方法，該方法在子類ClassPathBeanDefinitionScanner的構造方法中被調用 public ClassPathScanningCandidateComponentProvider(boolean useDefaultFilters) { //如果使用Spring默認的過濾規則，則向容器注冊過濾規則 if (useDefaultFilters) { registerDefaultFilters(); } } //向容器注冊過濾規則 protected void registerDefaultFilters() { //向要包含的過濾規則中添加@Component注解類，注意Spring中@Repository //@Service和@Controller都是Component，因為這些注解都添加了@Component注解 this.includeFilters.add(new AnnotationTypeFilter(Component.class)); //獲取當前類的類加載器 ClassLoader cl = ClassPathScanningCandidateComponentProvider.class.getClassLoader(); try { //向要包含的過濾規則添加JavaEE6的@ManagedBean注解 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 <a href="http://lib.csdn.net/base/javaee" class='replace_word' title="Java EE知識庫" target='_blank' style='color:#df3434; font-weight:bold;'>Java EE</a> 6) not available - simply sk5.AnnotationConfigWebApplicationContext載入注解Bean定義：
AnnotationConfigWebApplicationContext是AnnotationConfigApplicationContext的Web版，它們對于注解Bean的注冊和掃描是基本相同的，但是AnnotationConfigWebApplicationContext對注解Bean定義的載入稍有不同，AnnotationConfigWebApplicationContext注入注解Bean定義源碼如下：
[java] view plain copy//載入注解Bean定義資源 protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) { //為容器設置注解Bean定義讀取器 AnnotatedBeanDefinitionReader reader = new AnnotatedBeanDefinitionReader(beanFactory); //為容器設置類路徑Bean定義掃描器 ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(beanFactory); //獲取容器的Bean名稱生成器 BeanNameGenerator beanNameGenerator = getBeanNameGenerator(); //獲取容器的作用域元信息解析器 ScopeMetadataResolver scopeMetadataResolver = getScopeMetadataResolver(); //為注解Bean定義讀取器和類路徑掃描器設置Bean名稱生成器 if (beanNameGenerator != null) { reader.setBeanNameGenerator(beanNameGenerator); scanner.setBeanNameGenerator(beanNameGenerator); } //為注解Bean定義讀取器和類路徑掃描器設置作用域元信息解析器 if (scopeMetadataResolver != null) { reader.setScopeMetadataResolver(scopeMetadataResolver); scanner.setScopeMetadataResolver(scopeMetadataResolver); } //獲取容器定義的Bean定義資源路徑 String[] configLocations = getConfigLocations(); //如果定位的Bean定義資源路徑不為空 if (configLocations != null) { for (String configLocation : configLocations) { try { //使用當前容器的類加載器加載定位路徑的字節碼類文件 Class<?> clazz = getClassLoader().loadClass(configLocation); if (logger.isInfoEnabled()) { logger.info("Successfully resolved class for [" + configLocation + "]"); } reader.register(clazz); } catch (ClassNotFoundException ex) { if (logger.isDebugEnabled()) { logger.debug("Could not load class for config location [" + configLocation + "] - trying package scan. " + ex); } //如果容器類加載器加載定義路徑的Bean定義資源失敗，則啟用 //容器類路徑掃描器掃描給定路徑包及其子包中的類 int count = scanner.scan(configLocation); if (logger.isInfoEnabled()) { if (count == 0) { logger.info("No annotated classes found for specified class/package [" + configLocation + "]"); } else { logger.info("Found " + count + " annotated classes in package [" + configLocation + "]"); } } } } } }
新聞熱點
疑難解答
