How to inject a Map using the Value Spring Annotation

Question

How can I inject values into a Map from the properties file using the  Value annotation in Spring  My Spring Java class is and I tried using the    but got the following error message   Could not autowire field  private java util Map Test standard  nested exception is java lang IllegalArgumentException  Could not resolve placeholder  com test standard  in string value  quot   com test standard  quot    ConfigurationProperty  quot com hello foo quot   public class Test        Value  quot   com test standard  quot      private Map lt String Pattern gt  standard   new LinkedHashMap lt String Pattern gt      private String enabled      I have the following properties in a  properties file com test standard name1 Pattern1 com test standard name2 Pattern2 com test standard name3 Pattern3 com hello foo enabled true

User · Answer

You can inject values into a Map from the properties file using the @Value annotation like this.

The property in the properties file.

propertyname={key1:'value1',key2:'value2',....}

In your code.

@Value("#{${propertyname}}")  private Map<String,String> propertyname;

Note the hashtag as part of the annotation.

User · Answer

You can inject  properties as a map in your class using  Resource annotation   If you are working with XML based configuration  then add below bean in your spring configuration file     lt bean id  myProperties  class  org springframework beans factory config PropertiesFactoryBean  gt         lt property name  location  value  classpath your properties   gt    lt  bean gt    For  Annotation based    Bean name    myProperties   public static PropertiesFactoryBean mapper             PropertiesFactoryBean bean   new PropertiesFactoryBean            bean setLocation new ClassPathResource                   your properties             return bean      Then you can pick them up in your application as a Map    Resource name    myProperties   private Map lt String  String gt  myProperties

User · Answer

To get this working with YAML  do this   property-name       key1   value1     key2   value2

User · Answer

Following worked for me   SpingBoot 2 1 7 RELEASE  YAML Property  Notice value sourrounded by single quotes   property     name     key1   false   key2   false   key3   true     In Java Kotlin annotate field with  Notice use of     For java no need to escape     with        Value       property name

User · Answer

I had a simple code for Spring Cloud Config like this  In application properties  spring data mongodb db1 mongodb   test test1 com spring data mongodb db2 mongodb   test test2 com  read  Bean name    quot mongoConfig quot    ConfigurationProperties prefix    quot spring data mongodb quot   public Map lt String  Map lt String  String gt  gt  mongoConfig         return new HashMap       use  Autowired  Qualifier value    quot mongoConfig quot   private Map lt String  String gt  mongoConfig    Bean name    quot mongoTemplates quot   public HashMap lt String  MongoTemplate gt  mongoTemplateMap   throws UnknownHostException       HashMap lt String  MongoTemplate gt  mongoTemplates   new HashMap lt  gt         for  Map Entry lt String  String gt  gt  entry   mongoConfig entrySet              String k   entry getKey            String v   entry getValue            MongoTemplate template   new MongoTemplate new SimpleMongoDbFactory new MongoClientURI v             mongoTemplates put k  template             return mongoTemplates

User · Answer

Here is how we did it   Two sample classes as follow   import org springframework beans factory annotation Autowired  import org springframework boot context properties EnableConfigurationProperties  import org springframework context annotation Bean  import org springframework context annotation Configuration  import org springframework kafka annotation EnableKafka   EnableKafka  Configuration  EnableConfigurationProperties KafkaConsumerProperties class  public class KafkaContainerConfig         Autowired     protected KafkaConsumerProperties kafkaConsumerProperties        Bean     public ConsumerFactory lt String  String gt  consumerFactory             return new DefaultKafkaConsumerFactory lt  gt  kafkaConsumerProperties getKafkaConsumerConfig                 Configuration  ConfigurationProperties public class KafkaConsumerProperties       protected Map lt String  Object gt  kafkaConsumerConfig   new HashMap lt  gt           ConfigurationProperties  kafkaConsumerConfig       public Map lt String  Object gt  getKafkaConsumerConfig             return  kafkaConsumerConfig               To provide the kafkaConsumer config from a properties file  you can use  mapname key  value    application properties kafkaConsumerConfig bootstrap servers  localhost 9092  localhost 9093  localhost 9094 kafkaConsumerConfig group id  test-consumer-group-local kafkaConsumerConfig value deserializer  org apache kafka common serialization StringDeserializer kafkaConsumerConfig key deserializer org apache kafka common serialization StringDeserializer   To provide the kafkaConsumer config from a yaml file  you can use   key    value In application yml file   kafkaConsumerConfig      bootstrap servers    localhost 9092  localhost 9093  localhost 9094     group id    test-consumer-group-local     value deserializer    org apache kafka common serialization StringDeserializer     key deserializer    org apache kafka common serialization StringDeserializer

User · Answer

I believe Spring Boot supports loading properties maps out of the box with  ConfigurationProperties annotation   According that docs you can load properties   my servers 0  dev bar com my servers 1  foo bar com   into bean like this    ConfigurationProperties prefix  my   public class Config        private List lt String gt  servers   new ArrayList lt String gt          public List lt String gt  getServers             return this servers            I used  ConfigurationProperties feature before  but without loading into map  You need to use  EnableConfigurationProperties annotation to enable this feature    Cool stuff about this feature is that you can validate your properties

[java] How to inject a Map using the @Value Spring Annotation?

Examples related to java

Examples related to spring

Examples related to dependency-injection

Examples related to annotations

Examples related to spring-annotations