SpringBoot 学习笔记 Part04
1. 引导加载自动配置类
springboot中最重要的注解之一就是主类注解@SpringBootApplication了,它包含3个我们熟悉的注解:
- @SpringBootConfiguration:父注解为@Configuration,代表当前是一个配置类。
- @EnableAutoConfiguration:(最重要)下面细说。
- @ComponentScan:包扫描注解,指定springboot要扫描的哪些包。
以下为源码。
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
excludeFilters = {@Filter(
type = FilterType.CUSTOM,
classes = {TypeExcludeFilter.class}
), @Filter(
type = FilterType.CUSTOM,
classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
public static void main(String[] args) {
ConfigurableApplicationContext run = SpringApplication.run(MainApplication.class, args);
}
}
@EnableAutoConfiguration 也是个合成注解,其中包含2个注解:
- @AutoConfigurationPackage:(1.1介绍)
- @Import:(1.2介绍)
源码如下。
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {}
1.1 自动包规则
一句话来说,就是springboot使用 @AutoConfigurationPackage 这个注解指定了默认的包规则。
@AutoConfigurationPackage详解: 该注解存在一个父注解为 @Import({Registrar.class}) ,它利用Registrar给容器中导入一系列组件,源码如下。
@Import({Registrar.class})
public @interface AutoConfigurationPackage {}
Registrar在之前学习过,该实现类的接口用于给容器中批量注册组件。而@Import标注在哪个类,Registrar就会获取这个类的所有源信息。不难看出,Registrar获取的就是我们 @SpringBootApplication 标注的 MainApplication.java 主类的源信息。
我们Debug调试 Registrar 源码蓝色光标这行代码,可以发现获取到的包名为”com.swz”。不难推出,获取到的包名就是我们主类所在的包。它把包名封装到数组里面去,然后把这个包下的所有组件批量注册进容器中去。
总结:回忆之前的学习,主类所在的包将会自动扫描,我们现在发现Registrar做的就是这件事情,这就把之前存在的疑惑解释通了。
1.2 初始加载自动配置类
@Import({AutoConfigurationImportSelector.class})里有有一个字节码文件,我们分析一下这个类的源码。
不难发现,所有的配置信息都是调用蓝色光标中的代码得到的,所以我们分析一下该代码。
this.getAutoConfigurationEntry(annotationMetadata)的作用是给容器中批量导入一些组件。
debug进入该方法:
1.调用 List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes),这个方法将获取到所有需要导入到容器中的配置类的全类名。
2.调用 Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader),这个方法将加载工厂,来得到所有的组件。
分析:该方法内部有一个classLoader.getResources(FACTOREIS_RESOURCE_LOCATION),而这个工厂资源文件位置为FACTOREIS_RESOURCE_LOCATION=META-INF/spring.factories。
分析过后可以总结出,调用的这个方法是在从META-INF/spring.factories位置来加载一个文件的。它默认扫描我们当前系统里面所有META-INF/spring.factories位置的文件。
spring-boot-autoconfigure-2.3.4.RELEASE.jar包里面也有META-INF/spring.factories,观察源码可以发现,文件里面写死了spring-boot一启动就要给容器中加载的所有配置类。
但是,这些写死的需要加载的配置类xxxAutoConfiguration有100多个,springboot都会为加载吗?这就引出了自动配置原理的第二个部分——按需开启自动配置项。
2. 按需开启自动配置项
虽然我们100多个场景的所有自动配置启动的时候默认全部加载。但这些配置类都会按照条件装配规则(@Conditional),来决定最终是否配置。
随便看一个自动配置类的源码,我们以aop的为例,可以看到出现了许多按条件装配的注解。
3. 修改默认配置
首先我们先来看两个默认配置的源代码,了解一下springboot底层默认配置是怎么实现的。
文件上传解析器的一段源码如下:
@Bean //给@Bean标注的方法若有形参,则这个形参的值就会从容器中找
@ConditionalOnBean(MultipartResolver.class) //条件装配:容器中有这个类型组件
@ConditionalOnMissingBean(name = DispatcherServlet.MULTIPART_RESOLVER_BEAN_NAME) //条件装配:容器中没有以 multipartResolver 为名的组件
public MultipartResolver multipartResolver(MultipartResolver resolver) {
//方法体只有一句return,不难看出,这个方法的作用是为了防止有些用户配置的文件上传解析器的id不符合规范
return resolver;
}
字符编码过滤器的一段源码如下:
@Bean
@ConditionalOnMissingBean //条件装配:没有这个类型的组件
public CharacterEncodingFilter characterEncodingFilter() {
//代码段略,功能为设置字符编码格式为utf-8
}
如何修改默认配置呢?方法也很简单:
xxxAutoConfiguration → 组件 → xxxProperties里面找到key值 → application.properties里重写key值覆盖
例如,servlet编码格式springboot默认为utf-8,我们可以在application.properties进行重写修改。
server.servlet.encoding.charset=GBK
4. 总结
SpringBoot默认会先加载所有的自动配置类,自动配置类是那些以 xxxAutoConfiguration 命名格式的类。
但每个自动配置类按照条件进行生效,默认都会绑定配置文件指定的值,在其对应的xxxProperties里面拿,再将xxxProperties和配置文件进行了绑定。
生效的配置类就会给容器中注入很多组件。容器中有了这些组件,相当于对应的功能就有了。
我们也可以对每个自动配置类的 xxxProperties 进行定制化配置,其中有两个方法:
-
用户直接自写一个 @Bean 替换底层的组件
-
用户去官方文档 https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#application-properties 查看对应配置文件的key值,或前往springboot底层直接查看这个组件是获取的配置文件、什么key值,再去 application.properties 里修改。
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。
文章由极客之音整理,本文链接:https://www.bmabk.com/index.php/post/84479.html