每天用SpringBoot竟然还不知道它的自动装配的原理?

引言

最近有个读者在面试,面试中被问到了这样一个问题“看你项目中用到了springboot,你说下springboot的自动配置是怎么实现的?”这应该是一个springboot里面最最多见的一个面试题了。下面咱们就来带着这个问题一块儿解剖下springBoot的自动配置原理吧。html

SpringMvc和SpringBoot对比

首先咱们回顾下原来搭建一个springmvchello-wordweb项目(xml配置的)咱们是否是要在pom中导入各类依赖,而后各个依赖有可能还会存在版本冲突须要各类排除。当你历尽千辛万苦的把依赖解决了,而后还须要编写web.xml、springmvc.xml配置文件等。咱们只想写个hello-word项目而已,确把一大把的时间都花在了配置文件和jar包的依赖上面。大大的影响了咱们开发的效率,以及加大了web开发的难度。为了简化这复杂的配置、以及各个版本的冲突依赖关系,springBoot就应运而生。咱们如今经过idea建立一个springboot项目只要分分钟就解决了,你不须要关心各类配置(基本实现零配置)。让你真正的实现了开箱即用。SpringBoot帮你节约了大量的时间去陪女友,不对程序员怎么会有女友呢?(没有的话也是能够new一个的)它的出现不只可让你把更多的时间都花在你的业务逻辑开发上,并且还大大的下降了web开发的门槛。因此SpringBoot仍是比较善解人衣的,错啦错啦是善解人意,知道开发人员的痛点在哪。
在这里插入图片描述java

SpringBoot自动配置加载

既然Springboot尽管这么好用,可是做为一个使用者,咱们仍是比较好奇它是怎么帮咱们实现开箱即用的。Spring Boot有一个全局配置文件:application.properties或application.yml。在这个全局文件里面能够配置各类各样的参数好比你想改个端口啦server.port 或者想调整下日志的级别啦统统均可以配置。更多其余能够配置的属性能够参照官网。https://docs.spring.io/spring-boot/docs/2.3.0.RELEASE/reference/htmlsingle/#common-application-properties

这么多属性,这些属性在项目是怎么起做用的呢?SpringBoot项目看下来啥配置也没有,配置”(application.properties或application.yml除外),既 然从配置上面找不到突破口,那么咱们就只能从启动类上面找入口了。启动类也就一个光秃秃的一个main方法,类上面仅有一个注SpringBootApplication
这个注解是Spring Boot项目必不可少的注解。那么自动配置原理必定和这个注解有着千丝万缕的联系!咱们下面来一块儿看看这个注解吧。
@SpringBootApplication注解程序员

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
		@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {

这里最上面四个注解的话没啥好说的,基本上本身实现过自定义注解的话,都知道分别是什么意思。web

  • @SpringBootConfiguration继承自@Configuration,两者功能也一致,标注当前类是配置类。
  • @ComponentScan用于类或接口上主要是指定扫描路径,跟Xml里面的<context:component-scan base-package="" />配置同样。springboot若是不写这个扫描路径的话,默认就是启动类的路径。
  • @EnableAutoConfiguration
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {

这个注解咱们重点看下AutoConfigurationImportSelector这个类getCandidateConfigurations
这个方法里面经过SpringFactoriesLoader.loadFactoryNames()扫描全部具备META-INF/spring.factoriesjar包( spring.factories 咱们能够理解成 Spring Boot 本身的 SPI 机制)。
spring-boot-autoconfigure-x.x.x.x.jar里就有一个spring.factories文件。spring.factories文件由一组一组的Key = value的形式,其中一个key是EnableAutoConfiguration类的全类名,而它的value是一个以AutoConfiguration结尾的类名的列表,有redis、mq等这些类名以逗号分隔。
在这里插入图片描述面试

在这里插入图片描述
咱们在回到getAutoConfigurationEntry这个方法当执行完getCandidateConfigurations这个方法的时候咱们能够看到此时总共加载了127个自动配置类。
在这里插入图片描述
这些类难道都要加载进去吗?springboot仍是没有那么傻的,它提倡的话是按需加载。redis

  • 它会去掉重复的类
  • 过滤掉咱们配置了exclude注解的类下面配置就会过滤掉RestTemplateAutoConfiguration这个类
    在这里插入图片描述
  • 通过上面的处理,剩下的这写自动配置的类若是要起做用的话,是须要知足必定的条件的。这些条件的知足的话spring boot是经过条件注解来实现的。

@ConditionalOnBean:当容器里有指定Bean的条件下
@ConditionalOnClass:当类路径下有指定的类的条件下
@ConditionalOnExpression:基于SpEL表达式为true的时候做为判断条件才去实例化
@ConditionalOnJava:基于JVM版本做为判断条件
@ConditionalOnJndi:在JNDI存在的条件下查找指定的位置
@ConditionalOnMissingBean:当容器里没有指定Bean的状况下
@ConditionalOnMissingClass:当容器里没有指定类的状况下
@ConditionalOnWebApplication:当前项目时Web项目的条件下
@ConditionalOnNotWebApplication:当前项目不是Web项目的条件下
@ConditionalOnProperty:指定的属性是否有指定的值
@ConditionalOnResource:类路径是否有指定的值
@ConditionalOnOnSingleCandidate:当指定Bean在容器中只有一个,或者有多个可是指定首选的Beanspring

这些注解都组合了@Conditional注解,只是使用了不一样的条件组合最后为true时才会去实例化须要实例化的类,不然忽略过滤掉。咱们在回到代码能够看到通过了条件判断过滤后咱们剩下符合条件的自动配置类只剩23个了。其余的都是由于不知足条件注解而被过滤了。
在这里插入图片描述
若是咱们想知道哪些自动配置类被过滤了,是因为什么缘由被过滤了,以及加载了哪些类等。spring boot都为咱们记录了日志。仍是很是贴心的。咱们能够调整下咱们日志的级别改成debug。而后咱们就能看到如下日志了
Positive matches:在这里插入图片描述
这里就截取了部分日志。总共分别有下面四部分日志:apache

  • Positive matches@Conditional条件为真,配置类被Spring容器加载。
  • Negative matches: @Conditional条件为假,配置类未被Spring容器加载。
  • Exclusions: 咱们明确了不须要加载的类。好比在上面启动类配置的RestTemplateAutoConfiguration
  • Unconditional classes: 自动配置类不包含任何类级别的条件,也就是说,类始终会被自动加载。

自动配置生效

咱们以ServletWebServerFactoryAutoConfiguration配置类为例,解释一下全局配置文件中的属性如何生效,好比:server.port=88,是如何生效的(固然不配置也会有默认值,这个默认值来自于org.apache.catalina.startup.Tomcat)。springboot

// 标记为配置类
@Configuration(proxyBeanMethods = false)
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)
// 若是有ServletRequest.class 才会生效
@ConditionalOnClass(ServletRequest.class)
@ConditionalOnWebApplication(type = Type.SERVLET)
// 把@ConfigurationProperties注解的类注入为Spring容器的Bean。
@EnableConfigurationProperties(ServerProperties.class)
@Import({ ServletWebServerFactoryAutoConfiguration.BeanPostProcessorsRegistrar.class,
		ServletWebServerFactoryConfiguration.EmbeddedTomcat.class,
		ServletWebServerFactoryConfiguration.EmbeddedJetty.class,
		ServletWebServerFactoryConfiguration.EmbeddedUndertow.class })
public class ServletWebServerFactoryAutoConfiguration {

咱们能够发现EnableConfigurationProperties注解里面配置的ServerProperties.classmvc

@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
public class ServerProperties {

	/**
	 * Server HTTP port.
	 */
	private Integer port;

在这个类上有一个注解:@ConfigurationProperties,它的做用就是从配置文件中绑定属性到对应的bean上(也就是把咱们application.properties对应的server.port映射到ServerProperties 类中的port属性)而@EnableConfigurationProperties这个注解就是把已经绑定了属性的beanServerProperties)注入到spring容器中(至关于@Component注解同样)。
全部在配置文件中能配置的属性都是在xxxxPropertites类中封装着,配置文件能配置什么就能够参照某个功能对应的这个属性类。
到如今为止应该能回答文章开头的那个问题了,面试的时候应该不须要回答的这么详细能够参考下如下答案:

Spring Boot启动的时候会经过@EnableAutoConfiguration注解找到META-INF/spring.factories配置文件中的全部自动配置类,并对其进行加载,而这些自动配置类都是以AutoConfiguration结尾来命名的,它实际上就是一个JavaConfig形式的Spring容器配置类,它能经过以Properties结尾命名的类中取得在全局配置文件中配置的属性如:server.port,而XxxxProperties类是经过@ConfigurationProperties注解与全局配置文件中对应的属性进行绑定的。

在网上找了一张图,基本上把自动装配的流程给说清楚了。
图片来源https://afoo.me/posts/2015-07-09-how-spring-boot-works.html

总结

  • SpringBoot启动会加载大量的自动配置类(经过“SPI”的方式),而后会根据条件注解保留一些须要的类。
  • 咱们新引入一个组件,能够先看看springBoot是否已经有默认的提供。
  • SpringBoot基本实现了“零配置“,而且开箱即用。

结束

相关文章
相关标签/搜索