5 自动配置-原理入门🌠
5.1 引导加载自动配置类
@SpringBootApplication
//一个注解相当于下面这三个注解
//@SpringBootConfiguration
//@EnableAutoConfiguration
//@ComponentScan("com.atguigu.boot")
1、@SpringBootConfiguration
里面是@Configuration
,就是说明当前是一个配置类,即主程序实际也是一个配置类
2、@ComponentScan
指定扫描哪些包,默认扫描主程序所在的包
3、@EnableAutoConfiguration 🚀
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
1、@AutoConfigurationPackage
自动配置包
@Import(AutoConfigurationPackages.Registrar.class)
/*
@Import就是给容器中导入组件
利用Registrar给容器批量导入组件
将指定的一个包下所有的组件导入进来,就是主程序所在包
*/
public @interface AutoConfigurationPackage {
2、@Import(AutoConfigurationImportSelector.class)
使用@Import
注解就给容器中自动创建出AutoConfigurationImportSelector
这个组件
1️⃣在AutoConfigurationImportSelector这个类中,
他会利用getAutoConfigurationEntry(annotationMetadata)这个方法给容器中批量导入一些组件,这个方法的返回值是一个字符串型数组,就要导入这个数组中指定的所有组件。那这些组件哪里来的呢?往下看
@Override
//返回值是字符串类型数组,里面规定了要向容器中导入哪些组件
public String[] selectImports(AnnotationMetadata annotationMetadata) {
if (!isEnabled(annotationMetadata)) {
return NO_IMPORTS;
}
//调用方法获取自动配置Entry,之后转换为String类型的数组返回
AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata);
return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}
2️⃣下面看一下getAutoConfigurationEntry
这个方法
这个方法中调用方法getCandidateConfigurations(annotationMetadata, attributes)
,看一下这个方法,里面有一个getCandidateConfigurations
,这个方法会获取到所有需要导入容器中的自动配置类
protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
if (!isEnabled(annotationMetadata)) {
return EMPTY_ENTRY;
}
AnnotationAttributes attributes = getAttributes(annotationMetadata);
//这里就会获取所有需要导入容器中的自动配置类
List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
configurations = removeDuplicates(configurations);
//对于configurations的其他操作,不再详细看了
configurations = removeDuplicates(configurations);
Set<String> exclusions = getExclusions(annotationMetadata, attributes);
checkExcludedClasses(configurations, exclusions);
configurations.removeAll(exclusions);
configurations = getConfigurationClassFilter().filter(configurations);
fireAutoConfigurationImportEvents(configurations, exclusions);
return new AutoConfigurationEntry(configurations, exclusions);
}
获取到所有需要导入容器中的自配置类,经过断点调试表示有127个
3️⃣怎么得到的这127个自动配置类呢?
就是在getCandidateConfigurations
方法中,利用工厂加载,得到所有组件
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
//在这里调用了工厂的加载,Spring的工厂加载类
List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),
getBeanClassLoader());
Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you "
+ "are using a custom packaging, make sure that file is correct.");
return configurations;
}
loadFactoryNames
又会去调用loadSpringFactories
这个方法
4️⃣ loadSpringFactories
方法中,会从META-INF/spring.factories
位置来加载一个文件,默认会去扫描我们当前系统里面所有META-INF/spring.factories
这个位置的文件
private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
MultiValueMap<String, String> result = cache.get(classLoader);
if (result != null) {
return result;
}
try {
//重点就是这里,classLoader.getResources,这里会去获取一个资源文件,文件的路径为FACTORIES_RESOURCE_LOCATION,这个常量在本文件的上面定义的值为:"META-INF/spring.factories"
Enumeration<URL> urls = (classLoader != null ?
classLoader.getResources(FACTORIES_RESOURCE_LOCATION) :
ClassLoader.getSystemResources(FACTORIES_RESOURCE_LOCATION));
//后续的一些操作
result = new LinkedMultiValueMap<>();
while (urls.hasMoreElements()) {
URL url = urls.nextElement();
UrlResource resource = new UrlResource(url);
Properties properties = PropertiesLoaderUtils.loadProperties(resource);
for (Map.Entry<?, ?> entry : properties.entrySet()) {
String factoryTypeName = ((String) entry.getKey()).trim();
for (String factoryImplementationName : StringUtils.commaDelimitedListToStringArray((String) entry.getValue())) {
result.add(factoryTypeName, factoryImplementationName.trim());
}
}
}
cache.put(classLoader, result);
return result;
}
catch (IOException ex) {
throw new IllegalArgumentException("Unable to load factories from location [" +
FACTORIES_RESOURCE_LOCATION + "]", ex);
}
}
5️⃣ 查看依赖中这个位置的文件
默认扫描我们当前系统里面所有META-INF/spring.factories位置的文件。比如在我们的依赖中:
在spring-boot-autoconfigure-2.3.4.RELEASE.jar
中也存在META-INF/spring.factories
,这里面指定了127个关于自动配置的包,就是我们在第二步中看到的需要导入容器中的127个配置类
也就是说在这个包里面的文件里写死了springboot一启动就要给容器加载的所有配置类,一共有127个。
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\
org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\
org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\
org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\
org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\
org.springframework.boot.autoconfigure.context.LifecycleAutoConfiguration,\
org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration,\
org.springframework.boot.autoconfigure.couchbase.CouchbaseAutoConfiguration,\
org.springframework.boot.autoconfigure.dao.PersistenceExceptionTranslationAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraReactiveDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraReactiveRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseReactiveDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseReactiveRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ReactiveElasticsearchRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ReactiveElasticsearchRestClientAutoConfiguration,\
org.springframework.boot.autoconfigure.data.jdbc.JdbcRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.ldap.LdapRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoReactiveDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoReactiveRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.mongo.MongoRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.neo4j.Neo4jDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.neo4j.Neo4jRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.solr.SolrRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.r2dbc.R2dbcDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.r2dbc.R2dbcRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.r2dbc.R2dbcTransactionManagerAutoConfiguration,\
org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,\
org.springframework.boot.autoconfigure.data.redis.RedisReactiveAutoConfiguration,\
org.springframework.boot.autoconfigure.data.redis.RedisRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.rest.RepositoryRestMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.data.web.SpringDataWebAutoConfiguration,\
org.springframework.boot.autoconfigure.elasticsearch.ElasticsearchRestClientAutoConfiguration,\
org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration,\
org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration,\
org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAutoConfiguration,\
org.springframework.boot.autoconfigure.gson.GsonAutoConfiguration,\
org.springframework.boot.autoconfigure.h2.H2ConsoleAutoConfiguration,\
org.springframework.boot.autoconfigure.hateoas.HypermediaAutoConfiguration,\
org.springframework.boot.autoconfigure.hazelcast.HazelcastAutoConfiguration,\
org.springframework.boot.autoconfigure.hazelcast.HazelcastJpaDependencyAutoConfiguration,\
org.springframework.boot.autoconfigure.http.HttpMessageConvertersAutoConfiguration,\
org.springframework.boot.autoconfigure.http.codec.CodecsAutoConfiguration,\
org.springframework.boot.autoconfigure.influx.InfluxDbAutoConfiguration,\
org.springframework.boot.autoconfigure.info.ProjectInfoAutoConfiguration,\
org.springframework.boot.autoconfigure.integration.IntegrationAutoConfiguration,\
org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.JndiDataSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.XADataSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.JmsAutoConfiguration,\
org.springframework.boot.autoconfigure.jmx.JmxAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.JndiConnectionFactoryAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.activemq.ActiveMQAutoConfiguration,\
org.springframework.boot.autoconfigure.jms.artemis.ArtemisAutoConfiguration,\
org.springframework.boot.autoconfigure.jersey.JerseyAutoConfiguration,\
org.springframework.boot.autoconfigure.jooq.JooqAutoConfiguration,\
org.springframework.boot.autoconfigure.jsonb.JsonbAutoConfiguration,\
org.springframework.boot.autoconfigure.kafka.KafkaAutoConfiguration,\
org.springframework.boot.autoconfigure.availability.ApplicationAvailabilityAutoConfiguration,\
org.springframework.boot.autoconfigure.ldap.embedded.EmbeddedLdapAutoConfiguration,\
org.springframework.boot.autoconfigure.ldap.LdapAutoConfiguration,\
org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration,\
org.springframework.boot.autoconfigure.mail.MailSenderAutoConfiguration,\
org.springframework.boot.autoconfigure.mail.MailSenderValidatorAutoConfiguration,\
org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongoAutoConfiguration,\
org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration,\
org.springframework.boot.autoconfigure.mongo.MongoReactiveAutoConfiguration,\
org.springframework.boot.autoconfigure.mustache.MustacheAutoConfiguration,\
org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration,\
org.springframework.boot.autoconfigure.quartz.QuartzAutoConfiguration,\
org.springframework.boot.autoconfigure.r2dbc.R2dbcAutoConfiguration,\
org.springframework.boot.autoconfigure.rsocket.RSocketMessagingAutoConfiguration,\
org.springframework.boot.autoconfigure.rsocket.RSocketRequesterAutoConfiguration,\
org.springframework.boot.autoconfigure.rsocket.RSocketServerAutoConfiguration,\
org.springframework.boot.autoconfigure.rsocket.RSocketStrategiesAutoConfiguration,\
org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration,\
org.springframework.boot.autoconfigure.security.servlet.UserDetailsServiceAutoConfiguration,\
org.springframework.boot.autoconfigure.security.servlet.SecurityFilterAutoConfiguration,\
org.springframework.boot.autoconfigure.security.reactive.ReactiveSecurityAutoConfiguration,\
org.springframework.boot.autoconfigure.security.reactive.ReactiveUserDetailsServiceAutoConfiguration,\
org.springframework.boot.autoconfigure.security.rsocket.RSocketSecurityAutoConfiguration,\
org.springframework.boot.autoconfigure.security.saml2.Saml2RelyingPartyAutoConfiguration,\
org.springframework.boot.autoconfigure.sendgrid.SendGridAutoConfiguration,\
org.springframework.boot.autoconfigure.session.SessionAutoConfiguration,\
org.springframework.boot.autoconfigure.security.oauth2.client.servlet.OAuth2ClientAutoConfiguration,\
org.springframework.boot.autoconfigure.security.oauth2.client.reactive.ReactiveOAuth2ClientAutoConfiguration,\
org.springframework.boot.autoconfigure.security.oauth2.resource.servlet.OAuth2ResourceServerAutoConfiguration,\
org.springframework.boot.autoconfigure.security.oauth2.resource.reactive.ReactiveOAuth2ResourceServerAutoConfiguration,\
org.springframework.boot.autoconfigure.solr.SolrAutoConfiguration,\
org.springframework.boot.autoconfigure.task.TaskExecutionAutoConfiguration,\
org.springframework.boot.autoconfigure.task.TaskSchedulingAutoConfiguration,\
org.springframework.boot.autoconfigure.thymeleaf.ThymeleafAutoConfiguration,\
org.springframework.boot.autoconfigure.transaction.TransactionAutoConfiguration,\
org.springframework.boot.autoconfigure.transaction.jta.JtaAutoConfiguration,\
org.springframework.boot.autoconfigure.validation.ValidationAutoConfiguration,\
org.springframework.boot.autoconfigure.web.client.RestTemplateAutoConfiguration,\
org.springframework.boot.autoconfigure.web.embedded.EmbeddedWebServerFactoryCustomizerAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.HttpHandlerAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.ReactiveWebServerFactoryAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.WebFluxAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.error.ErrorWebFluxAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.function.client.ClientHttpConnectorAutoConfiguration,\
org.springframework.boot.autoconfigure.web.reactive.function.client.WebClientAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.error.ErrorMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.HttpEncodingAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.MultipartAutoConfiguration,\
org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.reactive.WebSocketReactiveAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.servlet.WebSocketServletAutoConfiguration,\
org.springframework.boot.autoconfigure.websocket.servlet.WebSocketMessagingAutoConfiguration,\
org.springframework.boot.autoconfigure.webservices.WebServicesAutoConfiguration,\
org.springframework.boot.autoconfigure.webservices.client.WebServiceTemplateAutoConfiguration
注解原理的流程:
5.2 按需开启自动配置项
虽然我们127个场景的所有自动配置类,在启动的时候默认全部加载。但是,最终按照条件装配规则,会按需配置。
比如看autoconfigure包下的aop,按需配置要求只有导入了AOP相关的包才可以生效,比如Advice
package org.springframework.boot.autoconfigure.aop;
略···
@Configuration(proxyBeanMethods = false)
//判断配置文件中是否有spring.aop相关的配置,如果存在这个配置且spring.aop.auto的值为true,那么下面就会生效。但是matchIfMissing属性为true,就是说就算你没有配置我还是认为你生效了,所以这个配置类会生效,但是类里面的内容,往下看,是不会生效的,就是说相关的bean不会注入到容器中
@ConditionalOnProperty(prefix = "spring.aop", name = "auto", havingValue = "true", matchIfMissing = true)
public class AopAutoConfiguration {
//说明这个类是个配置类
@Configuration(proxyBeanMethods = false)
//这里指定了必须有AOP,aspectj包下的Advice才可以进行装配
@ConditionalOnClass(Advice.class)
//所以说这个类不会生效
static class AspectJAutoProxyingConfiguration {...}
//这个类是个配置类
@Configuration(proxyBeanMethods = false)
//如果没有aspectj包下的Advice,这个类就会生效
@ConditionalOnMissingClass("org.aspectj.weaver.Advice")
//判断配置文件中是否有指定的配置项,就算没有也认为有,会使这个判断条件通过
@ConditionalOnProperty(prefix = "spring.aop", name = "proxy-target-class", havingValue = "true",
matchIfMissing = true)
//因此这个类会生效,会被注入到容器中,但是这个类只是提供了很简单的AOP功能
static class ClassProxyingConfiguration{...}
}
自动配置的核心
启动加载所有的自动配置类,最终按需进行配置
5.3 自动配置的流程⭐️
以以下两个自动配置类的自动配置流程为例
DispatcherServletAutoConfiguration
//配置类的配置顺序,指定优先级
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE)
//说明这个类是一个配置类
@Configuration(proxyBeanMethods = false)
//判断当前应用是否为一个WEB应用,且是原生的Servlet模式
@ConditionalOnWebApplication(type = Type.SERVLET)
//条件装配,需要有DispatcherServlet这个类,我们开发web应用肯定是引入了SpringMVC的依赖,所以会有这个类的
@ConditionalOnClass(DispatcherServlet.class)
//在ServletWebServerFactoryAutoConfiguration这个配置类配置完成之后再来配置当前类
@AutoConfigureAfter(ServletWebServerFactoryAutoConfiguration.class)
public class DispatcherServletAutoConfiguration {
//略去中间
//我是一个配置类
@Configuration(proxyBeanMethods = false)
//
@Conditional(DefaultDispatcherServletCondition.class)
//容器中是否有ServletRegistration这个组件,这个组件对于web开发肯定有,只有导入Tomcat肯定就会有
@ConditionalOnClass(ServletRegistration.class)
//EnableConfigurationProperties使用配置绑定,
//两个功能:1、让WebMvcProperties这个类去绑定配置文件中spring.mvc开头的属性,就是封装这个属性。2、封装好了之后,就会将WebMvcProperties这个类注册到容器当中,那么以后容器中就会有这个类型的组件
@EnableConfigurationProperties(WebMvcProperties.class)
//条件判断完成之后,就直接造了个DispatcherServlet实例并交给容器管理
protected static class DispatcherServletConfiguration {
//给容器中注册这个类型的组件,里面就是自己new了一个DispatcherServlet对象,对象中的属性都是从webMvcProperties取得。因此我们SpringMVC的核心DispatcherServlet就配置好了
@Bean(name = DEFAULT_DISPATCHER_SERVLET_BEAN_NAME)
public DispatcherServlet dispatcherServlet(WebMvcProperties webMvcProperties) {
DispatcherServlet dispatcherServlet = new DispatcherServlet();
dispatcherServlet.setDispatchOptionsRequest(webMvcProperties.isDispatchOptionsRequest());
dispatcherServlet.setDispatchTraceRequest(webMvcProperties.isDispatchTraceRequest());
dispatcherServlet.setThrowExceptionIfNoHandlerFound(webMvcProperties.isThrowExceptionIfNoHandlerFound());
dispatcherServlet.setPublishEvents(webMvcProperties.isPublishRequestHandledEvents());
dispatcherServlet.setEnableLoggingRequestDetails(webMvcProperties.isLogRequestDetails());
return dispatcherServlet;
}
//给容器中加入文件上传解析器
@Bean //这个组件的名称就是方法名
@ConditionalOnBean(MultipartResolver.class)//容器中有这个组件
@ConditionalOnMissingBean(name = DispatcherServlet.MULTIPART_RESOLVER_BEAN_NAME)//容器中没有这个名字的组件multipartResolver
public MultipartResolver multipartResolver(MultipartResolver resolver) {
//给@Bean标注的方法传入了对象参数,这个参数的值就会从容器中找
//防止有些用户配置的文件上传解析器名称不符合规范。
//就会从容器中获取到用户配置的bean,然后再返回,返回时这个bean的名称就是当前方法的名称,名称就规范了
// Detect if the user has created a MultipartResolver but named it incorrectly
return resolver;
}
}
//这个类将会读取配置文件中所有的mvc的配置
@ConfigurationProperties(prefix = "spring.mvc")
public class WebMvcProperties {}
WebMvcProperties这个类和配置文件中的spring.mvc
开头的配置绑定,如果配置文件中不指定,就会使用这个类中提供的默认值
总结:
- 这个自动配置类只有引入了SpringMVC相关依赖才会生效
- 自动配置类中DispatcherServletConfiguration配置类让WebMvcProperties绑定配置了文件,与配置文件中spring.mvc开头的属性绑定
- 向容器中注册了一个DispatcherServlet实例,其中的属性都是依靠WebMvcProperties的属性,而WebMvcProperties绑定了配置文件。所以说如果用户配置了SpringMVC相关的属性,用户配置优先,如果没有配置使用就会使用WebMvcProperties中的默认值。
- 文件上传解析器的bean方法从容器中获取了实例又直接返回,是为了防止用户命名不规范的情况
HttpEncodingAutoConfiguration
//配置类注解
@Configuration(proxyBeanMethods = false)
//配置绑定,ServerProperties绑定配置文件,可以通过配置文件来更改属性值
@EnableConfigurationProperties(ServerProperties.class)
//配置是否为原生的servlet应用
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
//只要导入了SpringMVC就会有这个类
@ConditionalOnClass(CharacterEncodingFilter.class)
//看配置文件中是否有这个属性,如果没有配置,也认为是有配置的并给出默认值
@ConditionalOnProperty(prefix = "server.servlet.encoding", value = "enabled", matchIfMissing = true)
public class HttpEncodingAutoConfiguration {
private final Encoding properties;
//构造器中传入ServerProperties组件,这个组件就是配置绑定类
public HttpEncodingAutoConfiguration(ServerProperties properties) {
this.properties = properties.getServlet().getEncoding();
}
//向容器中注入这个类型的组件
@Bean
//容器中如果没有配置这个,那么这里就会去配置
@ConditionalOnMissingBean
public CharacterEncodingFilter characterEncodingFilter() {
CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
filter.setEncoding(this.properties.getCharset().name());
filter.setForceRequestEncoding(this.properties.shouldForce(Encoding.Type.REQUEST));
filter.setForceResponseEncoding(this.properties.shouldForce(Encoding.Type.RESPONSE));
return filter;
}
}
从这两个例子中可以发现:
- SpringBoot默认会在底层配置好所有的组件。但是如果用户自己配置了,那么用户配置的优先(经常见到
@ConditionalOnMissingBean
这个注解,就是当容器中没有这个bean的时候我才会自动给你配置)
- 比如你想自己配置CharacterEncodingFilter,那么只需要在配置类中进行配置即可,框架底层就不会去配置这个了
5.4 总结:
-
SpringBoot会先加载所有的自动配置类,xxxAutoConfiguration
-
每个自动配置类按照条件进行生效,默认都会都会绑定配置文件指定的值,xxxProperties这些类中拿,这些类和配置文件进行了绑定
-
生效的配置类就会给容器中装配很多组件
-
只要容器中有这些组件,相当于这些功能就有了
-
只要用户有自己配置的,就以用户的优先
-
定制化配置,两种方法:
- 用户自己使用@Bean来替换底层的组件
- (更常用)用户去看这个组件是获取的配置文件什么值,去修改就行
就是说,底层的自动配置类依赖于我们是否引入了相应的场景,如果我们没有引入那么就不会去创建配置类。配置类中,创建组件时先判断容器中是否已经存在了用户创建的组件,如果有,底层就不去创建,即用户优先。如果没有,底层创建组件,但是组件中的属性都是和配置文件进行绑定的,用户可以很方便的去修改。
xxxxxAutoConfiguration ---> 组件 ---> xxxxProperties里面拿值 ----> application.properties
5.5 最佳实践
1、引入场景依赖(starters)
2、查看自动配置了哪些(选做)
- 自己分析,引入场景
- 在配置文件中写
debug=true
,开启自动配置报告,就可以看到所有没有生效和生效的自动配置类及其原因
3、是否需要修改
-
参考文档修改配置项
- docs.spring.io/spring-boot…
- 自己分析。xxxProperties绑定了配置文件的哪些。
这些属性在配置文件中修改就可
自定义加入或替换组件,@Bean、@Component
自定义器XXXCustomizer