Complete Guide to Configuring Active Profiles in Spring Boot via Maven

Fundamental Differences Between Maven Profiles and Spring Profiles

Before delving into configuration methods, it is crucial to understand that Maven profiles and Spring profiles are fundamentally different concepts. Maven profiles operate during the build process, controlling Maven's behavior during compilation and packaging, while Spring profiles function at runtime, managing Spring application behavior across different environments. This fundamental distinction explains why setting spring.profiles.active directly in Maven profiles does not take effect.

Core Principles of Resource Filtering

To establish linkage between Maven profiles and Spring profiles, Maven's resource filtering mechanism must be employed. Resource filtering enables placeholder substitution in resource files during the build process, thereby transferring Maven properties to the final application.

Detailed Configuration Steps

First, define a placeholder in the application.properties file:

spring.profiles.active=@spring.profiles.active@

The @spring.profiles.active@ placeholder must exactly match the property name defined in the Maven profile.

Next, enable resource filtering in pom.xml:

<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <filtering>true</filtering>
        </resource>
    </resources>
</build>

When Maven build is executed, all files in the src/main/resources directory will be processed, and placeholders within them will be replaced with corresponding Maven property values.

Complete Maven Profile Example

The following is a complete Maven profile example demonstrating how to set a default-activated development environment profile:

<profiles>
    <profile>
        <id>development</id>
        <properties>
            <spring.profiles.active>development</spring.profiles.active>
        </properties>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
    </profile>
</profiles>

Comparative Analysis of Alternative Configuration Methods

Beyond the resource filtering approach, several other methods exist for setting Spring profiles:

Using Maven Spring Boot plugin to directly specify profiles:

mvn spring-boot:run -Dspring-boot.run.profiles=development

Setting through JVM system parameters:

java -jar -Dspring.profiles.active=development application.jar

Using environment variables in Unix environments:

export spring_profiles_active=development

Programmatic configuration approach:

SpringApplication.setAdditionalProfiles("development");

Annotation-based approach in testing environments:

@ActiveProfiles("development")

Best Practice Recommendations

For projects requiring tight integration with Maven build processes, the resource filtering mechanism is recommended. This approach ensures that build artifacts remain consistent with corresponding environment configurations, avoiding potential errors from manual configuration. Additionally, it is advisable to clearly document the usage scenarios of various configuration methods within the project, enabling team members to select the most appropriate approach based on specific requirements.