1、springboot源码
1.1、springboot复习
我们知道,springboot的核心就是起步依赖,自动配置。这里有两个点。
起步依赖,即引入spring-boot-start
的时候,相关所有的依赖即全部引入,而不需要再去将其引用的依赖也引入我们的项目中。
自动配置也可以叫自动装配,即引入某些依赖的时候,spring就会将其一些bean注入进来,让我们能够直接使用这些配置。自动装配可以简单理解为:**通过注解或者一些简单的配置就能在 Spring Boot 的帮助下实现某块功能。**其特点如下:
- SpringBoot遵循“约定大于配置”的原则,自动进行了默认配置,这样我们就不需要做大量的配置
- 当我们需要使用什么场景时,就会自动配置这个场景的相关配置
- 如果他的默认配置不符合我们的需求时,修改这部分配置即可
而我们springboot源码,也是自动配置这一源码入手的
1.2、springboot自动配置源码
1.2.1、@SpringBootApplication
我们先看一下 SpringBoot 的核心注解 SpringBootApplication
。
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration //1
@ComponentScan //2
@EnableAutoConfiguration //3
public @interface SpringBootApplication {
}
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration //实际上它也是一个配置类
public @interface SpringBootConfiguration {
}
大概可以把 @SpringBootApplication
看作是 @SpringBootConfiguration
、@EnableAutoConfiguration
、@ComponentScan
注解的集合。根据 SpringBoot 官网,这三个注解的作用分别是:
@EnableAutoConfiguration
:启用 SpringBoot 的自动配置机制@SpringBootConfiguration
:允许在上下文中注册额外的 bean 或导入其他配置类@ComponentScan
: 扫描被@Component
(@Service
,@Controller
)注解的 bean,注解默认会扫描启动类所在的包下所有的类 ,可以自定义不扫描某些 bean。如下图所示,容器中将排除TypeExcludeFilter
和AutoConfigurationExcludeFilter
。
1.2.2、@EnableAutoConfiguration:实现自动装配的核心注解
EnableAutoConfiguration
只是一个简单地注解,自动装配核心功能的实现实际是通过 AutoConfigurationImportSelector
类。
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage //作用:将main包下的所有组件注册到容器中
@Import({AutoConfigurationImportSelector.class}) //加载自动装配类 xxxAutoconfiguration
public @interface EnableAutoConfiguration {
String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
Class<?>[] exclude() default {};
String[] excludeName() default {};
}
我们现在重点分析下AutoConfigurationImportSelector
类到底做了什么?
1.2.3、AutoConfigurationImportSelector类:加载自动装配类
AutoConfigurationImportSelector
类的继承体系如下:
public class AutoConfigurationImportSelector implements DeferredImportSelector, BeanClassLoaderAware, ResourceLoaderAware, BeanFactoryAware, EnvironmentAware, Ordered {
}
public interface DeferredImportSelector extends ImportSelector {
}
public interface ImportSelector {
String[] selectImports(AnnotationMetadata var1);
}
可以看出,AutoConfigurationImportSelector
类实现了 ImportSelector
接口,也就实现了这个接口中的 selectImports
方法,该方法主要用于获取所有符合条件的类的全限定类名,这些类需要被加载到 IoC 容器中。
private static final String[] NO_IMPORTS = new String[0];
@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
//1.判断自动装配开关是否打开
if (!isEnabled(annotationMetadata)) {
return NO_IMPORTS;
}
//2.获取所有需要装配的bean
AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata);
return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}
1.2.4、getAutoConfigurationEntry()方法:加载自动配置类方法
这里我们需要重点关注一下getAutoConfigurationEntry()
方法,这个方法主要负责加载自动配置类的。
该方法调用链如下:
- AutoConfigurationImportSelector.AutoConfigurationEntry(annotationMetadata)
- SpringFactoriesLoader.loadFactoryNames():获取所有自动配置类名
- SpringFactoriesLoader.loadSpringFactories(@Nullable ClassLoader classLoader):从META-INF/spring.factories加载自动配置
现在我们结合getAutoConfigurationEntry()
的源码来详细分析一下:
//用于存放需要加载的配置类bean
private static final AutoConfigurationEntry EMPTY_ENTRY = new AutoConfigurationEntry();
protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
//1.判断是否开启自动装配
if (!isEnabled(annotationMetadata)) {
return EMPTY_ENTRY;
}
//2.获取EnableAutoConfiguration注解中的 exclude 和 excludeName。
AnnotationAttributes attributes = getAttributes(annotationMetadata);
//3.获取需要自动装配的所有配置类,读取META-INF/spring.factories
List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
//4.筛选spring.factories中的配置,满足条件才装配
configurations = removeDuplicates(configurations); //浅排一下
Set<String> exclusions = getExclusions(annotationMetadata, attributes); //构建排除类
checkExcludedClasses(configurations, exclusions);
configurations.removeAll(exclusions);
configurations = getConfigurationClassFilter().filter(configurations);
fireAutoConfigurationImportEvents(configurations, exclusions);
return new AutoConfigurationEntry(configurations, exclusions);
}
下面会解析一下我们这个getAutoConfigurationEntry()方法的四个步骤
1.判断是否开启自动装配
判断自动装配开关是否打开。默认spring.boot.enableautoconfiguration=true
,可在 application.properties
或 application.yml
中设置
2.用于获取EnableAutoConfiguration
注解中的 exclude
和 excludeName
3.获取需要自动装配的所有配置类,读取META-INF/spring.factories
不光是这个依赖下的META-INF/spring.factories
被读取到,所有 Spring Boot Starter 下的META-INF/spring.factories
都会被读取到。
所以,你可以清楚滴看到, druid 数据库连接池的 Spring Boot Starter 就创建了META-INF/spring.factories
文件。
如果,我们自己要创建一个 Spring Boot Starter,这一步是必不可少的。
org.springframework.boot.autoconfigure.EnableAutoConfiguration=/ # 固定格式,声明为需要装配
com.hy.config.redisConfiguration # 需要装配的类的全类名
4.筛选spring.factories中的配置,满足条件才装配
到这里可能面试官会问你:“spring.factories
中这么多配置,每次启动都要全部加载么?”。
很明显,这是不现实的。我们 debug 到后面你会发现,configurations
的值变小了。
因为,这一步有经历了一遍筛选,@ConditionalOnXXX
中的所有条件都满足,该类才会生效。
下面这个是spring-boot-starter-redis的自动配置类
@Configuration
// 检查相关的类:RabbitTemplate 和 Channel是否存在
// 存在才会加载
@ConditionalOnClass({ RabbitTemplate.class, Channel.class })
@EnableConfigurationProperties(RabbitProperties.class)
@Import(RabbitAnnotationDrivenConfiguration.class)
public class RabbitAutoConfiguration {
}
以下则是自动配置类满足条件的相关注解
@ConditionalOnBean
:当容器里有指定 Bean 的条件下@ConditionalOnMissingBean
:当容器里没有指定 Bean 的情况下@ConditionalOnSingleCandidate
:当指定 Bean 在容器中只有一个,或者虽然有多个但是指定首选 Bean@ConditionalOnClass
:当类路径下有指定类的条件下@ConditionalOnMissingClass
:当类路径下没有指定类的条件下@ConditionalOnProperty
:指定的属性是否有指定的值@ConditionalOnResource
:类路径是否有指定的值@ConditionalOnExpression
:基于 SpEL 表达式作为判断条件@ConditionalOnJava
:基于 Java 版本作为判断条件@ConditionalOnJndi
:在 JNDI 存在的条件下差在指定的位置@ConditionalOnNotWebApplication
:当前项目不是 Web 项目的条件下@ConditionalOnWebApplication
:当前项目是 Web 项 目的条件下
1.2.5、总结
现在我们总结一下自动配置的过程
- @SpringBootApplication内部包含三个主要的配置类
- @Springbootconfiguration:用于允许上下文注册额外的bean或者导入其他配置
- @EnableAutoConfiguration:自动配置的主要注解,用于启动自动配置
- @ComponentScan:用于扫描装配的包
- @EnableAuthoConfiguration使用@Import注入的一个bean,AutoConfigurationImportSelector类,该类用于创建所有的配置类相关的bean
- AutoConfigurationImportSelector类实现了ImportSelector接口,实现了selectImports这个方法,这个方法用于获取配置bean的全类名名创建出来
- selectImports方法中使用getAutoConfigurationEntry()方法主要用作加载bean
- getAutoConfigurationEntry()方法主要有四个用途
- 判断是否开启了自动配置
- 获取注解中不满足条件需要排除的配置类名集合
- 读取
META-INF/spring.factories
文件加载所有的配置类全类名集合 - 执行装配bean,并排除不满足条件的bean
评论区