Map yaml to object hashmap in SpringBoot

Question

I am trying to Map the yml file to a HashMap with String Key and PromotionPolicy value in my Spring boot application and using the default spring boot implementation to parse the values, but the PromotionPolicy object only contains the default values [0, false, false] for all instances when I try to read values from the Map.

My yml is :

promotionPolicies : 
    policies: 
        P001NN:
            PromotionPolicy:
                expiryPeriodInDays: 16
                reusable: true
                resetExpiry: false
        P001YN:
            PromotionPolicy:
                expiryPeriodInDays:1
                reusable:true
                resetExpiry:false
        P001NY:
            PromotionPolicy:
                expiryPeriodInDays:1
                reusable:false
                resetExpiry:true

The Model I have is :

public class PromotionPolicy {

private int expiryPeriodInDays;
private boolean reusable;
private boolean resetExpiry;

public int getExpiryPeriodInDays() {
    return expiryPeriodInDays;
}
public void setExpiryPeriodInDays(int expiryPeriodInDays) {
    this.expiryPeriodInDays = expiryPeriodInDays;
}
public boolean isReusable() {
    return reusable;
}
public void setReusable(boolean reusable) {
    this.reusable = reusable;
}
public boolean isResetExpiry() {
    return resetExpiry;
}
public void setResetExpiry(boolean resetExpiry) {
    this.resetExpiry = resetExpiry;
}

}

The component java class is as below:

@Configuration
@ConfigurationProperties(prefix = "promotionPolicies")
@EnableConfigurationProperties
@Component
public class PromotionPolicyConfig {

private Map<String, PromotionPolicy> policies = new HashMap<String, PromotionPolicy>();

public void setPolicies(Map<String, PromotionPolicy> policies) {
    this.policies = policies;
}

public Map<String, PromotionPolicy> getPolicies() {
    return policies;
}

}

Trying to display values here :

@RestController
@RequestMapping("/test")
public class LoyaltyServiceController {

@Autowired
PromotionPolicyConfig promotionPolicyConfig;

@RequestMapping(value = "/try")
public String tryThis() {
    for (Entry<String, PromotionPolicy> entry : promotionPolicyConfig.getPolicies().entrySet()) {
        System.out.print(entry.getKey() + " : ");
        System.out.print(entry.getValue() + " : ");
        System.out.print(entry.getValue().getExpiryPeriodInDays()  + " : ");
        System.out.print(entry.getValue().isResetExpiry()  + " : ");
        System.out.println(entry.getValue().isReusable()  + " : ");
    }
}

My Output is as below:

P001NN : com.expedia.www.host.loyalty.model.PromotionPolicy@63a1c99b : 0 : false : false : 
P001YN : com.expedia.www.host.loyalty.model.PromotionPolicy@7892b6b6 : 0 : false : false : 
P001NY : com.expedia.www.host.loyalty.model.PromotionPolicy@459928ab : 0 : false : false :

while I expected the result to contain the values in my yml. I also tried removing the line "PromotionPolicy:" in my yml, but no luck.

Request help understand how can I Map the yml into the Map of custom objects.

may be this will help http://stackoverflow.com/questions/32593014/mapping-list-in-yaml-to-list-of-objects-in-spring-boot — pvpkiran, Apr 19 '17 at 22:21

score 12 · Answer 1 · edited Oct 26 '19 at 18:25

12

change your yml to

promotionPolicies : 
  policies: 
    P001NN:
            expiryPeriodInDays: 16
            reusable: true
            resetExpiry: false
    P001YN:
            expiryPeriodInDays: 1
            reusable: true
            resetExpiry: false
    P001NY:
            expiryPeriodInDays: 1
            reusable: false
            resetExpiry: true

edited Oct 26 '19 at 18:25

Community

1
1

answered Apr 20 '17 at 08:09

pvpkiran

25,582
8
87
134

1

As I had mentioned in the description, I tried it, but no luck. It still has the same default values 0, false, false. – Manjunath Apr 20 '17 at 18:49
The issue in the earlier yml was the space, The below YML worked fine. – Manjunath Sep 30 '18 at 23:21
@Manjunath then kindly, please flag this as the answer :) – Juan Rada Sep 11 '19 at 18:31

score 8 · Answer 2 · answered Aug 11 '19 at 21:01

This worked for me

YML:

property-name: '{
  key1: "value1",
  key2: "value2"
}'

Spring Boot:

  @Value("#{${property-name}}")
  private Map<String,String> myMap;

found the answer thanks to : https://relentlesscoding.com/2018/09/09/spring-basics-dynamically-inject-values-with-springs-value/

score 0 · Answer 3 · answered Sep 25 '20 at 06:01

        promotionPolicies : 
          policies: 
            P001NN:
                    expiryPeriodInDays: 16
                    reusable: true
                    resetExpiry: false
            P001YN:
                    expiryPeriodInDays: 1
                    reusable: true
                    resetExpiry: false
            P001NY:
                    expiryPeriodInDays: 1
                    reusable: false
                    resetExpiry: true

Java code :

        //Used lambok and spring annotation
        @Data
        @Configuration
        @ConfigurationProperties(prefix = "promotionPolicies")
        @NoArgsConstructor
        @AllArgsConstructor
        public class PromotionPolicies {
            private Map<String, Map<String, String>> policies = new HashMap<>();
        }

score 0 · Answer 4 · edited Aug 09 '23 at 04:33

0

I recently solved a similar problem. In my case a default, i.e. no argument, constructor was required for PromotionPolicy class.

edited Aug 09 '23 at 04:33

Abra

19,142
7
29
41

answered Aug 05 '23 at 13:59

Samson Emelyanov

3
2

score -1 · Answer 5 · answered Oct 01 '18 at 03:37

The problem was with the spaces, the below yml works fine. The spaces after the text and : was required

promotionPolicies : 
    policies : 
        P001NN :
            PromotionPolicy :
                expiryPeriodInDays: 16
                reusable: true
                resetExpiry: false
        P001YN :
            PromotionPolicy :
                expiryPeriodInDays:1
                reusable:true
                resetExpiry:false
        P001NY :
            PromotionPolicy :
                expiryPeriodInDays:1
                reusable:false
                resetExpiry:true

That's unlikely the cause of the issue. – Jonathan Rioux Jun 07 '21 at 19:15 — Jonathan Rioux, Jun 07 '21 at 19:15

Map yaml to object hashmap in SpringBoot

5 Answers5