一、前言

大部分的配置都可以用Java类+注解来代替,而在SpringBoot项目中见的最多的莫过于@SpringBootApplication注解了,它在每个SpringBoot的启动类上都有标注。

这个注解对SpringBoot的启动和自动配置到底有什么样的影响呢?本文将为各位大佬解析它的源码,揭开@SpringBootApplication注解神秘的面纱。

二、正文

对SpringBoot工程的自动配置很感兴趣,于是学习其源码并整理了其中一些内容,如果有错误请大家指正~话不多说,直接上源码;

@SpringBootApplication注解的源码如下:

  1. @Target(ElementType.TYPE)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. @Inherited
  5. @SpringBootConfiguration
  6. @EnableAutoConfiguration
  7. @ComponentScan(excludeFilters = {
  8. @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
  9. @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
  10. public @interface SpringBootApplication {
  11. ...
  12. }

可以看到这是一个复合注解,一共包括7个不同的注解,下面对这7个不同的注解进行分析。

2.1 注解

2.1.1 注解1:@Target({ElementType.TYPE})

用来表示注解作用范围,TYPE表示作用范围为类或接口。

2.1.2 注解2:@Retention(RetentionPolicy.RUNTIME)



2.1.3 注解3:@Documented

表明这个注释是由 javadoc记录的。

2.1.4 注解4:@Inherited

放在注解上,当父类加了@SpringBootApplication注解时,子类也会继承这个注解(对接口的实现类无效)。

2.1.5 注解5:@SpringBootConfiguration

底层仍是@Configuration注解, 源码如下:

  1. @Target(ElementType.TYPE)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. @Configuration
  5. public @interface SpringBootConfiguration {
  6. }

2.1.6 注解6:@ComponetScan

@ComponentScan这个注解在Spring中很重要,它对应XML配置中的元素@ComponentScan的功能其实就是自动扫描并加载符合条件的组件(比如@Component和@Repository等)或者bean定义,最终将这些bean定义加载到IoC容器中。

可以通过basePackages等属性来细粒度的定制@ComponentScan自动扫描的范围,如果不指定,则默认Spring框架实现会从声明@ComponentScan所在类的package进行扫描。所以SpringBoot的启动类最好是放在root package下,因为默认不指定basePackages。

2.2 注解:@EnableAutoConfiguration

个人感觉@EnableAutoConfiguration这个Annotation最为重要它的作用可以概括为:借助@Import的帮助,将所有符合自动配置条件的bean定义加载到IoC容器。

其源码如下:

  1. @Target(ElementType.TYPE)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. @Inherited
  5. @AutoConfigurationPackage
  6. @Import(AutoConfigurationImportSelector.class)
  7. public @interface EnableAutoConfiguration {
  8. String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
  9. Class<?>[] exclude() default {};
  10. String[] excludeName() default {};
  11. }

这里需要关注@AutoConfigurationPackage和@Import(AutoConfigurationImportSelector.class)两个注解。

2.2.1 注释:@AutoConfigurationPackage

源码如下:

  1. @Target(ElementType.TYPE)
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. @Inherited
  5. @Import(AutoConfigurationPackages.Registrar.class)
  6. public @interface AutoConfigurationPackage {
  7. }

可以发现这个注解的核心其实也是Import注解,表示对于标注该注解的类的包,应当使用AutoConfigurationPackages注册。接着看Registrar这个类:

  1. static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {

  2. @Override
  3. //metadata是我们注解所在的元信息
  4. public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {
  5. //将我们注解所在包下所有的组件进行注册
  6. register(registry, new PackageImport(metadata).getPackageName());
  7. }

  8. @Override
  9. public Set<Object> determineImports(AnnotationMetadata metadata) {
  10. return Collections.singleton(new PackageImport(metadata));
  11. }
  12. }

这个类中的核心方法是register方法:

  1. private static final String BEAN = AutoConfigurationPackages.class.getName();
  2. public static void register(BeanDefinitionRegistry registry, String... packageNames) {
  3. if (registry.containsBeanDefinition(BEAN)) {
  4. BeanDefinition beanDefinition = registry.getBeanDefinition(BEAN);
  5. ConstructorArgumentValues constructorArguments = beanDefinition.getConstructorArgumentValues();
  6. constructorArguments.addIndexedArgumentValue(0, addBasePackages(constructorArguments, packageNames));
  7. }
  8. else {
  9. GenericBeanDefinition beanDefinition = new GenericBeanDefinition();
  10. beanDefinition.setBeanClass(BasePackages.class);
  11. beanDefinition.getConstructorArgumentValues().addIndexedArgumentValue(0, packageNames);
  12. beanDefinition.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);
  13. registry.registerBeanDefinition(BEAN, beanDefinition);
  14. }
  15. }

register方法的逻辑非常清晰:如果这个bean已经被注册,就获取它的构造函数参数值,并将包名添加进去;否则就创建一个新的bean定义并进行注册。通过@AutoConfigurationPackage这个注解,可以将注解所在包下所有的组件进行注册。

2.2.2 注解:@Import(AutoConfigurationImportSelector.class)

这个注解导入了AutoConfigurationImportSelector这个类这个类的核心方法是selectImports方法,实现ImportSelector接口。方法基于我们在pom.xml文件中配置的jar包和组件进行导入。所以方法返回的是一个Class全路径的String数组,返回的Class会被Spring容器管理。方法源码如下:

  1. @Override
  2. public String[] selectImports(AnnotationMetadata annotationMetadata) {
  3. if (!isEnabled(annotationMetadata)) {
  4. return NO_IMPORTS;
  5. }
  6. AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader
  7. .loadMetadata(this.beanClassLoader);
  8. AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(autoConfigurationMetadata,
  9. annotationMetadata);
  10. return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
  11. }

这个方法的结构也很清晰,首先通过isEnabled方法判断是否需要进行导入,如果需要导入的话,通过loadMetadata方法获取配置信息,并通过getAutoConfigurationEntry进行自动装配。isEnabled方法源码如下:

  1. protected boolean isEnabled(AnnotationMetadata metadata) {
  2. if (getClass() == AutoConfigurationImportSelector.class) {
  3. return getEnvironment().getProperty(EnableAutoConfiguration.ENABLED_OVERRIDE_PROPERTY, Boolean.class, true);
  4. }
  5. return true;
  6. }

这个方法通过EnableAutoConfiguration.ENABLED_OVERRIDE_PROPERTY这个配置项进行判断是否需要自动配置,默认为true。loadMetadata方法源码如下:


  1. protected static final String PATH = "META-INF/" + "spring-autoconfigure-metadata.properties";

  2. public static AutoConfigurationMetadata loadMetadata(ClassLoader classLoader) {
  3. return loadMetadata(classLoader, PATH);
  4. }

  5. static AutoConfigurationMetadata loadMetadata(ClassLoader classLoader, String path) {
  6. try {
  7. Enumeration<URL> urls = (classLoader != null) ? classLoader.getResources(path)
  8. : ClassLoader.getSystemResources(path);
  9. Properties properties = new Properties();
  10. while (urls.hasMoreElements()) {
  11. properties.putAll(PropertiesLoaderUtils.loadProperties(new UrlResource(urls.nextElement())));
  12. }
  13. return loadMetadata(properties);
  14. }
  15. catch (IOException ex) {
  16. throw new IllegalArgumentException("Unable to load @ConditionalOnClass location [" + path + "]", ex);
  17. }
  18. }
  19. static AutoConfigurationMetadata loadMetadata(Properties properties) {
  20. return new PropertiesAutoConfigurationMetadata(properties);
  21. }

可以看到这个方法会加载META-INF/spring-autoconfigure-metadata.properties下的所有配置信息并包装成AutoConfigurationMetadata对象返回。

注:spring-autoconfigure-metadata.properties文件在spring-boot-autoconfigure-2.1.9.RELEASE.jar/META-INF下。

getAutoConfigurationEntry方法源码如下:

  1. protected AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata,
  2. AnnotationMetadata annotationMetadata) {
  3. if (!isEnabled(annotationMetadata)) {
  4. return EMPTY_ENTRY;
  5. }
  6. AnnotationAttributes attributes = getAttributes(annotationMetadata);
  7. List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
  8. configurations = removeDuplicates(configurations);
  9. Set<String> exclusions = getExclusions(annotationMetadata, attributes);
  10. checkExcludedClasses(configurations, exclusions);
  11. configurations.removeAll(exclusions);
  12. configurations = filter(configurations, autoConfigurationMetadata);
  13. fireAutoConfigurationImportEvents(configurations, exclusions);
  14. return new AutoConfigurationEntry(configurations, exclusions);
  15. }

这个方法是AutoConfiguration的主流程方法,可以将这个方法的每一行看做一个步骤,那么处理步骤如下:

1.加载配置了@EnableAutoConfiguration注解的属性值getAttribute方法:

  1. protected AnnotationAttributes getAttributes(AnnotationMetadata metadata) {
  2. String name = getAnnotationClass().getName();
  3. AnnotationAttributes attributes = AnnotationAttributes.fromMap(metadata.getAnnotationAttributes(name, true));
  4. Assert.notNull(attributes, () -> "No auto-configuration attributes found. Is " + metadata.getClassName()
  5. + " annotated with " + ClassUtils.getShortName(name) + "?");
  6. return attributes;
  7. }

2.得到META-INF/spring.factories文件中以@EnableAutoConfiguration完全限定类名做key的value,getCandidateConfigurations方法:

  1. protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
  2. List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
  3. getBeanClassLoader());
  4. Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you "
  5. + "are using a custom packaging, make sure that file is correct.");
  6. return configurations;
  7. }
  8. protected Class<?> getSpringFactoriesLoaderFactoryClass() {
  9. return EnableAutoConfiguration.class;
  10. }

其中,SpringFactoriesLoader.loadFactoryNames()这个方法的作用是使用给定的类加载器从META-INF/spring.factories加载给定类型的工厂实现的完全限定类名;

3.去重;

4.得到需要排除的类的类名,这些类可以在@EnableAutoConfiguration注解中配置;

5.检查这两个集合;

6.把需要排除的类移除;

7.根据OnBeanCondition、OnClassCondition等条件进行过滤(有兴趣可以深入了解);

8.广播事件,得到AutoConfigurationImportListener所有实现类,然后生成事件进行广播;

9.把需要装配和排除的类完全限定名封装成了AutoConfigurationEntry对象返回。

因此,@EnableAutoConfiguration可以简单总结为:从classpath中搜寻所有的META-INF/spring.factories配置文件,并将其中EnableAutoConfiguration对应的配置项通过反射实例化为对应的标注了@Configuration的IoC容器配置类,并加载到IoC容器。

三、小结

通过以上分析可知@SpringBootApplication注解的运作是通过@SpringApplicationConfiguration声明被标注类为配置类,从而被AnnotationConfigApplicationContext扫描并初始化Spring容器。

通过@EnableAutoConfiguration来扫描,过滤并加载所需要的组件;通过@ComponentScan扫描并注册所有标注了@Component及其子注解的类;这些注解的共同运作实现了springboot工程强大的自动配置能力。

以上就是本次总结的全部内容,希望能对大家有所帮助。如果有疏漏错误之处,还请大家不吝指正。

作者:vivo 互联网开发团队-Peng peng

神秘又强大的@SpringBootApplication注解的更多相关文章

  1. Spring Boot 中 @SpringBootApplication注解背后的三体结构探秘

    概 述 SpringBoot 约定大于配置 的功力让我们如沐春风,在我之前写的文章<从SpringBoot到SpringMVC> 也对比过 SpringBoot 和 SpringMVC 这 ...

  2. SpringBoot的注解:@SpringBootApplication注解 vs @EnableAutoConfiguration+@ComponentScan+@Configuration

    spring Boot开发者经常使用@Configuration,@EnableAutoConfiguration,@ComponentScan注解他们的main类, 由于这些注解如此频繁地一块使用( ...

  3. springboot情操陶冶-@SpringBootApplication注解解析

    承接前文springboot情操陶冶-@Configuration注解解析,本文将在前文的基础上对@SpringBootApplication注解作下简单的分析 @SpringBootApplicat ...

  4. 使用@SpringBootApplication注解

    很多Spring Boot开发者总是使用@Configuration , @EnableAutoConfiguration 和 @ComponentScan 注解他们的main类. 由于这些注解被如此 ...

  5. @EnableAutoConfiguration和@SpringbootApplication注解

    一.@EnableAutoConfiguration 这个注释告诉SpringBoot“猜”你将如何想配置Spring,基于你已经添加jar依赖项.如果spring-boot-starter-web已 ...

  6. @SpringBootApplication注解分析

    首先我们分析的就是入口类Application的启动注解@SpringBootApplication,进入源码: @Target(ElementType.TYPE) @Retention(Retent ...

  7. SpringBoot学习之@SpringBootApplication注解

    下面是我们经常见到SpringBoot启动类代码: @SpringBootApplicationpublic class DemoApplication extends SpringBootServl ...

  8. @SpringBootApplication注解

    @SpringBootApplication注解表明了SpringBoot的核心功能,即自动配置. @SpringBootApplication(主配置类): @SpringBootConfigura ...

  9. (32)Spring Boot使用@SpringBootApplication注解,从零开始学Spring Boot

    [来也匆匆,去也匆匆,在此留下您的脚印吧,转发点赞评论] 如果看了我之前的文章,这个节你就可以忽略了,这个是针对一些刚入门的选手存在的困惑进行写的一篇文章. 很多Spring Boot开发者总是使用 ...

  10. Springboot系列:@SpringBootApplication注解

    在使用 Springboot 框架进行开发的时候,通常我们会在 main 函数上添加 @SpringBootApplication 注解,今天为大家解析一下 @SpringBootApplicatio ...

随机推荐

  1. 马云说的AI电商时代是什么

    这两天非常火的就是马老师说的,我们已经进入了AI的电商时代.相信电商时代大家很容易理解,换一个简单的方式来说就是网上购物. AI相信大家已经很熟悉了,就是人工智能.早在十年前其实已经有AI人工智能的概 ...

  2. java-生成二维码/条形码

    前言:   需求:生成二维码/条形码 //使用ZXing库 <dependencies> <dependency> <groupId>com.google.zxin ...

  3. charles谷歌浏览器抓包方法

    charles谷歌浏览器抓包方法 在工作中,我们会在PC电脑上测试页面,查看后端接口,我们会选择浏览器F12的功能来查看后端请求的接口,那我们能不能用charles抓包工具去抓呢?下面简答介绍一下ch ...

  4. WordPress简码实现的一些常用的效果

    首先要确保框架里已经安装好element pro插件,下面是使用简码,来实现效果,在element中找到简码,并且在WordPress后台主题编辑器中,找到function.php文件, 显示产品的分 ...

  5. vue-test --------ref

    <template> <div ref="contain">{{content}}</div> <button @click=" ...

  6. Spring Cache + Caffeine的整合与使用

    前言 对于一些项目里需要对数据库里的某些数据一直重复请求的,且这些数据基本是固定的,在这种情况下,可以借助简单使用本地缓存来缓存这些数据.这些介绍一下Spring Cache和Caffeine的使用. ...

  7. Java8新特性Stream流

    1.是什么? Stream(流)是一个来自数据源的元素队列并支持聚合操作 2.能干嘛? Stream流的元素是特定类型的对象,形成一个队列. Java中的Stream并不会存储元素,而是按需计算. 数 ...

  8. RISC-V系列单片机快速入门指南

    如何获取芯片开发资料 方法一:按型号选择 我们更推荐采用按型号选择的方法,获取所对应型号芯片的开发资料,这能有效降低错误使用资料的风险! 沁恒官网首页的产品中心,点击青稞 RISC-V 通用系列,可跳 ...

  9. Javascript Ajax总结——XMLHttpRequest对象

    Ajax技术能向服务器异步请求额外的数据,会带来更好的用户体验.Ajax技术核心:XMLHttpRequest对象(简称XHR).XHR为向服务器发送请求和解析服务器响应提供了流畅的接口.1.创建XM ...

  10. MyBatis高频面试题

    1.MyBatis中使用#和$书写占位符有什么区别? 2.Hibernate 与 Mybatis区别(MyBatis与Hibernate有什么不同). 3.持久层设计要考虑的问题有哪些? 4.你用过的 ...