@Profile for environment-specific beans in Spring Boot - Mini Project: Build & Apply

Using @Profile for Environment-Specific Beans in Spring Boot

📖 Scenario: You are building a Spring Boot application that needs to use different service implementations depending on the environment. For example, a DevelopmentService for development and a ProductionService for production.This helps you test features locally without affecting the live system.

🎯 Goal: Create two service beans with @Profile annotations for dev and prod environments, and configure Spring Boot to load the correct bean based on the active profile.

📋 What You'll Learn

Create a service interface called MyService

Create two implementations: DevService and ProdService

Annotate DevService with @Profile("dev")

Annotate ProdService with @Profile("prod")

Configure Spring Boot to activate the dev profile

Inject MyService into a controller and use it

💡 Why This Matters

🌍 Real World

Many applications need different configurations or beans for development, testing, and production environments to avoid mistakes and improve testing.

💼 Career

Understanding @Profile is essential for Spring developers to manage environment-specific beans and configurations effectively.

1

Create the service interface and development implementation

Create an interface called MyService with a method String serve(). Then create a class DevService that implements MyService and returns the string "Development Service" from serve(). Annotate DevService with @Service and @Profile("dev").

Spring Boot

// Create interface MyService with method serve()
// Create class DevService implementing MyService
// Annotate DevService with @Service and @Profile("dev")
// Implement serve() to return "Development Service"

Hint

Use @Profile("dev") above the DevService class to mark it for the development environment.

2

Create the production implementation

Create a class ProdService that implements MyService and returns the string "Production Service" from serve(). Annotate ProdService with @Service and @Profile("prod").

Spring Boot

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

public interface MyService {
    String serve();
}

@Service
@Profile("dev")
public class DevService implements MyService {
    @Override
    public String serve() {
        return "Development Service";
    }
}

// Create class ProdService implementing MyService
// Annotate ProdService with @Service and @Profile("prod")
// Implement serve() to return "Production Service"

Hint

Use @Profile("prod") above the ProdService class to mark it for the production environment.

3

Configure Spring Boot to activate the dev profile

In the application.properties file, add a line to set the active profile to dev using the key spring.profiles.active.

Spring Boot

# Add the active profile setting below
# Your code here

Hint

Set spring.profiles.active=dev in application.properties to activate the development profile.

4

Inject MyService into a controller and use it

Create a Spring @RestController class called MyController. Inject MyService using constructor injection. Add a @GetMapping("/service") method called getService() that returns the result of myService.serve().

Spring Boot

// Create @RestController class MyController
// Inject MyService via constructor
// Add @GetMapping("/service") method getService() returning myService.serve()

Hint

Use constructor injection to get MyService into the controller and return its serve() result in the GET method.

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