一、概述
Springboot的自动配置是指在当前类目录下添加的jar包,能够自动根据Java配置、配置文件以及容器的环境变量等自动加载配置类。官方指定的自动配置类都是通过spring-boot-autoconfiguration来实现的,对于外部jar包,会定义META-INF/spring.factories配置文件,springboot的自动装配功能会从这个配置文件中找到配置类,将其org.springframework.boot.autoconfigure.EnableutoConfiguration 中的配置项通过反射的方式实例化成配置类,最后加载到IoC容器中。
二、主要注解
springboot应用的启动类上会加上@Sprin
gBootApplication
注解,标记该类为springboot应用:
@SpringBootApplication public class JpademoApplication { public static void main(String[] args) { SpringApplication.run(JpademoApplication.class, args); } }
其中@SpringBootApplication
注解由以下三个注解组成:
- @SpringBootConfiguration:springboot的配置类,为该spring容器设置配置项;
- @EnableAutoConfiguration:实现springboot的自动配置的关键,将配置类加载到IoC容器中;
- @ComponentScan:扫描被@Component、@Service、@Controller加上注解的bean类,默认情况下值扫描同级目录及其子目录下文件;
@SpringBootConfiguration @EnableAutoConfiguration @ComponentScan( excludeFilters = {@Filter( type = FilterType.CUSTOM, classes = {TypeExcludeFilter.class} ), @Filter( type = FilterType.CUSTOM, classes = {AutoConfigurationExcludeFilter.class} )} ) public @interface SpringBootApplication {
其中@EnableAutoConfiguration是实现自动配置的关键,其中通过注解@Import加载自动配置的配置项。
@AutoConfigurationPackage @Import(AutoConfigurationImportSelector.class) public @interface EnableAutoConfiguration {
其中AutoConfigurationImportSelector类实现了selectImports()的方法就是从配置项中加载配置类;
public class AutoConfigurationImportSelector implements DeferredImportSelector, BeanClassLoaderAware, ResourceLoaderAware, BeanFactoryAware, EnvironmentAware, Ordered { ...... @Override public String[] selectImports(AnnotationMetadata annotationMetadata) { //1.判断自动配置是否打开 if (!isEnabled(annotationMetadata)) { return NO_IMPORTS; } //2.获取所需的配置类 AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader .loadMetadata(this.beanClassLoader); AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry( autoConfigurationMetadata, annotationMetadata); return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations()); }
其中getAutoConfigurationEntry()方法会从META-INF/spring.factories 去找对应的配置类,将其实例化。
并不是所有的配置类都会被加载进来,注解@ConditionalOnXXX会根据条件进行筛选;
任何springboot应用中都有spring-boot-autoconfigure ,该类是实现自动配置的关键。
三、主要流程
以下主要描述@EnableAutoConfiguration注解加载配置类的主要流程:
(1)Springboot在启动的时候会加载spring-boot-autoconfiguration依赖中org.springframework.boot.autoconfigure.AutoConfiguration.imports配置文件,其中列举了Springboot支持的自动配置类。
(2)根据条件注解加载对于的配置项,在自动配置类中会通过@Conditional等一系列条件注解来判断是否需要加载对于配置类。
(3)加载对于的配置项。将对应的propertis文件里面的配置项加载到Properties实例中,如果项目中通过java或者配置文件的形式做了配置,那么就直接使用该配置的值,否则直接使用默认值。
以下通过SpringBoot加载redis客户端来说明:
spring-boot-autoconfiguration依赖中org.springframework.boot.autoconfigure.AutoConfiguration.imports配置文件中存在org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration该自动配置类。
该配置类也在spring-boot-autoconfiguration依赖中,但需要注意的配置类上的几个注解,@ConditionalOnClass({RedisOperations.class})该注解指但存在RedisOperations类时才会自动加载配置类,但该类在spring-data-redis-2.7.1依赖中,亦即存在spring-data-redis-2.7.1依赖时候才会自动加载Redis的自动配置类。
如果存在RedisOperations类,则就会启用RedisProperties里面对应redis的所有属性配置,该配置对于配置文件中加spring.redis前对的配置项。
接着引入@Import({LettuceConnectionConfiguration.class,JedisConnectionConfiguration.class}),表示引入LettuceConnectionConfiguration、JedisConnectionConfiguration两个配置类。最后看到生成redisTemplate和stringRedisTemplate两个bean实例。
这样下来,只要我们引入了redis的客户端依赖,就会自动给我们配置好地址、端口等信息,直接通过redisTemplate调用即可。
参考资料
- 淘宝一面:“说一下 Spring Boot 自动装配原理呗?”:https://www.cnblogs.com/javaguide/p/springboot-auto-config.html
- Spring Boot自动装配原理与启动过程详解:https://juejin.cn/post/6940128900093575198
- SpringBoot(一):特性概览:https://zhuanlan.zhihu.com/p/112470258