`

Spring对注解(Annotation)处理源码分析1——扫描和读取Bean定义

阅读更多

转自: http://blog.csdn.net/chjttony/article/details/6301523

 

 

 

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.aspx8以后的对于注解的简单介绍和前一篇博客中转载的对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以及EJBWebService相关的注解等,都是添加在类内部的字段或者方法上的类内部注解,SpringIoC容器通过Bean后置注解处理器解析Bean内部的注解。

下面将根据这两种处理策略,分别分析Spring处理注解相关的源码。

2.AnnotationConfigApplicationContext对注解Bean初始化:

Spring中,管理注解Bean定义的容器有两个:AnnotationConfigApplicationContext AnnotationConfigWebApplicationContex。这两个类是专门处理Spring注解方式配置的容器,直接依赖于注解作为容器配置信息来源的IoC容器。 AnnotationConfigWebApplicationContextAnnotationConfigApplicationContextweb版本,两者的用法以及对注解的处理方式几乎没有什么差别,因此本文将以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定义读取器AnnotatedBeanDefinitionReaderregister方法向容器注册指定的注解Bean,注解Bean定义读取器向容器注册注解Bean的源码如下:

 

[java] view plain copy
 
  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的封装的数据结构  
  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,使用AnnotationConfigUtilsprocessCommonDefinitionAnnotations方法处理注解Bean定义类中通用的注解。

c,使用AnnotationConfigUtilsapplyScopedProxyMode方法创建对于作用域的代理对象。

d,通过BeanDefinitionReaderUtils向容器注册Bean

下面我们继续分析这3步的具体实现过程

(2).AnnotationScopeMetadataResolver解析作用域元数据:

AnnotationScopeMetadataResolver通过processCommonDefinitionAnnotations方法解析注解Bean定义类的作用域元信息,即判断注册的Bean是原生类型(prototype)还是单态(singleton)类型,其源码如下:

 

[java] view plain copy
 
  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注解进行处理,源码如下:

 

[java] view plain copy
 
  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)中使用。源码如下:

 

[java] view plain copy
 
  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注解:

 

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

 

 

 

b.Service注解:

 

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

 

 

 

c.Controller注解:

 

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

 

 

d.Repository注解:

 

 

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

 

 

 

通过分析Spring4个常用的注解源码,我们看到:@Service@Controller@Repository注解都添加了一个@Component注解,因此他们都属于@Component

注解。

(2).ClassPathBeanDefinitionScanner扫描给定的包及其子包:

AnnotationConfigApplicationContext通过调用类路径Bean定义扫描器ClassPathBeanDefinitionScanner扫描给定包及其子包下的所有类,主要源码如下:

 

[java] view plain copy
 
  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方法具体实现扫描给定类路径包的功能,主要源码如下:

 

[java] view plain copy
 
  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 Java 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定义:

AnnotationConfigWebApplicationContextAnnotationConfigApplicationContextWeb版,它们对于注解Bean的注册和扫描是基本相同的,但是AnnotationConfigWebApplicationContext对注解Bean定义的载入稍有不同,AnnotationConfigWebApplicationContext注入注解Bean定义源码如下:

 

[java] view plain copy
 
  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.     }  

 

分享到:
评论

相关推荐

    spring的Annotation注解.

    Annotation是一种元数据,允许开发者在代码中嵌入额外的信息,Spring则能够读取这些信息来实现其功能,如自动装配Bean、定义切点和通知等。 #### 二、Annotation在Spring中的应用 ##### 1. `@Autowired`与依赖注入...

    自定义注解得使用,模拟spring通过注解方式创建bean实例

    注解是一种元数据,它提供了在源代码中添加信息的方式,这些信息可以被编译器或运行时环境读取和处理。自定义注解允许我们创建自己的标记,用于特定目的,比如代码分析、验证、依赖注入等。 要创建自定义注解,我们...

    spring中注解的实现原理

    Spring注解的处理主要由两部分组成:元注解和注解处理器。元注解是用于创建其他注解的注解,如`@Target`、`@Retention`、`@Documented`和`@Inherited`,它们定义了注解的使用位置、生命周期、是否出现在Javadoc中...

    Spring java注解,元注解和自定义注解

    注解本身并不改变程序的行为,但它可以通过工具或编译器被读取和处理,从而影响到程序的编译、运行等阶段。 #### 二、Spring中的Java注解 Spring框架充分利用了Java注解的功能,简化了配置过程,并提供了许多内置...

    扩展Spring—使用Annotation将配置资源注入到Bean中

    在Spring框架中,注解(Annotation)的使用极大地简化了传统XML配置的复杂性,使得开发者可以更加专注于业务逻辑的实现。本篇文章将深入探讨如何通过注解将配置资源注入到Bean中,以此来理解Spring的注解驱动开发。 ...

    spring 5.2.9 07 源码分析-spring的bean工厂准备工作 测试用例

    `BeanDefinitionReader`用于读取Bean定义,如XML、Java注解或Groovy脚本等形式,将其转化为`BeanDefinition`对象。`BeanDefinition`封装了Bean的所有元数据,如类名、属性、依赖关系等。`BeanDefinitionRegistry`则...

    Spring Annotation (注解)详解

    - **利用反射** - Spring通过反射机制读取注解信息,自动处理Bean的创建和依赖注入,减少了手动配置的工作量。 5. **传统XML配置与注解配置** - 在没有注解之前,我们需要在XML配置文件中显式定义Bean及它们的依赖...

    Spring技术内幕 学习笔记

    它涵盖了Spring的组件扫描机制,如何识别和处理类上的注解,以及注解驱动的配置如何转换为Bean定义。 2. **IoC容器解析Bean定义资源并注册解析后的Bean**: - 这部分深入到Spring的IoC(Inversion of Control)...

    Spring IOC Annotation 注入 学习实例

    Spring IOC(Inversion of Control,控制反转)是Spring框架的核心特性,它将对象的创建和管理权交给了Spring容器,从而...通过对这些文件的分析和学习,你可以掌握如何在实际项目中应用Spring的IOC和注解注入技术。

    Spring注解驱动开发实战-annotation

    Spring注解的主要目的是减少XML配置,使得代码更加简洁、可读性更强。本文将深入探讨Spring注解驱动开发中的关键概念,包括组件注册、生命周期管理和自动装配。 一、组件注册 在传统的Spring配置中,我们需要在XML...

    3Spring使用annotation方式autowire

    在开发过程中,IDE如IntelliJ IDEA和Eclipse等提供了强大的Spring注解支持。它们可以自动检测并提示注解的使用,同时提供代码补全,帮助开发者快速构建基于注解的Spring应用。 ### 结论 Spring的注解驱动自动装配...

    spring源码

    源码中可以学习到Spring如何扫描和解析这些注解,以及如何将注解驱动的切面转换为实际的代理逻辑。 `spring_aop_xml`这部分源码展示的是基于XML配置的AOP。虽然现在更多地使用注解来定义切面,但在早期的Spring版本...

    详解Spring基于Annotation的依赖注入实现

    注解是Java SE 5引入的一种元数据机制,允许在代码中嵌入额外的信息,这些信息可以被编译器、JVM或者第三方工具(如Spring框架)读取和处理。注解通常用于向编译器或运行时环境提供有关程序结构或行为的元数据,比如...

    Java Bean 遍历和使用注解给Bean的属性添加属性值

    - **Spring Framework**:Spring提供了`org.springframework.beans.BeanWrapper`和`org.springframework.beans.PropertyAccessor`接口,简化了对Bean的操作,包括注解的处理。 在实际开发中,遍历Java Bean和利用...

    spring4注解

    #### 二、Spring注解图示与分类 ##### 2.1 Spring-Context 模块的注解图 - **@Component**: 用于标记任何Java类作为Spring中的一个组件。该注解通常配合`&lt;context:component-scan&gt;`使用,以便Spring能够自动检测和...

    注解(Annotation)的定义及使用

    在Java编程语言中,注解(Annotation)是一种元数据,它提供了一种安全的方法来将信息附加到代码中,而不必改变代码的行为。注解在软件开发中扮演着重要的角色,尤其是在编译器检查、代码分析、依赖注入、持久化等...

    Java 注解Annotation实例上手文档

    ### Java 注解Annotation实例上手文档 #### 一、引言与基础知识 Java注解(Annotation)自JDK 5.0引入以来,已经成为Java语言的重要特性之一,它为代码元数据提供了一种标准化的方式,使得编译器、工具和其他框架...

    Spring中常用注解

    在Java开发领域,Spring框架以其强大的功能和灵活的配置闻名,而注解(Annotation)是Spring框架中的一个重要组成部分,极大地简化了代码的编写和维护。本文将深入探讨Spring框架中的一些常用注解,并通过实例来解析...

    spring注解完整版.doc

    在实际项目中,结合源码阅读和实践操作,能进一步提升对Spring注解的理解和运用能力。对于开发者而言,掌握Spring注解无疑会提升开发效率,增强代码的可维护性,从而在IT行业中立足并持续发展。

    springAnnotation.zip

    本文将深入探讨Spring注解以及相关的源码分析,包括Spring MVC的部分。 首先,让我们了解Spring中的核心注解: 1. `@Component`:这是所有Spring组件的基础注解,用于标记一个类为Spring管理的bean。子注解如`@...

Global site tag (gtag.js) - Google Analytics