SpringBoot 启动类 @SpringBootApplication 注解以及执行流程

叁歲伎倆 2022-05-18 06:55 193阅读 0赞

## @SpringBootApplication  : 是Sprnig Boot项目的核心注解，目的是开启自动配置 ##

**目录**

@SpringBootApplication  : 是Sprnig Boot项目的核心注解，目的是开启自动配置

（一）、@ComponentScan 注解

（二）、@EnableAutoConfiguration 注解

（三）、@SpringBootConfiguration 注解

（四）、@Inherited 注解

声明的此注解使用了Inherited元注解，表示此注解用在类上时，会被子类所继承

（五）、@Documented 注解

（六）、@Retention() 注解

（七）、@Target()  注解

深入探索SpringApplication执行流程

spingboot建议的目录结果如下：

root package结构：com.example.myproject

![70][]

--------------------

![70 1][]

大家可以先认识一下@interface  ： [java 中@interface 和interface 的区别][java _interface _interface]

## （一）、@ComponentScan 注解 ##

@ComponentScan(excludeFilters = {
    		@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
    		@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })

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

我们可以通过basePackages等属性来细粒度的定制@ComponentScan自动扫描的范围，如果不指定，则默认Spring框架实现会从声明@ComponentScan所在类的package进行扫描。

> 注：所以SpringBoot的启动类最好是放在root package下，因为默认不指定basePackages。

2、@ComponentScan告诉Spring 哪个packages 的用注解标识的类 会被spring自动扫描并且装入bean容器。

例如，如果你有个类用@Controller注解标识了，那么，如果不加上@ComponentScan，自动扫描该controller，那么该Controller就不会被spring扫描到，更不会装入spring容器中，因此你配置的这个Controller也没有意义。

3、参数的作用

basePackageClasses：对basepackages()指定扫描注释组件包类型安全的替代。
    
    excludeFilters：指定不适合组件扫描的类型。
    
    includeFilters：指定哪些类型有资格用于组件扫描。
    
    lazyInit：指定是否应注册扫描的beans为lazy初始化。
    
    nameGenerator：用于在Spring容器中的检测到的组件命名。
    
    resourcePattern：控制可用于组件检测的类文件。
    
    scopedProxy：指出代理是否应该对检测元件产生，在使用过程中会在代理风格时尚的范围是必要的。
    
    scopeResolver：用于解决检测到的组件的范围。
    
    useDefaultFilters：指示是否自动检测类的注释

## （二）、@EnableAutoConfiguration 注解 ##

@EnableAutoConfiguration 简单概括一下就是，**借助@Import的支持，收集和注册特定场景相关的bean定义**。

*  @EnableScheduling是通过@Import将Spring调度框架相关的bean定义都加载到IoC容器。
 *  @EnableMBeanExport是通过@Import将JMX相关的bean定义加载到IoC容器。

而@EnableAutoConfiguration也是借助@Import的帮助，将所有符合自动配置条件的bean定义加载到IoC容器，仅此而已！

@EnableAutoConfiguration作为一个复合Annotation,其自身定义关键信息如下：

![70 2][]

其中，最关键的要属@Import(AutoConfigurationImportSelector.class)，借助AutoConfigurationImportSelector，@EnableAutoConfiguration可以帮助SpringBoot应用将所有符合条件的@Configuration配置都加载到当前SpringBoot创建并使用的IoC容器。

![70 3][]

**自动配置幕后英雄：SpringFactoriesLoader详解**  
       SpringFactoriesLoader属于Spring框架私有的一种扩展方案，其主要功能就是从指定的配置文件META-INF/spring.factories加载配置。

![70 4][]

配合@EnableAutoConfiguration使用的话，它更多是提供一种配置查找的功能支持，即根据@EnableAutoConfiguration的完整类名org.springframework.boot.autoconfigure.EnableAutoConfiguration作为查找的Key,获取对应的一组@Configuration类

![70 5][]

上图就是从SpringBoot的autoconfigure依赖包中的META-INF/spring.factories配置文件中摘录的一段内容，可以很好地说明问题。

所以，@EnableAutoConfiguration自动配置的魔法骑士就变成了：**从classpath中搜寻所有的META-INF/spring.factories配置文件，并将其中org.springframework.boot.autoconfigure.EnableutoConfiguration对应的配置项通过反射（Java Refletion）实例化为对应的标注了@Configuration的JavaConfig形式的IoC容器配置类，然后汇总为一个并加载到IoC容器。**

## （三）、@SpringBootConfiguration 注解 ##

@SpringBootConfiguration继承自@Configuration，二者功能也一致，标注当前类是配置类，
    并会将当前类内声明的一个或多个以@Bean注解标记的方法的实例纳入到spring容器中，并且实例名就是方法名。

## （四）、@Inherited 注解 ##

**关于java中元注解Inherited 的使用说明**

**首先解释下元注解，就是用来中声明注解类型时需要使用到的注解。**

Inherited作用是，使用此注解声明出来的自定义注解，在使用此自定义注解时，如果注解在类上面时，子类会自动继承此注解，否则的话，子类不会继承此注解。这里一定要记住，使用Inherited声明出来的注解，只有在类上使用时才会有效，对方法，属性等其他无效。

![70 6][]

### 声明的此注解使用了Inherited元注解，表示此注解用在类上时，会被子类所继承 ###

## （五）、@Documented 注解 ##

Documented注解表明这个注释是由 javadoc记录的，在默认情况下也有类似的记录工具。 如果一个类型声明被注释了文档化，它的注释成为公共API的一部分。

## （六）、@Retention() 注解 ##

RetentionPolicy这个枚举类型的常量描述保留注释的各种策略，它们与元注释(@Retention)一起指定注释要保留多长时间

## （七）、@Target()  注解 ##

ElementType 这个枚举类型的常量提供了一个简单的分类：注释可能出现在Java程序中的语法位置（这些常量与元注释类型(@Target)一起指定在何处写入注释的合法位置）

===========================================================================================

#                      深入探索SpringApplication执行流程 #

SpringApplication的run方法的实现是我们本次旅程的主要线路，该方法的主要流程大体可以归纳如下：

1） 如果我们使用的是SpringApplication的静态run方法，那么，这个方法里面首先要创建一个SpringApplication对象实例，然后调用这个创建好的SpringApplication的实例方法。在SpringApplication实例初始化的时候，它会提前做几件事情：

*  根据classpath里面是否存在某个特征类（org.springframework.web.context.ConfigurableWebApplicationContext）来决定是否应该创建一个为Web应用使用的ApplicationContext类型。
 *  使用SpringFactoriesLoader在应用的classpath中查找并加载所有可用的ApplicationContextInitializer。
 *  使用SpringFactoriesLoader在应用的classpath中查找并加载所有可用的ApplicationListener。
 *  推断并设置main方法的定义类。

2） SpringApplication实例初始化完成并且完成设置后，就开始执行run方法的逻辑了，方法执行伊始，首先遍历执行所有通过SpringFactoriesLoader可以查找到并加载的SpringApplicationRunListener。调用它们的started()方法，告诉这些SpringApplicationRunListener，“嘿，SpringBoot应用要开始执行咯！”。

3） 创建并配置当前Spring Boot应用将要使用的Environment（包括配置要使用的PropertySource以及Profile）。

4） 遍历调用所有SpringApplicationRunListener的environmentPrepared()的方法，告诉他们：“当前SpringBoot应用使用的Environment准备好了咯！”。

5） 如果SpringApplication的showBanner属性被设置为true，则打印banner。   【banner：英文广告横幅，在这里面指的是运行时输出的SpringBoot，还可以进行[修改][Link 1]】

![70 7][]

6） 根据用户是否明确设置了applicationContextClass类型以及初始化阶段的推断结果，决定该为当前SpringBoot应用创建什么类型的ApplicationContext并创建完成，然后根据条件决定是否添加ShutdownHook，决定是否使用自定义的[BeanNameGenerator][]，决定是否使用自定义的[ResourceLoader][]，当然，最重要的，将之前准备好的Environment设置给创建好的ApplicationContext使用。  【[ShutdownHook ：停止服务][ShutdownHook]】

7） ApplicationContext创建好之后，SpringApplication会再次借助[Spring-FactoriesLoader][]，查找并加载classpath中所有可用的[ApplicationContext-Initializer][]，然后遍历调用这些ApplicationContextInitializer的initialize（applicationContext）方法来对已经创建好的ApplicationContext进行进一步的处理。

8） 遍历调用所有[SpringApplicationRunListener][]的contextPrepared()方法。

9） 最核心的一步，将之前通过@EnableAutoConfiguration获取的所有配置以及其他形式的IoC容器配置加载到已经准备完毕的ApplicationContext。

10） 遍历调用所有SpringApplicationRunListener的contextLoaded()方法。

11） 调用ApplicationContext的refresh()方法，完成IoC容器可用的最后一道工序。

12） 查找当前ApplicationContext中是否注册有CommandLineRunner，如果有，则遍历执行它们。

13） 正常情况下，遍历执行SpringApplicationRunListener的finished()方法、（如果整个过程出现异常，则依然调用所有SpringApplicationRunListener的finished()方法，只不过这种情况下会将异常信息一并传入处理）

去除事件通知点后，整个流程如下：

![70 8][]

![70 9][]

参考：

1、[Spring Boot干货系列：（三）启动原理解析][Spring Boot]

2、[@componentscan注解的用法和作用][componentscan]

3、[excludeFilters：][excludeFilters]

[https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/annotation/ComponentScan.html\#excludeFilters--][https_docs.spring.io_spring-framework_docs_current_javadoc-api_org_springframework_context_annotation_ComponentScan.html_excludeFilters--]

4、[@SpringBootConfiguration注解][SpringBootConfiguration]

5、[关于java 注解中元注解Inherited的使用详解][java _Inherited]

6、[Java注解之 @Target、@Retention、@Documented简介][Java_ _Target_Retention_Documented]

[70]: /images/20220518/f52d05773bbc461cad5590954c648481.png
[70 1]: /images/20220518/45002ccecdbf419e98ab274bd181d231.png
[java _interface _interface]: https://blog.csdn.net/qq_28289405/article/details/81358000
[70 2]: /images/20220518/2b530f27a524476eb675919a67d8a530.png
[70 3]: /images/20220518/d5e950e258674bddacfad04176ec51a0.png
[70 4]: /images/20220518/72c8fb736e814fe99590032b4eaac808.png
[70 5]: /images/20220518/4042adb5c8ac4e589aeaff6b54e635f7.png
[70 6]: /images/20220518/8a9ad5ba9f164d55b5b38b5505b9598c.png
[Link 1]: https://www.jianshu.com/p/c1f7617c99aa
[70 7]: /images/20220518/168c257345ae433ca1f00f60a9e37c36.png
[BeanNameGenerator]: https://www.cnblogs.com/jeffen/p/6394795.html
[ResourceLoader]: http://www.cnblogs.com/doit8791/p/5774743.html
[ShutdownHook]: https://blog.csdn.net/wins22237/article/details/72758644
[Spring-FactoriesLoader]: https://blog.csdn.net/qq_30739519/article/details/78643741
[ApplicationContext-Initializer]: https://segmentfault.com/a/1190000014025371?utm_source=index-hottest
[SpringApplicationRunListener]: https://blog.csdn.net/u013194072/article/details/79177741
[70 8]: /images/20220518/68659f5c0105404eb6171e8aba3d5285.png
[70 9]: /images/20220518/4ec12c2952de4d1690a5b5c8266e996e.png
[Spring Boot]: http://tengj.top/2017/03/09/springboot3/
[componentscan]: https://www.cnblogs.com/Johar/p/9380311.html
[excludeFilters]: https://blog.csdn.net/tuxedolinux/article/details/80772570
[https_docs.spring.io_spring-framework_docs_current_javadoc-api_org_springframework_context_annotation_ComponentScan.html_excludeFilters--]: https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/annotation/ComponentScan.html#excludeFilters--
[SpringBootConfiguration]: https://www.jianshu.com/p/caa9cd010940
[java _Inherited]: https://blog.csdn.net/snow_crazy/article/details/39381695
[Java_ _Target_Retention_Documented]: https://blog.csdn.net/liang100k/article/details/79515910