当前位置:   article > 正文

springboot是怎么实现自动配置的?_springboot自动配置

springboot自动配置

一、springboot是对spring框架做的一系列优化,减少了大量繁琐的配置,并提供了内置web服务器,让程序运行更快。

1.springboot起步依赖:简单的说,起步依赖就是将具备某种功能的坐标打包到一起,并提供一些默认的功能。

2.自动配置Spring以及第三方功能:

SpringBoot是基于约定的,所以很多配置都有默认值,但如果想使用自己的配置替换默认配置的话,就可以使用application.properties或者application.yml(application.yaml)进行配置。

首先打开spring boot项目在springboot的引导类有一个@SpringBootApplication注解:

  1. @Target({ElementType.TYPE}) //修饰类或接口、枚举
  2. @Retention(RetentionPolicy.RUNTIME)//注解在源码,class文件中存在且运行时可以通过反射机制获取到
  3. @Documented//可以在api文档显示
  4. @Inherited//子类可以继承该注解
  5. @SpringBootConfiguration //配置类
  6. @EnableAutoConfiguration//开启自动装配
  7. @ComponentScan //扫描 (不指明包名则默认范围自己所在包及其子类下)
  8. (
  9. excludeFilters = {@Filter(
  10. type = FilterType.CUSTOM,
  11. classes = {TypeExcludeFilter.class}
  12. ), @Filter(
  13. type = FilterType.CUSTOM,
  14. classes = {AutoConfigurationExcludeFilter.class}
  15. )}
  16. )

除了基本的元注解外,还有两个。其中:@@SpringBootConfiguration的里面核心是

  1. @Target({ElementType.TYPE})
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. @Configuration//spring的配置类
  5. public @interface SpringBootConfiguration {
  6. @AliasFor(
  7. annotation = Configuration.class
  8. )
  9. boolean proxyBeanMethods() default true;
  10. }

表明启动类其实也是一个配置类。还有一个是@EnableAutoConfiguration,根据名称翻译就是开启自动配置。它里面包含了如下注解:

  1. @Target({ElementType.TYPE})
  2. @Retention(RetentionPolicy.RUNTIME)
  3. @Documented
  4. @Inherited
  5. @AutoConfigurationPackage
  6. @Import({AutoConfigurationImportSelector.class})
  7. public @interface EnableAutoConfiguration {
  8. String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
  9. Class<?>[] exclude() default {};
  10. String[] excludeName() default {};
  11. }

可以看到@AutoConfigurationPackage和@Import({AutoConfigurationImportSelector.class})注解加起来就是实现了自动配置的关键。

@import:提供可以显式的从其他地方加载配置类的方式。有三种方式:

1.普通类

2.接口importSelector的实现类

3.接口importBeanDefintionRegistart的实现类

自动配置就是用来第二种方式。importSelector接口中有一个selectImports方法,返回值是一个字符串数组,数组中的每个元素就是将要被导入的配置类的全限定的类名。

@Import导入了一个AutoConfigurationImportSelector.class的选择器。那么如何根据这个选择器来实现自动配置?

spring框架在底层中使用了springfactories机制,它是Java SPI(SPI(Service Provider Interface),是JDK内置的一种服务提供发现机制,可以用来启用框架扩展和替换组件,主要是被框架的开发人员使用,比如java.sql.Driver接口,其他不同厂商可以针对同一接口做出不同的实现,MySQL和PostgreSQL都有不同的实现提供给用户,而Java的SPI机制可以为某个接口寻找服务实现。Java中SPI机制主要思想是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要,其核心思想就是解耦)的延续,可以借助它来实现自动配置的功能。他的核心逻辑是从Classpath中读取到Jar包中的配置文件META-IF/spring.factories,然后根据知道的key从配置文件中解析出对应的value值。 

回到正题:在AutoConfigurationImportSelector.class中有selectImports方法里面调用了getAutoConfigurationEntry(annotationMetadata)方法,它是自动配置的入口。

  1. public String[] selectImports(AnnotationMetadata annotationMetadata) {
  2. if (!this.isEnabled(annotationMetadata)) {
  3. return NO_IMPORTS;
  4. } else {
  5. AutoConfigurationImportSelector.AutoConfigurationEntry autoConfigurationEntry = this.getAutoConfigurationEntry(annotationMetadata);//自动配置的入口
  6. return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
  7. }
  8. }

源码如下:

  1. protected AutoConfigurationImportSelector.AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
  2. if (!this.isEnabled(annotationMetadata)) {
  3. return EMPTY_ENTRY;
  4. } else {
  5. //1.获取annotationMetadata的注解@EnableAutoConfiguration的属性
  6. AnnotationAttributes attributes = this.getAttributes(annotationMetadata);
  7. //2.从资源文件中spring.factories中获取EnableAutoConfiguration对应的所有类
  8. List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
  9. configurations = this.removeDuplicates(configurations);
  10. //3.通过在注解@EnableAutoConfiguration设置exclude的相关属性,可以指定排除的自动配置类
  11. Set<String> exclusions = this.getExclusions(annotationMetadata, attributes);
  12. this.checkExcludedClasses(configurations, exclusions);
  13. configurations.removeAll(exclusions);
  14. //4.根据@Conditional(满足条件是触发)来判断是否排除某些自动配置类
  15. configurations = this.getConfigurationClassFilter().filter(configurations);
  16. //5.触发AutoConfiguration导入相关的事件
  17. this.fireAutoConfigurationImportEvents(configurations, exclusions);
  18. return new AutoConfigurationImportSelector.AutoConfigurationEntry(configurations, exclusions);
  19. }
  20. }

 核心是第2步:拿到所有全限定类名

  1. protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
  2. //从spring.factorie找出所有的类
  3. List<String> configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());
  4. 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.");
  5. return configurations;
  6. }

总结下流程:从selectimports方法开始:

1.通过ClassLoader去获取classpath中的配置文件spring.factories

 

2.在spring.factories文件里,筛选出以EnableAutoConfiguration为key的配置类(

 3.再根据@Conditional过滤掉不必要的自动配置类

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/Li_阴宅/article/detail/796488
推荐阅读
相关标签
  

闽ICP备14008679号