Spring Boot Profiles

In this tutorial, we will deep dive into the features that spring profile going to offer

Spring Profiles:

Spring profiles help you to conditionally select various beans and configuration that should be included into the project. This will be very helpful if you work with multiple environments and configurations.

Any @Component or @Configuration can be marked with @Profile. spring.profiles.active property is used to define your active profile. This can be mentioned either in the configuration file(application.properties or application.yml) or through program arguments. If an active profile is specified through program arguments it will replace the profile defined in configuration file. Sometimes it is useful to have profile-specific properties that add to the active profiles rather than replace them. The spring.profiles.include property can be used to unconditionally add active profiles.

You can also programmatically set your profiles using SpringApplication#setAdditionalProfiles().

Profile-specific variants of configurations can also be defined. For example for "development" profile application-development.properties file is read and for "production" profile application-production.properties file is read.

Find this project on Github

https://github.com/javacodenet/spring-boot-profiles/

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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.javacodenet</groupId>
	<artifactId>spring-boot</artifactId>
	<version>1.0-SNAPSHOT</version>
	<parent>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-parent</artifactId>
	<version>1.4.0.RELEASE</version>
	</parent>
	<dependencies>
	<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
	</dependency>
	</dependencies>
	<build>
	<plugins>
	<plugin>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-maven-plugin</artifactId>
	</plugin>
	</plugins>
	</build>
	</project>

view raw pom.xml hosted with ❤ by GitHub

Application.java

	package com.javacodenet;
	import org.springframework.beans.factory.annotation.Autowired;
	import org.springframework.beans.factory.annotation.Value;
	import org.springframework.boot.SpringApplication;
	import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
	import org.springframework.boot.autoconfigure.SpringBootApplication;
	import org.springframework.web.bind.annotation.RequestMapping;
	import org.springframework.web.bind.annotation.RestController;
	@RestController
	@EnableAutoConfiguration
	@SpringBootApplication
	public class Application {
	@Autowired
	GenericConfiguration genericConfiguration;
	@Value("${profileSpecificMessage}")
	private String profileSpecificMessage;
	@Value("${defaultProfileMessage}")
	private String defaultProfileMessage;
	@RequestMapping("/")
	public String profiles() {
	return genericConfiguration.configurationMessage() + ", default profile message: " + defaultProfileMessage +
	", profile specific message: " + profileSpecificMessage;
	}
	public static void main(String[] args) {
	SpringApplication springApplication = new SpringApplication();
	//this will add profile to existing set of profiles
	springApplication.setAdditionalProfiles("default");
	SpringApplication.run(Application.class, args);
	}
	}

view raw Application.java hosted with ❤ by GitHub

GenericConfiguration.java

	package com.javacodenet;
	public interface GenericConfiguration {
	String configurationMessage();
	}

view raw GenericConfiguration.java hosted with ❤ by GitHub

ProdConfiguration.java

	package com.javacodenet;
	import org.springframework.context.annotation.Profile;
	import org.springframework.stereotype.Component;
	@Profile({"production", "default"})
	@Component
	public class ProdConfiguration implements GenericConfiguration {
	@Override
	public String configurationMessage() {
	return "Production Configuration Message";
	}
	}

view raw ProdConfiguration.java hosted with ❤ by GitHub

DevConfiguration.java

	package com.javacodenet;
	import org.springframework.context.annotation.Profile;
	import org.springframework.stereotype.Component;
	@Profile({"development"})
	@Component
	public class DevConfiguration implements GenericConfiguration {
	@Override
	public String configurationMessage() {
	return "Development Configuration Message";
	}
	}

view raw DevConfiguration.java hosted with ❤ by GitHub

application.properties

	server.context-path=/profiles
	spring.profiles.active=production
	defaultProfileMessage = "default"

view raw application.properties hosted with ❤ by GitHub

application-production.properties

profileSpecificMessage = "prod"

view raw application-production.properties hosted with ❤ by GitHub

application-development.properties

profileSpecificMessage = "dev"

view raw application-development.properties hosted with ❤ by GitHub

Output