Spring @ConfigurationProperties for multiple properties returning empty

Question

application.properties file contains properties that have sub properties:

status.available=00, STATUS.ALLOWED
status.forbidden=01, STATUS.FORBIDDEN
status.authdenied=05, STATUS.AUTH_DENIED

The idea was to get those properties into the application like this:

@Configuration
@ConfigurationProperties(prefix = "status")
@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE)
public class StatusProperties {

    private Map <String, List <String>> statusMapping;

    public Map <String, List <String>> getStatusMapping () {
        return statusMapping;
    }

    public void setStatusMapping (Map <String, List <String>> statusMapping) {
        this.statusMapping = statusMapping;
    }
}

The problem is that this Map is returned empty. I must be doing something wrong. Maybe this is not even possible in Spring to do like this?

Community · Accepted Answer · 2020-06-20 09:12:55Z

3

I'm not sure about your choice regarding the data type and its assignment. I'd suggest you to rethink this design.

To your main question:

Spring can't know, that status.* should be mapped to private Map <String, List <String>> statusMapping;. Also as your class is named *properties, It seems that you don't want it to be a @Configuration class. Consider the following pattern:

First, create a properties class to hold the properties:

@ConfigurationProperties(prefix = "status")
public class StatusProperties {

    private Map.Entry<Integer, String> available;
    private Map.Entry<Integer, String> forbidden;
    private Map.Entry<Integer, String> authdenied;

    public Map.Entry<Integer, String> getAvailable() {
        return available;
    }

    public void setAvailable(Map.Entry<Integer, String> available) {
        this.available = available;
    }

    public Map.Entry<Integer, String> getForbidden() {
        return forbidden;
    }

    public void setForbidden(Map.Entry<Integer, String> forbidden) {
        this.forbidden = forbidden;
    }

    public Map.Entry<Integer, String> getAuthdenied() {
        return authdenied;
    }

    public void setAuthdenied(Map.Entry<Integer, String> authdenied) {
        this.authdenied = authdenied;
    }
}

Now, your IDE should be able to read the docs from the setters while editing application.properties and check the validity. Spring can autowire the fields and automatically create the correct data types for you.

Consider mapping the Entries to a Map (Or, as I already told, change the design)

Now, you can use this properties class in your configuration:

@Configuration
@EnableConfigurationProperties(StatusProperties.class)
public class StatusConfiguration {
    @Bean
    public MyBean myBean(StatusProperties properties) {
        return new MyBean(properties);
    }
}

edited Jun 20, 2020 at 9:12

CommunityBot

11 silver badge

answered Dec 13, 2017 at 9:30

Clijsters

4,3722 gold badges30 silver badges39 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Deniss M. Over a year ago

This is the standard way of doing. The idea here was to dynamically insert properties without Spring knowing the specific types of properties. That way a user can modify the application.properties file but doesn't need to modify the code.

Clijsters Over a year ago

Than you could even go back to using Objects or Strings as Data Type. IMHO the strict typing of app props is a great benefit

Deniss M. Over a year ago

I found a solution to my problem, it was here: mkyong.com/spring-boot/… I'm going to post the answer.

Clijsters Over a year ago

Which is what I meant, suggesting to change your design

Deniss M. · Accepted Answer · 2017-12-13 10:01:09Z

I found the solution:

application.properties:

app.statuses[0].id=00
app.statuses[0].title=STATUS.ALLOWED
app.statuses[1].id=01
app.statuses[1].title=STATUS.FORBIDDEN
app.statuses[2].id=02
app.statuses[2].title=STATUS.CONTRACT_ENDED

Properties.java

@Component
@ConfigurationProperties(prefix = "app")
@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.NONE)
public class StatusProperties {

    private List<Status> statuses = new ArrayList<>();

    public List <Status> getStatuses () {
        return statuses;
    }

    public void setStatuses (List <Status> statuses) {
        this.statuses = statuses;
    }

    public static class Status {
        private String id;
        private String title;

        public String getId () {
            return id;
        }

        public void setId (String id) {
            this.id = id;
        }

        public String getTitle () {
            return title;
        }

        public void setTitle (String title) {
            this.title = title;
        }
    }
}

Collectives™ on Stack Overflow

Spring @ConfigurationProperties for multiple properties returning empty

2 Answers 2

To your main question:

4 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

To your main question:

4 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related