Back to Spring Boot Course

Spring Boot allows you to define different application configurations for various environments (e.g., development, QA, staging, production) using profiles. The active profile determines which configuration file is loaded and which beans are created. This helps tailor the behavior of your application based on the environment it's running in.

Application Configuration with Profiles

• Default Configuration: You can define default configuration values in the application.properties file, which serves as the baseline for all profiles.

• Environment-Specific Overrides: Profile-specific configurations can be placed in separate properties files. For example:

application-dev.properties (for the development environment) application-qa.properties (for the QA environment) application-stage.properties (for the staging environment) application-prod.properties (for the production environment)

These files allow you to override the default configuration based on the active profile.

Setting the Active Spring Boot Profile

There are multiple ways to specify which profile should be active:

1. Via Command-Line Arguments (VM Properties): When launching the application, you can specify the active profile as a command-line argument:

java -Dspring.profiles.active=qa -jar target/covid-alert-service-1.0.0.jar

2. In application.properties: You can also specify the active profile in the application.properties file:

 spring.profiles.active=qa

3. Environment Variable: Alternatively, you can set the profile using an environment variable:

SPRING_PROFILES_ACTIVE=qa

When you set the active profile, Spring Boot will load the corresponding profile-specific properties and beans.

Using Profiles in Code

Spring Boot allows you to define beans that are only available in specific profiles using the @Profile annotation. This helps ensure that certain beans are only instantiated in the appropriate environments.

@Configuration
public class MyConfiguration {

    @Profile("dev")
    @Bean
    public String devBean() {
        return "I will be available in the 'dev' profile";
    }

    @Profile("prod")
    @Bean
    public String prodBean() {
        return "I will be available in the 'prod' profile";
    }
}

• The devBean() method is annotated with @Profile("dev"), meaning it will only be available when the dev profile is active.
• Similarly, the prodBean() method is annotated with @Profile("prod"), so it will only be available when the prod profile is active.

This enables you to control the creation of beans based on the environment, providing flexibility for different configurations.

In summary,

• Profiles allow you to manage environment-specific configurations in Spring Boot.
• Configuration files like application-dev.properties and application-prod.properties help override default settings.
• Setting the active profile can be done through command-line arguments, environment variables, or directly in the application.properties file.
• @Profile annotation in code enables you to define beans that should only be created in specific profiles.

By utilizing Spring Boot profiles effectively, you can easily adapt your application to different environments without duplicating configuration files or code.