SpringBoot自动装配原理:SpringBootApplication背后的秘密
原文地址:https://www.toutiao.com/a6714100829579674126/
我们开发任何一个Spring Boot项目,都会用到如下的启动类
从上面代码可以看出,Annotation定义(@SpringBootApplication)和类定义(SpringApplication.run)最为耀眼,所以要揭开SpringBoot的神秘面纱,我们要从这两位开始就可以了。
SpringBootApplication背后的秘密
虽然定义使用了多个Annotation进行了原信息标注,但实际上重要的只有三个Annotation:
- @Configuration(@SpringBootConfiguration点开查看发现里面还是应用了@Configuration)
- @EnableAutoConfiguration
- @ComponentScan
所以,每次写这3个比较累,所以写一个@SpringBootApplication方便点。接下来分别介绍这3个Annotation。
@Configuration
这里的@Configuration对我们来说不陌生,它就是JavaConfig形式的Spring Ioc容器的配置类使用的那个@Configuration,SpringBoot社区推荐使用基于JavaConfig的配置形式,所以,这里的启动类标注了@Configuration之后,本身其实也是一个IoC容器的配置类。
举几个简单例子回顾下,XML跟config配置方式的区别:
- 表达形式层面
基于XML配置的方式是这样:
而基于JavaConfig的配置方式是这样:
任何一个标注了@Configuration的Java类定义都是一个JavaConfig配置类。
- 注册bean定义层面
基于XML的配置形式是这样:
而基于JavaConfig的配置形式是这样的:
任何一个标注了@Bean的方法,其返回值将作为一个bean定义注册到Spring的IoC容器,方法名将默认成该bean定义的id。
@ComponentScan
@ComponentScan这个注解在Spring中很重要,它对应XML配置中的元素,@ComponentScan的功能其实就是自动扫描并加载符合条件的组件(比如@Component和@Repository等)或者bean定义,最终将这些bean定义加载到IoC容器中。
我们可以通过basePackages等属性来细粒度的定制@ComponentScan自动扫描的范围,如果不指定,则默认Spring框架实现会从声明@ComponentScan所在类的package进行扫描。
注:SpringBoot的启动类最好是放在root package下,因为默认不指定basePackages。
@EnableAutoConfiguration
@EnableAutoConfiguration这个Annotation最为重要,大家是否还记得Spring框架提供的各种名字为@Enable开头的Annotation定义?比如@EnableScheduling、@EnableCaching、@EnableMBeanExport等,@EnableAutoConfiguration的理念和做事方式其实一脉相承,简单概括一下就是,借助@Import的支持,收集和注册特定场景相关的bean定义。
- @EnableScheduling是通过@Import将Spring调度框架相关的bean定义都加载到IoC容器。
- @EnableMBeanExport是通过@Import将JMX相关的bean定义加载到IoC容器。
而@EnableAutoConfiguration也是借助@Import的帮助,将所有符合自动配置条件的bean定义加载到IoC容器,仅此而已!
@EnableAutoConfiguration作为一个复合Annotation,其自身定义关键信息如下:
其中,最关键的要属@Import(EnableAutoConfigurationImportSelector.class),借助EnableAutoConfigurationImportSelector,@EnableAutoConfiguration可以帮助SpringBoot应用将所有符合条件的@Configuration配置都加载到当前SpringBoot创建并使用的IoC容器。借助于Spring框架原有的一个工具类:SpringFactoriesLoader的支持,@EnableAutoConfiguration可以智能的自动配置
从这里可以看出该类实现很多的xxxAware和DeferredImportSelector,所有的aware都优先于selectImports
方法执行,也就是说selectImports方法最后执行,那么在它执行的时候所有需要的资源都已经获取到了
进入getCandidateConfigurations方法:
继续进入loadFactoryNames方法:
最终来到了SpringFactoriesLoader
这里就通过SpringFactoriesLoader把META-INF/spring.factories配置文件中的类全部返回了,最后通过spring的条件注解判断容器中是否有该配置类的依赖,然后初始化到容器中
SpringFactoriesLoader详解
SpringFactoriesLoader属于Spring框架私有的一种扩展方案,其主要功能就是从指定的配置文件META-INF/spring.factories加载配置。
配合@EnableAutoConfiguration使用的话,它更多是提供一种配置查找的功能支持,即根据@EnableAutoConfiguration的完整类名org.springframework.boot.autoconfigure.EnableAutoConfiguration作为查找的Key,获取对应的一组@Configuration类
上图就是从SpringBoot的autoconfigure依赖包中的META-INF/spring.factories配置文件中摘录的一段内容,可以很好地说明问题。
所以,@EnableAutoConfiguration自动配置的魔法骑士就变成了:从classpath中搜寻所有的META-INF/spring.factories配置文件,并将其中org.springframework.boot.autoconfigure.EnableutoConfiguration对应的配置项通过反射(Java Refletion)实例化为对应的标注了@Configuration的JavaConfig形式的IoC容器配置类,然后汇总为一个并加载到IoC容器。
以上就是SpringBoot的自动装配原理
接下来我们来分析一下 为什么在SpringBoot中启动main函数后就能直接可以把项目运行起来?
在我们还没有用SpringBoot的时候 我们用的Spring +springMVC是在web.xm 里面配置:
load-on-startup =1 表示在spring context 初始化完成后就开始初始化servlet,
如果我们以spring boot方式开发web应用,我们就不会有web.xml 配置文件,那么DispatcherServlet 是怎么加载的呢?其实基于上面的自动装配原理我们可以发现 在spring.factories文件中有一个DispatcherServletAutoConfiguration配置类就是这个DispatcherServletAutoConfiguration 配置类里面,直接@Bean的方式初始化了DispatcherServlet;
但创建DispatcherServlet 两个条件:1.引入了web相关的jar包 2. 没有DispatcherServlet 类的bean
我们可以在spring-boot-starter-web 的spring.provides 中看到如下配置:
上图表示 环境中要依赖 spring-webmvc和spring-web的jar包
到这一步 我们项目中的DispatcherServlet就完成初始化了 接下来分析SpringBoot启动内嵌tomcat的过程
SpringBoot启动内嵌tomcat的过程
我们进入SpringApplication.run()里面:
在进入run方法里面:
这里new了一个SpringAaalication 我们继续进入SpringAaalication的构造函数中查看:
构造方法完成之后则是run(String[] args)方法。
这里我列了一些重要的方法,还有一些资源设置没有列出来,现在我们重点看那个refreshContext方法中:
可以看到,其首先调用的refresh方法,而在此方法中,applicationContext被转形为AbstractApplicationContext,然后调用了其中的refresh()方法。我们进入AbstractApplicationContext的refresh()方法中
其中关键是onRefresh()这个方法。其实这个onRefresh()方法是在子类中实现的。它的实现在ServletWebServerApplicationContext中
进入这个实现类的onRefresh()方法中可以发现有创建web服务的方法:
进入这个方法可以看到创建了一个WebServer
我们来看看这个WebServer是什么:
到这里可以看到 SpringBoot内嵌了五种服务器,而springboot默认初始化的是Tomcat服务器 这也就是为啥我们直接启动main函数的时候 我们我服务就在tomcat中启动起来了