Spring Boot自动配置原理以及@Conditional条件注解

449 阅读3分钟

本文已参与掘金创作者训练营第三期「话题写作」赛道,详情查看:掘力计划|创作者训练营第三期正在进行,「写」出个人影响力

基于Spring Boot 2.x详细介绍了Spring Boot自动配置的原理,以及@Conditional系列条件注解。

1 @SpringBootApplication自动配置原理

@SpringBootApplication是一个组合注解,主要由@ComponentScan、@SpringBootConfiguration、@EnableAutoConfiguration这三个注解组成。@EnableAutoConfiguration是Spring Boot实现自动配置的关键注解。

在这里插入图片描述

@ComponentScan用于扫描指定包及子包路径,并将符合条件的组件类注册到Spring容器中 。默认的包路径是当前@ComponentScan所在的包及其子包。默认的过滤条件是,如果类上具有包括@Component、@Service、@Repository、@Controller、@Configuration等注解,那么该类作为组件类而被注册到容器中,也可以通过指定includeFilters和excludeFilters属性来自定义条件。

@SpringBootConfiguration用于声明当前类是一个Spring Boot配置类,具有和@Configuration注解同样的作用。但应用程序中可以添加N个@Configuration注解的配置类,但是只能存在一个@SpringBootConfiguration注解的配置类。推荐使用@SpringBootConfiguration来表示作为一个Boot应用程序的启动类。

@EnableAutoConfiguration用于声明在程序启动时,将会自动加载Spring Boot默认的配置

@EnableAutoConfiguration内部主要是借助 @Import注解引入的AutoConfigurationImportSelector类,该类借助SpringFactoriesLoader工具获取spring-boot-autoconfigure.jar下的/META-INF/spring.factories文件中的配置信息,其中名为“org.springframework.boot.autoconfigure.EnableAutoConfiguration”的key对应的value就是一系列自动配置类的全路径名。实际上所有 Spring Boot Starter下的META-INF/spring.factories都会被读取到。

在这里插入图片描述

Spring将会拆分这个value为一个全路径名集合,但他并不会将这些配置类全都加载,而是会将符合规则的自动配置类加载到Spring 容器中。

在过滤的时候,将会检查类上的Conditional系列注解,@ConditionalOnClass和@ConditionalOnMissingClass、@ConditionalOnWebApplication和@ConditionalOnNotWebApplication、@ConditionalOnBean和@ConditionalOnMissingBean和@ConditionalOnSingleCandidate注解(如果存在),只有符合规则的自动配置类才会注册到容器中。

我们也可以通过@SpringBootApplication的exclude和excludeName属性指定排除某些自动配置类的注册,这样Spring Boot就不会自动注册某些配置。 这些自动配置类基本上都是@Configuration注解标注,其内部均有一系列的@Bean方法。当加载到容器中之后,这些自动配置类将会被解析,就有可能进行一系列自动化的配置。

2 @Conditional系列条件注解

@Conditional注解用于判断某个配置是否需要跳过,并且可被用作元注解而标注在其他注解上,这样就提供了丰富的校验机制,可用于判断某个自动配置类是否需要进行某些自动配置。

spring-boot-autoconfigure包中提供了一系列的@Conditional注解的衍生注解,它们已被标注在各种自动配置类上,当条件满足时,就会进行自动配置。我们也可以直接使用,常见的@Conditional系列注解如下:

@ConditionalOnBean容器里存在指定类型的Bean时生效
@ConditionalOnClass类路径存在指定的类时生效
@ConditionalOnExpressionSpEL表达式结果为true时生效
@ConditionalOnJava指定的Java版本存在时生效
@ConditionalOnJndi指定的JNDI存在时生效
@ConditionalOnMissingBean容器里不存在指定类型的Bean时生效
@ConditionalOnMissingClass类路径不存在指定的类时生效
@ConditionalOnNotWebApplication当前项目不是 Web 项目时生效
@ConditionalOnWebApplicatio当前项目是 Web 项目时生效
@ConditionalOnProperty指定的属性值和预期值一致时生效
@ConditionalOnResource类路径存在指定的资源时生效
@ConditionalOnSingleCandidate容器里指定类型的Bean只有一个或或者指定了一个首选Bean(@Primary)时生效

相关文章:

  1.   spring.io/
  2.   Spring Framework 5.x 学习
  3.   Spring MVC 5.x 学习
  4.   Spring Framework 5.x 源码

如有需要交流,或者文章有误,请直接留言。另外希望点赞、收藏、关注,我将不间断更新各种Java学习博客!