SpringBoot(2.4.0)自动配置原理(源码)
一、从@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 {.....
}
出现3个重要注解:
- @SpringBootConfiguration
- @EnableAutoConfiguration
- @ComponentScan
二、@SpringBootConfiguration(标注当前类是配置类)
为什么@SpringBootApplication注解里没有包含@Configuration
,实际上是在@SpringBootConfiguration里面。
- 源码:
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {@AliasFor(annotation = Configuration.class)boolean proxyBeanMethods() default true;
}
@SpringBootConfiguration继承自@Configuration,二者功能也一致,标注当前类是配置类,
并会将当前类内声明的一个或多个以@Bean注解标记的方法的实例纳入到spring容器中,并且实例名就是方法名。实际上如果我们使用如下的Springboot启动类,整个SpringBoot应用依然可以与之前的启动类功能对等。
@Configuration
@EnableAutoConfiguration
@ComponentScan
public class Application {public static void main(String[] args) {SpringApplication.run(Application.class, args);}
}
三、@EnableAutoConfiguration(根据类路径下的jar包依赖为当前项目进行自动配置)
- 若看过Spring框架的源码,是否记得spring框架提供的各种名字为@Enable开头的Annotation定义?
比如@EnableScheduling,@EnableCaching,@EnableMBeanExport等
@EnableAutoConfiguration的理念和"做事方式"其实一脉相承,借助@Import的支持,收集和注册特定场景相关的bean定义:
- @EnableScheduling是通过@Import将Spring调度框架相关的bean定义都加载到Ioc容器中。
- @EnableMBeanExport是通过@Import将JMX相关的bean定义加载到Ioc容器
- @EnableAutoConfiguration也是借助@Import的帮助,
将所有符合自动配置条件的bean定义加载到Ioc容器,仅此而已
- @EnableAutoConfiguration源码
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";Class<?>[] exclude() default {};String[] excludeName() default {};
}
@AutoConfigurationPackage
,@Import({AutoConfigurationImportSelector.class})
又得好好研究
- @AutoConfigurationPackage(自动配置包?指定默认包规则)
- 它指定了默认的包规则
- 源码:
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import({Registrar.class})
//利用Registrar给容器中导入一系列组件
//将指定的一个包下的所有组件导入进来,也即是MainApplication 所在包下。
public @interface AutoConfigurationPackage {String[] basePackages() default {};Class<?>[] basePackageClasses() default {};
}
那就要看看Registrar这个类了:
里面这段代码,就是批量注册:
static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {Registrar() {}public void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) {//这里就是利用元注解,获取到元注解所作用在的类(其实就是main方法,如下图)的包名//然后,将其包名下的所有使用了@Configuration注解的类一并加载进来AutoConfigurationPackages.register(registry, (String[])(new AutoConfigurationPackages.PackageImports(metadata)).getPackageNames().toArray(new String[0]));}public Set<Object> determineImports(AnnotationMetadata metadata) {return Collections.singleton(new AutoConfigurationPackages.PackageImports(metadata));}}
- @Import({AutoConfigurationImportSelector.class})
- AutoConfigurationImportSelector.class有一个 selectImports方法
//该方法就是规定要导入哪些包public String[] selectImports(AnnotationMetadata annotationMetadata) {if (!this.isEnabled(annotationMetadata)) {return NO_IMPORTS;} else {AutoConfigurationImportSelector.AutoConfigurationEntry autoConfigurationEntry = this.getAutoConfigurationEntry(annotationMetadata);return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());}}
可以看到,核心就是getAutoConfigurationEntry
方法,进去看一下:
我们又发现,configurations的获得是依赖getCandidateConfigurations
方法的,进去看看,就可以看到自动配置的幕后英雄:SpringFactoriesLoader
自动配置的幕后英雄:SpringFactoriesLoader
SpringFactoriesLoader的主要功能就是从指定的配置文件META/spring.factories加载配置,spring.factories是一个典型的java properties文件,配置格式为Key-Value形式,只不过Key和Value都是Java类型的完整类名。
进入loadFactoryNames()方法,就发现loadFactoryNames()读取了ClassPath下面的 META-INF/spring.factories 文件。
@EnableAutoConfiguration的场景中,它更多是提供一种配置查找的功能支持,即根据@EnableAutoConfiguration的完整类名org.springframework.boot.autoconfigure.EnableAutoConfiguration作为查找的key,获取对应的一组@Configuration类
- 总结:
- 1、利用getAutoConfigurationEntry(annotationMetadata);给容器中批量导入一些组件
- 2、调用List configurations = getCandidateConfigurations(annotationMetadata, attributes)获取到所有需要导入到容器中的配置类
- 3、利用工厂加载 Map<String, List> loadSpringFactories(@Nullable ClassLoader classLoader);得到所有的组件
- 4、从META-INF/spring.factories位置来加载一个文件。默认扫描我们当前系统里面所有META-INF/spring.factories位置的文件
spring-boot-autoconfigure-2.4.0.RELEASE.jar包里面也有META-INF/spring.factories
在spring-boot-autoconfigure-2.4.0.RELEASE.jar包里的META-INF/spring.factories文件,写死了spring-boot一启动就要给容器中加载的所有配置类
,但是你我肯定都知道,不会一下子加载那么多,那么就是另一个内容了:按需加载
开启按需加载
SpringBoot自动配置是需要满足相应的条件才会自动配置,因此SpringBoot的自动配置大量应用了条件注解ConditionalOnXXX。如下图:
上面这些注解会被使用在各个组件上面,然后会根据环境决定是否导入各个组件,实现按需导入,源码分析
四、@ComponentScan (自动扫描并加载符合条件的组件或者bean定义)
@ComponentScan的功能其实就是自动扫描并加载符合条件的组件或bean定义,最终将这些bean定义加载到容器中。我们可以通过basePackages等属性指定@ComponentScan自动扫描的范围,如果不指定,则默认Spring框架实现从声明@ComponentScan所在类的package进行扫描,默认情况下是不指定的,所以SpringBoot的启动类最好放在root package下。
五、SpringBootApplication注解中4个方法
@SpringBootApplication不仅包括上面的三个重要注解,还包含有4个方法:
- Class<?>[] exclude() default {}; 根据Class来排除特定的类加入Spring容器,传入参数是class类型
- String[] excludeName() default {}; 根据Class name排除特定的类加入spring容器,传入参数是class的全类名字符串数组
- String[] scanBasePackages() default {};指定扫描包,参数是包名的字符串数组
- Class<?>[] scanBasePackageClasses() default {};指定扫描包,参数是Class类型数组
六、修改组件默认配置
SpringBoot默认会在底层配好所有的组件。但是如果用户自己配置了以用户的优先
平时我们都是直接再写一个bean注入到容器的
其实直接修改配置文件就好了。
原理如下:源码以HttpEncodingAutoConfiguration
为例:
@Configuration(proxyBeanMethods = false
)
@EnableConfigurationProperties({ServerProperties.class})
@ConditionalOnWebApplication(type = Type.SERVLET
)
@ConditionalOnClass({CharacterEncodingFilter.class})
@ConditionalOnProperty(prefix = "server.servlet.encoding",value = {"enabled"},matchIfMissing = true
)
public class HttpEncodingAutoConfiguration {private final Encoding properties;public HttpEncodingAutoConfiguration(ServerProperties properties) {this.properties = properties.getServlet().getEncoding();}@Bean@ConditionalOnMissingBeanpublic CharacterEncodingFilter characterEncodingFilter() {CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();filter.setEncoding(this.properties.getCharset().name());filter.setForceRequestEncoding(this.properties.shouldForce(org.springframework.boot.web.servlet.server.Encoding.Type.REQUEST));filter.setForceResponseEncoding(this.properties.shouldForce(org.springframework.boot.web.servlet.server.Encoding.Type.RESPONSE));return filter;}}
从@EnableConfigurationProperties({ServerProperties.class})可知,该类已经与配置文件绑定了,所以,如果你改变filter.setEncoding(this.properties.getCharset().name());
只需要溯源改变server.servlet.encoding.charset
的值就可以了
- 总结:
• SpringBoot先加载所有的自动配置类 xxxxxAutoConfiguration
• 每个自动配置类按照条件进行生效,默认都会绑定配置文件指定的值。xxxxProperties里面拿。 xxxProperties和配置文件进行了绑定
• 生效的配置类就会给容器中装配很多组件
• 只要容器中有这些组件,相当于这些功能就有了
• 定制化配置
• 用户直接自己@Bean替换底层的组件
• 用户去看这个组件是获取的配置文件什么值就去修改。
xxxxxAutoConfiguration —> 加载组件 —> xxxxProperties里面拿值 ----> application.properties
参考文章
SpringBoot(2.4.0)自动配置原理(源码)相关推荐
- SpringBoot自动配置【源码分析】-初始加载自动配置类
@Import(AutoConfigurationImportSelector.class) 1.利用getAutoConfigurationEntry(annotationMetadata);给容器 ...
- SpringBoot面试杀手锏——自动配置原理
欢迎关注方志朋的博客,回复"666"获面试宝典 来源:blog.csdn.net/u014745069/ article/details/83820511 引言 不论在工作中,亦或 ...
- Spring Boot 面试杀手锏:自动配置原理
欢迎关注方志朋的博客,回复"666"获面试宝典 不论在工作中,亦或是求职面试,Spring Boot已经成为我们必知必会的技能项.除了某些老旧的政府项目或金融项目持有观望态度外,如 ...
- Spring Boot 面试杀手锏—自动配置原理
点击关注公众号,回复"1024"获取2TB学习资源! 引言 不论在工作中,亦或是求职面试,Spring Boot已经成为我们必知必会的技能项.除了某些老旧的政府项目或金融项目持有观 ...
- Spring Boot面试杀手锏————自动配置原理
引言 不论在工作中,亦或是求职面试,Spring Boot已经成为我们必知必会的技能项.除了某些老旧的政府项目或金融项目持有观望态度外,如今的各行各业都在飞速的拥抱这个已经不是很新的Spring启动框 ...
- SpringBoot 自动配置原理
创建项目 通过Spring Initialize创建SpringBoot项目 而接下来要说的是关于配置文件的事情.关乎配置文件可以参考官方文档. 对于配置文件来说到底在配置文件里面可以进行配置那些内容 ...
- SpringBoot 自动配置原理(超级无敌详细)-2
SpringBoot 自动配置原理(超级无敌详细)-1 2.自动配置的实现 刚刚我们整体的过了一下主配置文件是如何实现的,但我们还没深入的研究如何实现自动装配功能.我们回到这个文件下,找一个具体的自动 ...
- 这样讲 SpringBoot 自动配置原理,你应该能明白了吧
点击上方"方志朋",选择"设为星标" 回复"666"获取新整理的面试资料 作者:你在我家门口 juejin.im/post/5ce5effb ...
- 3springboot:springboot配置文件(外部配置加载顺序、自动配置原理,@Conditional)
1.外部配置加载顺序 SpringBoot也可以从以下位置加载配置: 优先级从高到低 高优先级的配置覆盖低优先级的配置,所有的配置会形成互补配置 1.命令行参数 所有的配置都可以在命令行上进行指定 ...
最新文章
- 单帧风景照变延时摄影,分分钟搞定,还能有昼夜变化,这是来自日本的开源动画景观算法...
- python与c语言在语法上的区别-论c++/java/c 与python的语法上的区别
- 类别选择器在HTML中如何表示,CSS类别选择器
- BZOJ-2440 (莫比乌斯函数)
- 关于计算机的英语作文九年级,实用的九年级英语作文合集6篇
- P3067 [USACO12OPEN]Balanced Cow Subsets G 折半搜索
- COM原理及应用之可连接对象
- iOS端(腾讯Bugly)闪退异常上报扑获日志集成与使用指南
- 怎样学习(3):迭代学习,精益求精
- java: Iterator的使用
- arm-none-linux-gnueabi-gcc:未找到命令,arm-none-linux-gnueabi-gcc编译标准库引用
- 微信使用OD逆向HOOK的一些心得
- 中美两国10万级作业调度工具 “TaskCtl“ Vs “Control-M“ 到底该如何选用?
- WIFI实践入门--基本命令--iwconfig
- (详细)华为荣耀8青春 PRA-AL00的usb调试模式在哪里开启的流程
- 如何搭建一套业务、数据一体化的数据指标体系
- js正则表达式及语法
- Array.reduce()的用法与进阶
- Python实现批量修改并替换txt文本中内容
- 2018东华计算机复试,18东华双控初试复试经验
热门文章
- Codeforces 1015F Bracket Substring AC自动机 + dp
- Ubuntu升级python版本
- android 录屏
- poj12652954 [皮克定理 格点多边形]【学习笔记】
- Html5 dragdrop
- 解决Android抽屉被击穿问题
- (转载)MultiAnimation
- .sln from VS2005 convert to VS2008
- WPF开发中遇到的问题及解决系列(一):How can I programmatically click a Button
- 【笔记】基于轻量和积网络及无人机遥感图像的大豆田杂草识别