How to use @ConstructorBinding and @PropertySource together with @ConfigurationProperties with in Spring Boot 2.2.4?

user_12959513 0
Viewed 9340

I am new to Spring Boot. Currently, I am trying to create a POJO class (SystemProperties.class) to read the value in a properties file (parameter.properties separate from application.properties but still under the same directory /src/main/resources. The issue happens when I am using the @ConstructorBinding in the class in order for it to be immutable.

  • @ConstructorBinding needs to be used with @EnableConfigurationProperties or @ConfigurationPropertiesScan.
  • @ConfigurationPropertiesScan will ignore @Configuration annotation which is needed when using @PropertySource to specify external
    *.properties file.

A) SystemProperties.class

@Configuration
@PropertySource("classpath:parameter.properties")

@ConstructorBinding
@ConfigurationProperties(prefix = "abc")
public class SystemProperties {

    private final String test;

    public SystemProperties (
            String test) {
        this.test = test;
    }

    public String getTest() {
        return test;
    }

B) parameter.properties

abc.test=text1

I have tried to remove the @PropertySource annotation but the value cannot be retrieved unless it is from the application.properties. Any help is greatly appreciated!

spring-boot immutability spring java
1 Answers

The way to solve this is to split the class into two classes with two different concerns. With such solution, you retain the SystemProperties class you created and additionally add another class simply for loading the properties file parameters to make them available to your application.

The solution would be as follows:

@ConstructorBinding
@ConfigurationProperties(prefix = "abc")
public class SystemProperties {

    private final String test;

    public SystemProperties(
            String test) {
        this.test = test;
    }

    public String getTest() {
        return test;
    }
}

Notice that I have omitted the @Configuration and @PropertySource annotations.

@Configuration
@PropertySource("classpath:parameter.properties")
public class PropertySourceLoader {
}

Notice I have simply added this annotations on a new class, solely created to load the properties file.

Finally, you can add @ConfigurationPropertiesScan on your main application class to enable the property mapping mechanism.

user_40906510
Related