Spring Boot @ConditionalOnProperty Annotation Example

In this section we will learn about @ConditionalOnProperty Annotation.


The @ConditionalOnProperty annotation allows us to enable configuration based on the Spring Environment property. Use the prefix and name attributes to specify the property to validate. By default, any property that exists and is not false is mapped. We can also create more complex checks using the havingValue and matchIfMissing attributes.

It may be useful in many cases for example enable/disable service if specific property is available.

The @ConditionalOnProperty annotation may be used on any class annotated with @Configuration, @Component, @Service & @Repository or on methods annotated with @Bean.

1. Using @ConditionalOnProperty on @Bean method

To illustrate the use of @ConditionalOnProperty, we will develop a basic notification system. To keep things simple for now, let's assume we want to send email notifications.

Suppose we have a key = notification.service and value = twitter in the application.properties file.

notification.service=twitter

Next we'll need to create a simple service to send a notification. For example, consider the Notification Sender interface:

public interface NotificationService {

    String sendNotification(String message);
}

Next, let's introduce the implementation of the Notification Sender interface for sending our emails:

public class EmailNotificationService implements NotificationService {

    @Override
    public String sendNotification(String message) {
        return "Email Notification: " + message;
    }
}


Now let's see how to use the @ConditionalOnProperty annotation. Let's configure the Notification Sender bean so that it is loaded only if the notification.service property is defined:

@ConditionalOnProperty
        (prefix = "notification",
                name = "service")
@Bean(name = "emailNotification")
public NotificationService emailNotificationService()
{
    return new EmailNotificationService();
}

As we can see, the prefix and name attributes are used to indicate the configuration property to be checked.


Suppose we want to add another notification service – for example, a service that will allow us to send Twitter notifications.

To do this, we need to create another Notification Sender implementation:

public class TwitterNotificationService implements NotificationService{
    @Override
    public String sendNotification(String message) {
        return "Twitter Notification: " + message;
    }
}


Since we have two implementations, let's see how we can use @ConditionalOnProperty to load the correct NotificationSender bean conditionally. 


For this purpose, the annotation specifies an attribute that has the value. Interestingly enough, it defines the value that a property must have to add a particular component to the Spring IOC container.


Now let's clarify under what conditions we want to register the Twitter notification implementation in the context:

@ConditionalOnProperty
        (prefix = "notification",
                name = "service",
                havingValue = "twitter")
@Bean(name = "twitterNotification")
public NotificationService twitterNotificationService()
{
    return new TwitterNotificationService();
}

With the having Value attribute, we made it clear that we want to load the Twitter notification only when the notification.service is set to twitter.


2. Using @ConditionalOnProperty on @Service class

Suppose we want to add another notification service – for example, a service that will allow us to send SMS notifications.

To do this, we need to create another Notification Sender implementation:

@Service("smsNotification")
@ConditionalOnProperty
        (prefix = "notification",
                name = "service")
public class SMSNotificationService implements NotificationService{
    @Override
    public String sendNotification(String message) {
        return "SMS Notification: " + message;
    }
}

As we can see, the prefix and name attributes are used to indicate the configuration property to be checked. 

@ConditionalOnProperty has another attribute called matchIfMissing. If true it will match the condition and execute the annotated code when property itself is not available in environment.

The following example creates a Spring Boot web application which uses @ConditionalOnProperty annotation.

Project Directory



pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
   https://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>3.0.1</version>
      <relativePath/> <!-- lookup parent from repository -->
   </parent>
   <groupId>com.knf.dev.demo</groupId>
   <artifactId>spring-conditionalonproperty-annotation-example</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <name>spring-conditionalonproperty-annotation-example</name>
   <description>Demo project for Spring Boot</description>
   <properties>
      <java.version>17</java.version>
   </properties>
   <dependencies>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-web</artifactId>
      </dependency>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-test</artifactId>
         <scope>test</scope>
      </dependency>
   </dependencies>

   <build>
      <plugins>
         <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
         </plugin>
      </plugins>
   </build>

</project>


application.properties

notification.service=twitter


NotificationService.java

package com.knf.dev.demo.service;

public interface NotificationService {

    String sendNotification(String message);
}


EmailNotificationService.java

package com.knf.dev.demo.service;

public class EmailNotificationService implements NotificationService {

    @Override
    public String sendNotification(String message) {
        return "Email Notification: " + message;
    }
}


TwitterNotificationService.java

package com.knf.dev.demo.service;

public class TwitterNotificationService implements NotificationService{
    @Override
    public String sendNotification(String message) {
        return "Twitter Notification: " + message;
    }
}


AppConfig.java

package com.knf.dev.demo.config;

import com.knf.dev.demo.service.EmailNotificationService;
import com.knf.dev.demo.service.NotificationService;
import com.knf.dev.demo.service.TwitterNotificationService;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {

    @ConditionalOnProperty
            (prefix = "notification",
                    name = "service")
    @Bean(name = "emailNotification")
    public NotificationService emailNotificationService()
    {
        return new EmailNotificationService();
    }

    @ConditionalOnProperty
            (prefix = "notification",
                    name = "service",
                    havingValue = "twitter")
    @Bean(name = "twitterNotification")
    public NotificationService twitterNotificationService()
    {
        return new TwitterNotificationService();
    }

}


SMSNotificationService.java

package com.knf.dev.demo.service;

import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.stereotype.Service;

@Service("smsNotification")
@ConditionalOnProperty
        (prefix = "notification",
                name = "service")
public class SMSNotificationService implements NotificationService{
    @Override
    public String sendNotification(String message) {
        return "SMS Notification: " + message;
    }
}


Run the application - Application.java

package com.knf.dev.demo;

import com.knf.dev.demo.service.EmailNotificationService;
import com.knf.dev.demo.service.NotificationService;
import com.knf.dev.demo.service.SMSNotificationService;
import com.knf.dev.demo.service.TwitterNotificationService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application implements CommandLineRunner {

    @Autowired
    NotificationService emailNotification;

    @Autowired
    NotificationService twitterNotification;

    @Autowired
    NotificationService smsNotification;

   public static void main(String[] args) {
               SpringApplication.run(Application.class, args);
   }

    @Override
    public void run(String... args) throws Exception {

        System.out.println(emailNotification.
                sendNotification("Email message"));
        System.out.println(twitterNotification.
                sendNotification("Twitter message"));
        System.out.println(smsNotification.
                sendNotification("SMS message"));
    }
}

Application is the entry point that sets up the Spring Boot application. The @SpringBootApplication annotation enables auto-configuration and component scanning. 

Let's run this Spring boot application from either IntelliJ IDEA IDE by right click - Run 'Application.main()'
Or you can use the below maven command to run:

mvn spring-boot:run

Console Output:
Email Notification: Email message
Twitter Notification: Twitter message
SMS Notification: SMS message


Download Source Code

$ git clone https://github.com/knowledgefactory4u/spring-boot-annotations

More related topics,

Spring Web Annotations


Spring Core Annotations

Popular posts from this blog

Learn Java 8 streams with an example - print odd/even numbers from Array and List

Example 1: Java 8 program to print odd numbers from a List   import java.util.Arrays; import java.util.List; import java.util.stream.Collectors; /*Java 8 Program to find Odd Numbers from a List*/ public class DriverClass { public static void main( String [] args) { List < Integer > numbers = Arrays. asList( 1 , 4 , 8 , 40 , 11 , 22 , 33 , 99 ); List < Integer > oddNumbers = numbers.stream(). filter(o -> o % 2 != 0 ). collect(Collectors.toList()); System.out.println(oddNumbers); } } 1. Initialize List using Arrays.asList() method. Java's built-in Arrays.asList() method converts an array into a list. This method takes an array as an argument and returns a List object. 2.  Java List interface provides stream() method which returns a sequential Stream with list of Integer as its source. 3. The Java stream filter(...
Read more

Java Stream API - How to convert List of objects to another List of objects using Java streams?

Image
In this section, we will show you how to convert a List of objects to another List of objects in Java using the Java streams map(). The ‘map’ method maps each element to its corresponding result. Java Stream API   The Java Stream API provides a functional programming approach over the object oriented capabilities of Java. It is used for processing collections of objects. The Stream in Java can be defined as a sequence of elements from a source List, Set or Array. Most of the stream operations return a Stream. This avails engender a chain of stream operations(stream pipe-lining). The streams withal support the aggregate or terminal operations on the elements. for example, finding the sum or maximum element or finding the average etc...Stream operations can either be executed sequentially or parallel. when performed parallelly, it is called a parallel stream.   Stream map() Method   The Java 8 Stream map() is an intermediate operation. It converts Stream<obj1> to Str...
Read more

Registration and Login with Spring Boot + Spring Security + Thymeleaf

Image
In this section, we will learn how to create user registration and login using Spring boot, Spring security, Thymeleaf, JPA, and H2DB. The GitHub repository link is provided at the end of this tutorial. You can download the source code. Technologies used: Spring Boot 2.5.5  Spring Data JPA  Spring Security  Thymeleaf  Maven 3+  Java 17  H2 Database   User Interface User Registration Authentication Failed Authentication success Sign out Final Project Structure: Complete pom.xml: <? xml version ="1.0" encoding ="UTF-8" ?> < project xmlns ="http://maven.apache.org/POM/4.0.0" xmlns: xsi ="http://www.w3.org/2001/XMLSchema-instance" xsi :schemaLocation ="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" > < modelVersion >4.0.0</ modelVersion > < parent > < groupId >org.springframework.boot</ groupId > < artifactId >spring-boot-starter-pare...
Read more

Java, Spring Boot Mini Project - Library Management System - Download

Image
Hello everyone, Hope you are doing well. Here, we provide a Library Management System mini-project for beginners, it's free for download. Maybe you can build more on top of this project and create your own product, that's all about you. The source code download link is provided at the end of this post. 1. Benefit of this project You could cover the following technologies and features by learning and debugging this mini project. Java 17 Java Stream Java Lamda Expressions Java Records Functional programming Object-oriented programming var Keyword in Java Generics in Java Java Switch Spring boot 2.6.4 Spring Security Thymeleaf template engine OpenCSV Spring Data JPA Server Side Pagination H2 Database  Bootstrap HTML CSS and more... 2. Objective Of Spring Boot On Library Management System The main objective of this project is to manage the details of the books, author, category, and publisher. Only Admin/Librarian will manage all these activities. Also, they can export the data in ...
Read more

ReactJS, Spring Boot JWT Authentication Example

Image
In this tutorial, we’ll create a user registration & login example using ReactJS, Spring Boot, Spring Security, and JWT authentication. You could download the source code from our Github repository, the download link is provided at the end of this tutorial. Technologies used Backend Technologies: Java 17 Spring Boot 2.7.0 Spring Security Spring Data JPA JWT H2 Database Frontend Technologies: React 17.0.1 Axios 0.27.2 Redux 4.0.5 Bootstrap 4.5.2 ReactJS - SpringBoot - JWT - Flow Backend Project Directory: Frontend Project Directory: Following is the screenshot of our application - User Registration: User Signin: Profile View: Access Resource: We will build two projects:  1. Backend:   spring-boot-security-jwt 2. Frontend: react-redux-jwt Project 1: spring-boot-security-jwt Pom.xml <?xml version = "1.0" encoding = "UTF-8" ?> <project xmlns = "http://maven.apache.org/POM/4.0.0" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"...
Read more

Top 5 Java ORM tools - 2024

Image
  The term ORM refers to object-relational mapping, which uses objects to adapt programming languages to database systems while allowing them to function with SQL and object-oriented programming ideas. Any kind of database management system that can accomplish object mapping to the table in the virtual system is suitable for the implementation of ORM. Java has a wide variety of ORM tools, some of which are mentioned below: 1. Hibernate Hibernate is a lightweight, open-source, non-invasive Java ORM (Object-Relational Mapping) framework that allows developers to create objects that function independently of database software and create persistence logic in any Java or JavaEE application. It offers an abstraction layer, so developers don't have to bother about implementations; Hibernate handles these tasks internally, such as connecting to databases and creating queries to carry out CRUD operations, among other things. Persistence logic development is done with it. Persistence logic r...
Read more

Java - Blowfish Encryption and decryption Example

Image
Blowfish is an encryption method developed by Bruce Schneier in 1993 as an alternative to the DES encryption method. It is significantly faster than DES and provides good encryption speed, although no effective cryptanalysis technique has been found to date. It is one of the first secure block ciphers that is not protected by any patents and is therefore freely available for anyone to use. This is a symmetric block cipher algorithm. Block size: 64 bits Key size: variable size from 32 to 448 bits number of subsections: 18 [P-array] number of rounds: 16 number of substitution blocks: 4 [each with 512 records of 32 bits each] develop  Example 1: Encryption and decryption using Blowfish import java.io.UnsupportedEncodingException; import java.nio.charset.Charset; import java.security.InvalidKeyException; import java.security.NoSuchAlgorithmException; import java.util.Base64; import javax.crypto.BadPaddingException; import javax.crypto.Cipher; import javax.crypto.IllegalBlockSiz...
Read more

Spring boot video streaming example-HTML5

Image
Hello everyone, Today we will learn how to stream MP4 video using Spring Boot and Spring Web Flux.  The Source code download link is provided at the end of this post. New, Quarkus Practice User Interface   Project Structure: G radle(build.gradle) plugins { id 'org.springframework.boot' version '2.5.4' id 'io.spring.dependency-management' version '1.0.11.RELEASE' id 'java' } group = 'com.knf.demo' version = '0.0.1-SNAPSHOT' sourceCompatibility = '11' repositories { mavenCentral() } dependencies { implementation 'org.springframework.boot:spring-boot-starter-webflux' testImplementation 'org.springframework.boot:spring-boot-starter-test' testImplementation 'io.projectreactor:reactor-test' } test { useJUnitPlatform() } Service (VideoStreamingService.java) package  com.knf.demo.service ; import org.springframework.beans.factory.annotation. Autowired ; import org.springframework...
Read more

Google Cloud Storage + Spring Boot - File Upload, Download, and Delete

Image
In this section, we will learn  how to  create a simple spring boot application to perform different file operations such as upload, download, list, and delete files from the Google Cloud Storage. 1.  A little bit of Background Google Cloud Storage Cloud Storage is a managed service for storing unstructured data. Store any amount of data and retrieve it as often as you like. More Info - click here! Spring Boot Spring Boot makes it easy to create stand-alone, production-grade Spring-based Applications that you can "just run".  More Info - click here! 2. Create a GCP Project First, Sign into the Google console at  https://console.cloud.google.com . You can create a new project by first selecting the project dropdown in the top left and selecting " New Project ". Next, specify your GCP  Project name  and  Project ID . Then  Click on the " CREATE " button. Copy " Project ID " and keep it for future purposes. 3. Create a Google Cloud Storage bucke...
Read more