Getting lists from Spring Boot configuration

Question

My Spring Boot application doesn't seem to be recognising lists in my configuration file (application.yml). Below is roughly what I'm trying to do.

Java Code:

@Autowired
private Environment environment;

public class Config{
  public Config(){
  }

  public List<String> getDateFields(){
    return environment.getProperty("dates.fields", List.class);
  }
}

application.yml:

dates:
  fields:
  - date
  - creationDate

getDateFields returns null above. However, if I use the following...

application.yml:

dates:
  fields: creationDate

...it works fine and returns it as a list (albeit a single valued one). Why can't I get the list from my application.yml file? I tried checking whether environment even contained dates.fields, and environment.containsProperty("dates.fields") returns false when using the list version.

johnnymnmonic · Accepted Answer · 2016-11-18 15:06:24Z

6

Use coma separated format, for your list properties if you want to load the values as List using environment.getProperty("dates.fields", List.class);

dates:
  fields: date, creationDate

that way goes well for me.

However if you want to use

dates:
  fields:
     - date
     - creationDate

Then better use the following aproach to load the properties from yaml file.

@Component
@ConfigurationProperties(prefix = "dates")
public class Config{

   private List<String> fields = new ArrayList<String>();

   public List<String> getDateFields(){
      return this.fields;
   }
}

answered Nov 18, 2016 at 15:06

johnnymnmonic

7949 silver badges12 bronze badges

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

Collectives™ on Stack Overflow

Getting lists from Spring Boot configuration

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related