理解一个框架,从上手到熟悉使用,再到理解框架设计的思路通过官方的文档是一个比较好的方式,特别是碰到了一些当前没有遇到过的问题,更需要通过官方的文档来找到问题解决的答案。本文将着重介绍SpringBoot的自动配置原理,并简单介绍SpringBoot提供了哪些默认的自动配置类,对于一些springboot内置配置又有哪些配置参数。
在springboot应用中自动配置开启是通过 @SpringBootApplication
注解开启的,该注解是一个复合注解,其中最主要的是 @EnableAutoConfiguration
,该注解开启自动配置功能,它也是一个复合注解。其中的关键功能由@Import提供,其导入的AutoConfigurationImportSelector的selectImports()方法通过SpringFactoriesLoader.loadFactoryNames()扫描所有具有META-INF/spring.factories的jar包。spring-boot-autoconfigure-x.x.x.x.jar里就有一个这样的spring.factories文件。这个spring.factories文件也是一组一组的key=value的形式,其中一个key是EnableAutoConfiguration类的全类名,而它的value是一个xxxxAutoConfiguration的类名的列表,这些类名以逗号分隔,这个@EnableAutoConfiguration注解通过@SpringBootApplication被间接的标记在了Spring Boot的启动类上。在SpringApplication.run(…)的内部就会执行selectImports()方法,找到所有JavaConfig自动配置类的全限定名对应的class,然后将所有自动配置类加载到Spring容器中。
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
@Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
//省略
}
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
//省略
}
Spring Boot关于自动配置的源码在spring-boot-autoconfigure-2.3.0.jar中可以找到(下文将给出所有内置的自动配置类):
每一个XxxxAutoConfiguration自动配置类都是在某些条件之下才会生效的,这些条件的限制在Spring Boot中以注解的形式体现,常见的条件注解有如下几项:
@ConditionalOnBean:当容器里有指定的bean的条件下。
@ConditionalOnMissingBean:当容器里不存在指定bean的条件下。
@ConditionalOnClass:当类路径下有指定类的条件下。
@ConditionalOnMissingClass:当类路径下不存在指定类的条件下。
@ConditionalOnProperty:指定的属性是否有指定的值,比如@ConditionalOnProperties(prefix=”xxx.xxx”, value=”enable”, matchIfMissing=true),代表当xxx.xxx为enable时条件的布尔值为true,如果没有设置的情况下也为true。
以 WebMvcAutoConfiguration
为例子,仅当WebMvcConfigurationSupport Bean实例不存在,且Servlet、DispatcherServlet、WebMvcConfigurer存在,是一个 WebApplication 的时候才会生效,并且它的自动配置要晚于DispatcherServletAutoConfiguration 的生效时机。
@Configuration(proxyBeanMethods = false)
@ConditionalOnWebApplication(type = Type.SERVLET)
@ConditionalOnClass({
Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
@AutoConfigureAfter({
DispatcherServletAutoConfiguration.class, TaskExecutionAutoConfiguration.class,ValidationAutoConfiguration.class })
public class WebMvcAutoConfiguration {
//省略
}
以 springboot2.3.0.RELEASE版本为例,目前官方提供的缺省自动配置类见:提供的缺省自动配置类,主要分为了两部分:应用自身的和应用监控的,具体有哪些类和类的源代码相见以下链接。在使用的时候,请一定注意 对应的AutoConfiguration上的Condition,这些正是决定是否触发这些自动配置类是否生效的关键因素。
1. spring-boot-autoconfigure
2. spring-boot-actuator-autoconfigure
SpringBoot对系统中的所有组件及其使用提供了一些配置的属性,这些配置的属性具体该怎么用,又有哪些,官方也提供了相应的使用说明,相见配置属性,这些配置属性,主要分为了以下几个类型。