@Profile for environment-specific beans in Spring Boot

Introduction

The @Profile annotation helps you create different versions of a bean for different environments, like development or production. This way, your app uses the right settings automatically.

When you want to use a special database connection for testing but a different one for production.

When you need to enable debug logging only in development but not in production.

When you want to switch between different service implementations based on the environment.

When you want to avoid changing code manually for each environment.

When you want to keep environment-specific settings clean and organized.

Syntax

Spring Boot

@Profile("profileName")
@Component
public class YourBean {
    // bean code here
}

The @Profile annotation goes on a class or method that creates a bean.

The profileName is a string that matches the active environment profile.

Examples

This bean is only active when the 'dev' profile is active.

Spring Boot

@Profile("dev")
@Component
public class DevDataSource {
    // dev database config
}

This bean is only active when the 'prod' profile is active.

Spring Boot

@Profile("prod")
@Component
public class ProdDataSource {
    // production database config
}

This bean works in either 'dev' or 'test' environments.

Spring Boot

@Profile({"dev", "test"})
@Component
public class DevOrTestService {
    // bean active in dev or test profiles
}

Sample Program

This example shows two beans with @Profile: one for 'dev' and one for 'prod'. When you run the app with --spring.profiles.active=dev, it prints the development greeting. With prod active, it prints the production greeting.

Spring Boot

import org.springframework.context.annotation.Profile;
import org.springframework.stereotype.Component;

public interface GreetingService {
    String greet();
}

@Profile("dev")
@Component
public class DevGreetingService implements GreetingService {
    public String greet() {
        return "Hello from Development!";
    }
}

@Profile("prod")
@Component
public class ProdGreetingService implements GreetingService {
    public String greet() {
        return "Hello from Production!";
    }
}

// Usage example in a Spring Boot app
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 ProfileDemoApplication implements CommandLineRunner {

    @Autowired
    private GreetingService greetingService; // Dev or Prod based on active profile

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

    @Override
    public void run(String... args) {
        System.out.println(greetingService.greet());
    }
}

Important Notes

You activate a profile by setting spring.profiles.active in application.properties or as a command line argument.

If no profile matches, Spring won't create the bean with @Profile.

You can use multiple profiles by listing them in @Profile({"dev", "test"}).

Summary

@Profile lets you create beans only for certain environments.

Use it to keep your app flexible and environment-aware without changing code.

Activate profiles easily with Spring Boot settings or command line options.

Practice

1. What is the main purpose of the @Profile annotation in Spring Boot?

easy

A. To define the database connection URL

B. To schedule tasks at fixed intervals

C. To create beans only for specific environments

D. To handle HTTP requests in controllers

Solution

1. Step 1: Understand the role of @Profile

   The @Profile annotation is used to mark beans that should only be created when a specific environment profile is active.

2. Step 2: Compare with other options

   Options A, C, and D relate to other Spring Boot features but not to environment-specific bean creation.

3. Final Answer:

   To create beans only for specific environments -> Option C

4. Quick Check:

   @Profile controls bean creation per environment [OK]

Hint: Remember: @Profile controls which beans load per environment [OK]

Common Mistakes:

• Confusing @Profile with @Component or @Service
• Thinking @Profile sets database URLs
• Assuming @Profile schedules tasks

2. Which of the following is the correct way to use @Profile on a Spring bean class for the "dev" environment?

easy

A. @Profile("dev")
public class DevService {}

B. @Profile(dev)
public class DevService {}

C. @Profile({dev})
public class DevService {}

D. @Profile(["dev"])
public class DevService {}

Solution

1. Step 1: Check correct syntax for @Profile

   The @Profile annotation requires a string value in quotes, e.g., @Profile("dev").

2. Step 2: Analyze each option

   @Profile(["dev"]) public class DevService {} uses square brackets, invalid Java annotation syntax. @Profile(dev) public class DevService {} misses quotes around "dev", syntax error. @Profile({dev}) public class DevService {} uses braces but misses quotes around "dev", syntax error. @Profile("dev") public class DevService {} uses correct quoted string syntax.

3. Final Answer:

   @Profile("dev") public class DevService {} -> Option A

4. Quick Check:

   @Profile needs quoted string [OK]

Hint: Use quotes around profile names in @Profile [OK]

Common Mistakes:

• Omitting quotes around profile names
• Using square brackets instead of curly braces
• Confusing array syntax with string

3. Given the following Spring Boot configuration and beans, what will be the output when the active profile is set to "prod"?

@Profile("dev")
@Component
public class DevBean {
    public String getMessage() { return "Development Bean"; }
}

@Profile("prod")
@Component
public class ProdBean {
    public String getMessage() { return "Production Bean"; }
}

@Component
public class BeanUser {
    private final Object bean;
    public BeanUser(@Autowired(required = false) Object bean) { this.bean = bean; }
    public String show() { return bean == null ? "No Bean" : ((ProdBean)bean).getMessage(); }
}

medium

A. Development Bean

B. Production Bean

C. ClassCastException at runtime

D. No Bean

Solution

1. Step 1: Identify active profile and beans created

   With profile "prod" active, only ProdBean is created. DevBean is not created.

2. Step 2: Analyze BeanUser constructor injection

   BeanUser tries to autowire an Object bean with @Autowired(required = false). Spring injects the available ProdBean instance as it matches.

3. Step 3: Check the show() method

   In show(), bean is cast to ProdBean, which succeeds, returning "Production Bean".

4. Final Answer:

   Production Bean -> Option B

5. Quick Check:

   Prod profile loads ProdBean successfully [OK]

Hint: Profile determines available beans for injection [OK]

Common Mistakes:

• Thinking Object type causes injection failure
• Expecting ClassCastException with matching profile
• Confusing which beans load per profile

4. You have two beans annotated with @Profile("test") and @Profile("prod") respectively. When running the app with no active profile set, you get a NoSuchBeanDefinitionException. What is the most likely cause?

medium

A. The beans are not annotated with @Component

B. The beans have syntax errors in @Profile annotation

C. Spring Boot does not support @Profile annotation

D. No profile is active, so no beans with @Profile are created

Solution

1. Step 1: Understand @Profile behavior with no active profile

   If no profile is active, Spring does not create beans annotated with any specific profile.

2. Step 2: Analyze exception cause

   NoSuchBeanDefinitionException means Spring could not find a bean to inject because none were created due to missing active profile.

3. Final Answer:

   No profile is active, so no beans with @Profile are created -> Option D

4. Quick Check:

   No active profile means no profile-specific beans [OK]

Hint: Beans with @Profile need active profile to load [OK]

Common Mistakes:

• Assuming beans load without active profile
• Blaming syntax errors without checking profiles
• Ignoring need for @Component on beans

5. You want to create a bean that is active in both "dev" and "test" profiles but not in "prod". Which @Profile annotation usage correctly achieves this?

hard

A. @Profile({"dev", "test"})

B. @Profile("dev & test")

C. @Profile("dev | test")

D. @Profile({"dev & test"})

Solution

1. Step 1: Understand @Profile multiple values usage

   Using @Profile({"dev", "test"}) means the bean is active if either "dev" OR "test" profile is active.

2. Step 2: Analyze other options

   @Profile("dev & test") and D use string with "&" which is invalid syntax for multiple profiles. @Profile("dev | test") uses "|" inside string which is not supported syntax.

3. Final Answer:

   @Profile({"dev", "test"}) -> Option A

4. Quick Check:

   Use array of profiles for OR condition in @Profile [OK]

Hint: Use array syntax for multiple profiles in @Profile [OK]

Common Mistakes:

• Using string with & or | inside @Profile
• Confusing AND and OR logic in profiles
• Forgetting to use curly braces for multiple profiles