SpringBoot运作原理之@Conditional

简介: SpringBoot运作原理之@Conditional

在《SpringBoot运作原理解析之加载AutoConfiguration》中我们已经介绍了SpringBoot对配置文件的加载及相应类的实例化操作。那么,SpringBoot是如何知道该实例化哪些类的呢?这篇文章带大家了解一下@Conditional注解及其发挥的作用。


@Conditional注解


@Conditional注解可以根据是否满足某一个特定条件来决定要不要创建某个特定的Bean。比如,当某一个jar包在一个类路径下的时自动配置一个或多个Bean;或者只有某个Bean被创建才会创建另外一个Bean。该注解由Spring4开始提供,源代码如下:







@Target({ElementType.TYPE, ElementType.METHOD})@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface Conditional {    Class<? extends Condition>[] value();}

SpringBoot也正是使用@Conditional的这项功能来实现自动配置的。SpringBoot对该注解进行了相应个扩展,形成了以下组合注解,以满足更多的情况。


  • @ConditionalOnBean:当容器中有指定Bean的条件下。
  • @ConditionalOnClass:当classpath类路径下有指定类的条件下。
  • @ConditionalOnCloudPlatform:当指定的云平台处于active状态时。
  • @ConditionalOnExpression:基于SpEL表达式的条件判断。
  • @ConditionalOnJava:基于JVM版本作为判断条件。
  • @ConditionalOnJndi:在JNDI存在的条件下查找指定的位置。
  • @ConditionalOnMissingBean:当容器里没有指定Bean的条件。
  • @ConditionalOnMissingClass:当类路径下没有指定类的条件下。
  • @ConditionalOnNotWebApplication:当项目不是一个Web项目的条件下。
  • @ConditionalOnProperty:当指定的属性有指定的值的条件下。
  • @ConditionalOnResource:类路径是否有指定的值。
  • @ConditionalOnSingleCandidate:当指定的Bean在容器中只有一个,或者有多个但是指定了首选的Bean。
  • @ConditionalOnWebApplication:当项目是一个Web项目的条件下。


以上组合注解均位于spring-boot-autoconfigure jar包下的org.springframework.boot.autoconfigure.condition包下。


组合注解实例说明


了解组合注解,现在以一个简单的注解@ConditionalOnJava来说明一下组合注解的简单实用。@ConditionalOnJava的源码为:













@Target({ ElementType.TYPE, ElementType.METHOD })@Retention(RetentionPolicy.RUNTIME)@Documented@Conditional(OnJavaCondition.class)public @interface ConditionalOnJava {  Range range() default Range.EQUAL_OR_NEWER;  JavaVersion value();  enum Range {    EQUAL_OR_NEWER,    OLDER_THAN  }}

很明显,它是由@Conditional注解组合而成。在@Conditional中需要满足OnJavaCondition.class定义的条件。OnJavaCondition类代码如下:







































@Order(Ordered.HIGHEST_PRECEDENCE + 20)class OnJavaCondition extends SpringBootCondition {
  private static final JavaVersion JVM_VERSION = JavaVersion.getJavaVersion();
  @Override  public ConditionOutcome getMatchOutcome(ConditionContext context,      AnnotatedTypeMetadata metadata) {    Map<String, Object> attributes = metadata        .getAnnotationAttributes(ConditionalOnJava.class.getName());    Range range = (Range) attributes.get("range");    JavaVersion version = (JavaVersion) attributes.get("value");    return getMatchOutcome(range, JVM_VERSION, version);  }
  protected ConditionOutcome getMatchOutcome(Range range, JavaVersion runningVersion,      JavaVersion version) {    boolean match = isWithin(runningVersion, range, version);    String expected = String.format(        (range != Range.EQUAL_OR_NEWER) ? "(older than %s)" : "(%s or newer)",        version);    ConditionMessage message = ConditionMessage        .forCondition(ConditionalOnJava.class, expected)        .foundExactly(runningVersion);    return new ConditionOutcome(match, message);  }
  private boolean isWithin(JavaVersion runningVersion, Range range,      JavaVersion version) {    if (range == Range.EQUAL_OR_NEWER) {      return runningVersion.isEqualOrNewerThan(version);    }    if (range == Range.OLDER_THAN) {      return runningVersion.isOlderThan(version);    }    throw new IllegalStateException("Unknown range " + range);  }}

通过源代码可以看出,OnJavaCondition继承了SpringBootCondition类,并实现了它的getMatchOutcome方法。该方法的实现主要做了以下事情:

  • 获取当前使用jdk版本。
  • 获取注解属性中range(判断范围)和value(jdk版本)。
  • 通过isWithin方法比较当前版本是否在指定的范围内。
  • 返回比对结果。


使用机制


同样在spring-boot-autoconfigure jar包下的org.springframework.boot.autoconfigure包下,springboot默认提供了一些自动配置类。随便打开一个AutoConfiguration类都会看到使用到上面的注解:






























@Configuration@EnableConfigurationProperties(HttpProperties.class)@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)@ConditionalOnClass(CharacterEncodingFilter.class)@ConditionalOnProperty(prefix = "spring.http.encoding", value = "enabled",    matchIfMissing = true)public class HttpEncodingAutoConfiguration {
  private final HttpProperties.Encoding properties;
  public HttpEncodingAutoConfiguration(HttpProperties properties) {    this.properties = properties.getEncoding();  }
  @Bean  @ConditionalOnMissingBean  public CharacterEncodingFilter characterEncodingFilter() {    CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();    filter.setEncoding(this.properties.getCharset().name());    filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));    filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));    return filter;  }
  @Bean  public LocaleCharsetMappingsCustomizer localeCharsetMappingsCustomizer() {    return new LocaleCharsetMappingsCustomizer(this.properties);  }  ……

正因为SpringBoot在spring.factories文件中加载的类都拥有@Conditional的扩展注解,SpringBoot便可以判断该AutoConfiguration配置类是否满足@Conditional*所注解的前置条件,如果满足则进行实例化,如果不满足则跳过。


小结


本篇文章我们了解@Conditional的基本使用和在SpringBoot中发挥的作用。后面我们将以具体的示例来进行详细说明。欢迎持续关注。


目录
相关文章
|
28天前
|
人工智能 Java 开发者
【Spring】原理解析:Spring Boot 自动配置
Spring Boot通过“约定优于配置”的设计理念,自动检测项目依赖并根据这些依赖自动装配相应的Bean,从而解放开发者从繁琐的配置工作中解脱出来,专注于业务逻辑实现。
|
3月前
|
Java Spring 容器
SpringBoot自动配置的原理是什么?
Spring Boot自动配置核心在于@EnableAutoConfiguration注解,它通过@Import导入配置选择器,加载META-INF/spring.factories中定义的自动配置类。这些类根据@Conditional系列注解判断是否生效。但Spring Boot 3.0后已弃用spring.factories,改用新格式的.imports文件进行配置。
755 0
|
28天前
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
探索Spring Boot的@Conditional注解的上下文配置
|
3月前
|
前端开发 Java 数据库连接
SpringBoot参数校验底层原理和实操。深度历险、深度解析(图解+秒懂+史上最全)
SpringBoot参数校验底层原理和实操。深度历险、深度解析(图解+秒懂+史上最全)
SpringBoot参数校验底层原理和实操。深度历险、深度解析(图解+秒懂+史上最全)
|
11月前
|
XML Java 开发者
Spring Boot开箱即用可插拔实现过程演练与原理剖析
【11月更文挑战第20天】Spring Boot是一个基于Spring框架的项目,其设计目的是简化Spring应用的初始搭建以及开发过程。Spring Boot通过提供约定优于配置的理念,减少了大量的XML配置和手动设置,使得开发者能够更专注于业务逻辑的实现。本文将深入探讨Spring Boot的背景历史、业务场景、功能点以及底层原理,并通过Java代码手写模拟Spring Boot的启动过程,为开发者提供一个全面的理解。
194 0
|
7月前
|
Java Spring
SpringBoot自动配置原理
本文深入解析了SpringBoot的核心功能——自动配置,重点探讨了`org.springframework.boot.autoconfigure`及相关注解的工作机制。通过分析`@SpringBootApplication`、`@EnableAutoConfiguration`等注解,揭示了SpringBoot如何基于类路径和条件自动装配Bean
347 7
|
7月前
|
Java
SpringBoot自动装配的原理
在SpringBoot项目的启动引导类上都有一个注解@SpringBootApplication 这个注解是一个复合注解, 其中有三个注解构成 , 分别是 ● @SpringBootConfiguration : 是@Configuration的派生注解 , 标注当前类是一个SpringBoot的配置类 ● @ComponentScan : 开启组件扫描, 默认扫描的是当前启动引导了所在包以及子包 ● @EnableAutoConfiguration : 开启自动配置(自动配置核心注解) 2.在@EnableAutoConfiguration注解的内容使用@Import注解导入了一个AutoC
|
7月前
|
JavaScript 前端开发 Java
Idea启动SpringBoot程序报错:Veb server failed to start. Port 8082 was already in use;端口冲突的原理与解决方案
本文解决了Idea启动SpringBoot程序报错:Veb server failed to start. Port 8082 was already in use的问题,并通过介绍端口的使用原理和操作系统的端口管理机制,可以更有效地解决端口冲突问题,并确保Web服务器能够顺利启动和运行。 只有锻炼思维才能可持续地解决问题,只有思维才是真正值得学习和分享的核心要素。如果这篇博客能给您带来一点帮助,麻烦您点个赞支持一下,还可以收藏起来以备不时之需,有疑问和错误欢迎在评论区指出~
|
9月前
|
Dart 前端开发 JavaScript
springboot自动配置原理
Spring Boot 自动配置原理:通过 `@EnableAutoConfiguration` 开启自动配置,扫描 `META-INF/spring.factories` 下的配置类,省去手动编写配置文件。使用 `@ConditionalXXX` 注解判断配置类是否生效,导入对应的 starter 后自动配置生效。通过 `@EnableConfigurationProperties` 加载配置属性,默认值与配置文件中的值结合使用。总结来说,Spring Boot 通过这些机制简化了开发配置流程,提升了开发效率。
187 17
springboot自动配置原理
|
6月前
|
安全 前端开发 Java
Spring Boot 项目中触发 Circular View Path 错误的原理与解决方案
在Spring Boot开发中,**Circular View Path**错误常因视图解析与Controller路径重名引发。当视图名称(如`login`)与请求路径相同,Spring MVC无法区分,导致无限循环调用。解决方法包括:1) 明确指定视图路径,避免重名;2) 将视图文件移至子目录;3) 确保Spring Security配置与Controller路径一致。通过合理设定视图和路径,可有效避免该问题,确保系统稳定运行。
389 0