code examples for Spring Boot @conditionals

Author: thombergs

settings.gradle

@@ -20,6 +20,7 @@ include 'spring-boot:modular:application'
 include 'spring-boot:spring-boot-testing'
 include 'spring-boot:spring-boot-logging'
 include 'spring-boot:validation'
+include 'spring-boot:conditionals'
 
 include 'logging'
 

spring-boot/conditionals/src/main/java/io/reflectoring/conditionals/ConditionalsApplication.java

@@ -0,0 +1,13 @@
+package io.reflectoring.conditionals;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication
+public class ConditionalsApplication {
+
+	public static void main(String[] args) {
+		SpringApplication.run(ConditionalsApplication.class, args);
+	}
+
+}

spring-boot/conditionals/src/main/java/io/reflectoring/conditionals/applyingconditionals/ConditionalBeanConfiguration.java

@@ -0,0 +1,21 @@
+package io.reflectoring.conditionals.applyingconditionals;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+class ConditionalBeanConfiguration {
+
+  @Bean
+  @ConditionalOnProperty("conditionalBean.enabled")
+  ConditionalBean conditionalBean(){
+    return new ConditionalBean();
+  };
+
+
+  static class ConditionalBean {
+
+  }
+
+}

spring-boot/conditionals/src/main/java/io/reflectoring/conditionals/applyingconditionals/ConditionalComponent.java

@@ -0,0 +1,10 @@
+package io.reflectoring.conditionals.applyingconditionals;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.stereotype.Component;
+
+@Component
+@ConditionalOnProperty("conditionalComponent.enabled")
+class ConditionalComponent {
+
+}

spring-boot/conditionals/src/main/java/io/reflectoring/conditionals/applyingconditionals/ConditionalConfiguration.java

@@ -0,0 +1,9 @@
+package io.reflectoring.conditionals.applyingconditionals;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@ConditionalOnProperty("configuration.enabled")
+class ConditionalConfiguration {
+}

spring-boot/conditionals/src/main/java/io/reflectoring/conditionals/conditionalonbean/DependantModule.java

@@ -0,0 +1,27 @@
+package io.reflectoring.conditionals.conditionalonbean;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+class DependantModule {
+
+  @Bean
+  OptionalBean optionalBean() {
+    return new OptionalBean();
+  }
+
+  @Bean
+  @ConditionalOnBean(OptionalBean.class)
+  DependantBean dependantBean() {
+    return new DependantBean();
+  }
+
+  static class DependantBean {
+  }
+
+  static class OptionalBean {
+  }
+
+}

spring-boot/conditionals/src/main/java/io/reflectoring/conditionals/conditionalonbean/NoOptionalBeanModule.java

@@ -0,0 +1,21 @@
+package io.reflectoring.conditionals.conditionalonbean;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+class NoOptionalBeanModule {
+
+  @Bean
+  @ConditionalOnBean(OptionalBean.class)
+  DependantBean dependantBean(){
+    return new DependantBean();
+  }
+
+  static class DependantBean {}
+
+  static class OptionalBean {}
+
+}

spring-boot/conditionals/src/main/java/io/reflectoring/conditionals/conditionalonclass/OnClassModule.java

@@ -0,0 +1,10 @@
+package io.reflectoring.conditionals.conditionalonclass;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@ConditionalOnClass(name = "this.clazz.does.not.Exist")
+class OnClassModule {
+
+}

spring-boot/conditionals/src/main/java/io/reflectoring/conditionals/conditionaloncloudplatform/OnCloudPlatformModule.java

@@ -0,0 +1,10 @@
+package io.reflectoring.conditionals.conditionaloncloudplatform;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnCloudPlatform;
+import org.springframework.boot.cloud.CloudPlatform;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@ConditionalOnCloudPlatform(CloudPlatform.CLOUD_FOUNDRY)
+class OnCloudPlatformModule {
+}

spring-boot/conditionals/src/main/java/io/reflectoring/conditionals/conditionalonexpression/SubModule.java

@@ -0,0 +1,10 @@
+package io.reflectoring.conditionals.conditionalonexpression;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+@ConditionalOnExpression("${module.enabled:true} " +
+		"and ${module.submodule.enabled:true}")
+class SubModule {
+}