@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"

Need a 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"

Need a 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

Need a 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()

Need a hint?

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