自动配置

  • Spring Boot应用的启动类:
@SpringBootApplication
public class MainApplication {

    public static void main(String[] args) {
        SpringApplication.run(MainApplication.class, args);
    }

}

一、自动包规则原理

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {
    @AliasFor(
        annotation = Configuration.class
    )
    boolean proxyBeanMethods() default true;
}

核心注解:@SpringBootApplication

@SpringBootConfiguration@EnableAutoConfiguration@ComponentScan("com.meimeixia.boot") 三者之和

1. @SpringBootConfiguration

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {
    @AliasFor(
        annotation = Configuration.class
    )
    boolean proxyBeanMethods() default true;
}

  • 该注解上面又标注了一个@Configuration注解
    • 说明当前注解就是一个配置类
  • 当前的主程序类其实就是Spring Boot里面的一个配置类,而且它还是一个核心配置类

2. @ComponentScan

  • 指定扫描哪些Spring注解

3. 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})
    

(1) @AutoConfigurationPackage

  • 标签名直译为:自动配置包,指定了默认的包规则

  • @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Inherited
    @Import(AutoConfigurationPackages.Registrar.class)//给容器中导入一个组件
    public @interface AutoConfigurationPackage {
        String[] basePackages() default {};
    
        Class<?>[] basePackageClasses() default {};
    }
    
    
  • 作用:

    • 利用Registrar给容器中导入 一系列 组件
    • 将指定的一个包下的所有组件导入进MainApplication所在包下

(2)@Import(AutoConfigurationImportSelector.class)

初始加载自动配置类(重点)

步骤:

  1. 利用getAutoConfigurationEntry(annotationMetadata);给容器中批量导入一些组件
  2. 调用List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes)获取到所有需要导入到容器中的配置类
  3. 利用工厂加载 Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader);得到所有的组件
  4. META-INF/spring.factories位置来加载一个文件
    1. 默认扫描我们当前系统里面所有META-INF/spring.factories位置的文件
    2. spring-boot-autoconfigure-2.3.4.RELEASE.jar包里面也有META-INF/spring.factories
# 文件里面写死了spring-boot一启动就要给容器中加载的所有配置类
# spring-boot-autoconfigure-2.3.4.RELEASE.jar/META-INF/spring.factories
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
...
  • 虽然我们所有场景的所有自动配置启动的时候默认全部加载,但是xxxxAutoConfiguration按照条件装配规则(@Conditional),最终会按需配置

二、自动配置流程

  • DispatcherServletAutoConfiguration的内部类DispatcherServletConfiguration为例子:

    @Bean
    @ConditionalOnBean(MultipartResolver.class)  //容器中有这个类型组件
    @ConditionalOnMissingBean(name = DispatcherServlet.MULTIPART_RESOLVER_BEAN_NAME) //容器中没有这个名字 multipartResolver 的组件
    public MultipartResolver multipartResolver(MultipartResolver resolver) {
      //给@Bean标注的方法传入了对象参数,这个参数的值就会从容器中找。
      //SpringMVC multipartResolver。防止有些用户配置的文件上传解析器不符合规范
      // Detect if the user has created a MultipartResolver but named it incorrectly
      return resolver;//给容器中加入了文件上传解析器;
    }
    
  • SpringBoot默认会在底层配好所有的组件,但是如果用户自己配置了以用户的优先

总结

  • SpringBoot先加载所有的自动配置类 xxxxxAutoConfiguration
  • 每个自动配置类按照条件进行生效,默认都会绑定配置文件指定的值。(xxxxProperties里面读取,xxxProperties和配置文件进行了绑定)
  • 生效的配置类就会给容器中装配很多组件
  • 只要容器中有这些组件,相当于这些功能就有了
  • 定制化配置
    • 用户直接自己@Bean替换底层的组件
    • 用户去看这个组件是获取的配置文件什么值就去修改

xxxxxAutoConfiguration —> 组件 —> xxxxProperties里面拿值 ----> application.properties

Spring Boot会加载所有的自动配置类

然后再按需加载所有的组件

这些组件又会从XxxProperties类型的组件里面拿值来进行设置

当然,配置文件里面所有属性的值都会被封装到XxxProperties类型的组件的对应属性中,而这正是因为@EnableConfigurationProperties注解所引起的结果

文字课程:

自动配置篇:源码分析之自动包规则原理

自动配置篇:源码分析之初始加载自动配置类

自动配置篇:源码分析之自动配置流程

视频教程:

SpringBoot2全套完整版(p13~p15)

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容