聊聊Spring这三个注解的故事

环境

  • JDk8
  • Spring Boot 1.5.8
  • IntelliJ Idea 14.1.7

What is this annotation

  1. @ Configuration
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Configuration {
    String value() default "";
}
  1. @ Bean
@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Bean {
    @AliasFor("name")
    String[] value() default {};

    @AliasFor("value")
    String[] name() default {};

    Autowire autowire() default Autowire.NO;

    String initMethod() default "";

    String destroyMethod() default AbstractBeanDefinition.INFER_METHOD;

}

  1. @ ConfigurationProperties
@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ConfigurationProperties {
    @AliasFor("prefix")
    String value() default "";

    @AliasFor("value")
    String prefix() default "";

    boolean ignoreInvalidFields() default false;

    boolean ignoreNestedProperties() default false;

    boolean ignoreUnknownFields() default true;

    @Deprecated
    boolean exceptionIfInvalid() default true;

}

How to use this annotation

//标识应用中的配置类(相当于xxx.xml)
 @Configuration
 public class AppConfig {

     @Bean
     public MyBean myBean(CanalConfig config) {
         // instantiate, configure and return bean ...
     }
 }
//application.yml配置文件中定义配置canal.config属性值
@ConfigurationProperties(prefix = "canal.config")
@Component
public class CanalConfig {
...
}

Why these can work

  1. 简化XML配置,IOC配置从文件配置转向Java文件配置,通常以*Config命名此类Java类,如AppConfig等
  2. AnnotationConfigApplicationContext
    • @ Configuration
    • @ Bean(注入时可自动引用已有bean)
  3. Spring容器会解析@ Bean注解方法,并注册方法返回实例对象到容器中,默认以方法名命名。
  4. @ Bean中定义的属性名与XML的<bean/>标签对应
  5. 看下AnnotationConfigApplicationContext源码:
  • AnnotationConfigApplicationContext(Class<?>... annotatedClasses):
    这是最常用的构造函数,通过将涉及到的配置类传递给该构造函数,以实现将相应配置类中的 Bean 自动注册到容器中。
  • AnnotationConfigApplicationContext(String... basePackages):该构造函数会自动扫描以给定的包及其子包下的所有类,并自动识别所有的 Spring Bean,将其注册到容器中。它不但识别标注 @ Configuration的配置类并正确解析,而且同样能识别使用 @ Repository、@ Service、@ Controller、@ Component 标注的类。
public class AnnotationConfigApplicationContext extends GenericApplicationContext implements AnnotationConfigRegistry {
...
    public AnnotationConfigApplicationContext(Class<?>... annotatedClasses) {
        this();
        register(annotatedClasses);
        refresh();
    }

    public AnnotationConfigApplicationContext(String... basePackages) {
        this();
        scan(basePackages);
        refresh();
    }
...
    public void scan(String... basePackages) {
        Assert.notEmpty(basePackages, "At least one base package must be specified");
        this.scanner.scan(basePackages);
    }
}

  • Spring Boot加载Bean流程

    • main()
      • SpringApplication
        • run()
          • createApplicationContext()
          • prepareContext
          • refreshContext()
            • AbstractApplicationContext --> refresh()
              • finishBeanFactoryInitialization()
                • beanFactory.preInstantiateSingletons()
                  • AbstractBeanFactory->getBean()
                  • AbstractBeanFactory->doGetBean()
                    • AbstractAutowireCapableBeanFactory->createBean()
                      - AbstractAutowireCapableBeanFactory->doCreateBean
                      - AbstractAutowireCapableBeanFactory->registerDisposableBeanIfNecessary()
                      - afterRefresh()
  • 部分源码

public class SpringApplication {
    public static final String DEFAULT_CONTEXT_CLASS = "org.springframework.context."
            + "annotation.AnnotationConfigApplicationContext";

    public static final String DEFAULT_WEB_CONTEXT_CLASS = "org.springframework."
            + "boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext";

...
//run方法就是Spring加载的入口,也是一切的起点
public ConfigurableApplicationContext run(String... args) {
    context = createApplicationContext();
    analyzers = new FailureAnalyzers(context);
    prepareContext(context, environment, listeners, applicationArguments,
            printedBanner);
    refreshContext(context);
    afterRefresh(context, applicationArguments);
    listeners.finished(context, null);

}
...

Conclusion

注解是用来标识对象的一种方式,如同接口的出现,是为后续进行逻辑处理提供判读依据。编程方式日新月异,本质上,编程思想并没有改变。谨记,注解就是一种标识这一点,理解种种注解也就如探囊取物了。依托,Spring的IOC机制,注解也如虎添翼,SpringBoot+注解成为又一开发利器。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 121,117评论 16 134
  • 一个不小心又快到十二点了,全新的一天即将来临,每天都在感受着时间一点一点的飞逝,这种感觉既恐慌又无能为力,...
    菇凉是个爷阅读 56评论 0 0
  • David 老师说,通过Yogaworks300小时专业瑜伽教师培训,不是要使我们寻找到更多的正确答案,而是要帮助...
    禄丽荣阅读 168评论 0 0
  • 读吴军老师的这篇文章时,感觉后背发凉,由于人工智能的存在,那些拥有我们隐私的人真的把我们看得透透的,没有隐私太可怕...
    25f1ef052e12阅读 93评论 0 0