SpringBoot自动配置

发表于 2023-01-24

上一级页面：ssm-spring-boot速成学习索引

前言

13、自动配置【源码分析】-自动包规则原理

Spring Boot应用的启动类：

@SpringBootApplication
public class MainApplication {

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

}

分析下@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 {
    ...
}

重点分析@SpringBootConfiguration，@EnableAutoConfiguration，@ComponentScan。

@SpringBootConfiguration

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

@Configuration代表当前是一个配置类。

@ComponentScan

指定扫描哪些Spring注解。

@ComponentScan 在07、基础入门-SpringBoot-自动配置特性有用例。

@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(AutoConfigurationPackages.Registrar.class)//给容器中导入一个组件
public @interface AutoConfigurationPackage {
    String[] basePackages() default {};

    Class<?>[] basePackageClasses() default {};
}

利用Registrar给容器中导入一系列组件(AutoConfigurationPackages.Registrar)
将指定的一个包下的所有组件导入进来（MainApplication所在包下的所有组件，因为@EnableAutoConfiguration标在了MainApplication上）。

具体来说，一系列组件是在这里导入的。

Pasted image 20230124182234.png

Import高级用法见：08_尚硅谷_组件注册-@Import-给容器中快速导入一个组件_哔哩哔哩_bilibili

14、自动配置【源码分析】-初始加载自动配置类

@Import(AutoConfigurationImportSelector.class)

利用getAutoConfigurationEntry(annotationMetadata);给容器中批量导入一些组件
调用List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes)获取到所有需要导入到容器中的配置类
利用工厂加载 Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader);得到所有的组件
从META-INF/spring.factories位置来加载一个文件。
- 默认扫描我们当前系统里面所有META-INF/spring.factories位置的文件
- spring-boot-autoconfigure-2.3.4.RELEASE.jar包里面也有META-INF/spring.factories

Pasted image 20230124183932.png

# 文件里面写死了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,\
...

虽然我们127个场景的所有自动配置启动的时候默认全部加载，但是xxxxAutoConfiguration按照条件装配规则（即@Conditional，后文讲解），最终会按需配置。

以org.springframework.boot.autoconfigure.aop包下的AopAutoConfiguration类为例，

这里的@ConditionalOnProperty(xxx)：

@Configuration(
    proxyBeanMethods = false
)
@ConditionalOnProperty(
    prefix = "spring.aop",
    name = "auto",
    havingValue = "true",
    matchIfMissing = true
)
public class AopAutoConfiguration {
    public AopAutoConfiguration() {
    }
	...
}

以XXXAutoConfiguration为名的类，都有默认的自动配置

15、自动配置【源码分析】-自动配置流程

以DispatcherServletAutoConfiguration为例

@Configuration(proxyBeanMethods = false)  
@Conditional(DefaultDispatcherServletCondition.class)  
@ConditionalOnClass(ServletRegistration.class)  
@EnableConfigurationProperties(WebMvcProperties.class)  
protected static class DispatcherServletConfiguration {
//...
}

注意这里的@EnableConfigurationProperties(WebMvcProperties.class)

进入WebMvcProperties.class，可以看到绑定配置文件指定的值。

Pasted image 20230124191254.png

每个自动配置类默认都会绑定配置文件指定的值。

配置都从xxxxProperties里面读取
xxxProperties和配置文件进行了绑定

继续看，SpringBoot帮助我们初始化容器中的Bean，

Pasted image 20230124191656.png

所以你只要从容器中获取到组件，它就可以使用，而无需初始化（这是一种约定）

只要容器中有这些组件，相当于这些功能就有了

继续看，DispatcherServletAutoConfiguration内部类DispatcherServletConfiguration中包含有一个方法multipartResolver：

它是SpringMVC 中的 multipartResolver。

下面的这个方法，用来防止有些用户配置的文件上传解析器不符合规范。

比如说用户配置的解析器（自定义的解析器），名字叫做UploadResolver，这种名字不符合规范。这时通过下面的这个方法，就会返回出来一个multipartResolver,这样符合规范要求的名字

@Bean
@ConditionalOnBean(MultipartResolver.class)  //容器中有这个类型组件
@ConditionalOnMissingBean(name = DispatcherServlet.MULTIPART_RESOLVER_BEAN_NAME) //容器中没有这个名字 multipartResolver 的组件
public MultipartResolver multipartResolver(MultipartResolver resolver) {
	// 给@Bean标注的方法传入了对象参数，这个参数的值就会从容器中找。
	// Detect if the user has created a MultipartResolver but named it incorrectly
	//给容器中加入了标准名称(multipartResolver)的文件上传解析器；
	return resolver;
}

小结：SpringBoot默认会在底层配好所有的组件，但是如果用户自己配置了以用户的优先。(@ConditionalOnMissingBean)

总结（记住）：

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

xxxxxAutoConfiguration —> 组件 —> 从xxxxProperties里面拿值 ----> application.properties里面可以覆盖这些值

springboot最佳实践

spring-boot-最佳实践

前言