如何使用@Value Spring Annotation注入Map？

Question

如何使用Spring中的@Value注释从属性文件中将值注入Map？

我的Spring Java类是和我尝试使用$但是,得到以下错误消息

无法自动装配字段:private java.util.Map Test.standard; 嵌套异常是java.lang.IllegalArgumentException:无法解析字符串值"$ {com.test.standard}"中的占位符'com.test.standard'

@ConfigurationProperty("com.hello.foo")
public class Test {

   @Value("${com.test.standard}")
   private Map<String,Pattern> standard = new LinkedHashMap<String,Pattern>

   private String enabled;

}

我在.properties文件中有以下属性

com.test.standard.name1=Pattern1
com.test.standard.name2=Pattern2
com.test.standard.name3=Pattern3
com.hello.foo.enabled=true

Answer 1

您可以使用这样的@Value注释从属性文件中将值注入Map .

属性文件中的属性.

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

在你的代码中.

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

请注意标签作为注释的一部分.

Answer 2

您可以.properties使用@Resource注释在类中注入地图.

如果您正在使用XML based configuration,请在spring配置文件中添加以下bean:

 <bean id="myProperties" class="org.springframework.beans.factory.config.PropertiesFactoryBean">
      <property name="location" value="classpath:your.properties"/>
 </bean>

对于,基于注释:

@Bean(name = "myProperties")
public static PropertiesFactoryBean mapper() {
        PropertiesFactoryBean bean = new PropertiesFactoryBean();
        bean.setLocation(new ClassPathResource(
                "your.properties"));
        return bean;
}

然后,您可以在应用程序中将它们作为地图进行选择:

@Resource(name = "myProperties")
private Map<String, String> myProperties;

Answer 3

我相信Spring Boot支持使用@ConfigurationProperties注释加载开箱即用的属性映射.

根据该文档,您可以加载属性:

my.servers[0]=dev.bar.com
my.servers[1]=foo.bar.com

像这样的bean:

@ConfigurationProperties(prefix="my")
public class Config {

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

    public List<String> getServers() {
        return this.servers;
    }
}

之前我使用过@ConfigurationProperties功能,但没有加载到地图中.您需要使用@EnableConfigurationProperties批注来启用此功能.

关于此功能的很酷的事情是您可以验证您的属性.

Answer 4

我有一个简单的 Spring Cloud Config 代码

像这样：

在 application.properties 中

spring.data.mongodb.db1=mongodb://test@test1.com

spring.data.mongodb.db2=mongodb://test@test2.com

读

@Bean(name = "mongoConfig")
@ConfigurationProperties(prefix = "spring.data.mongodb")
public Map<String, Map<String, String>> mongoConfig() {
    return new HashMap();
}

用

@Autowired
@Qualifier(value = "mongoConfig")
private Map<String, String> mongoConfig;

@Bean(name = "mongoTemplates")
public HashMap<String, MongoTemplate> mongoTemplateMap() throws UnknownHostException {
    HashMap<String, MongoTemplate> mongoTemplates = new HashMap<>();
    for (Map.Entry<String, String>> 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;
}

Answer 5

要使其与 YAML 一起使用，请执行以下操作：

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

Answer 6

这是我们的方法。以下是两个示例类：

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<String, String> consumerFactory() {
        return new DefaultKafkaConsumerFactory<>(kafkaConsumerProperties.getKafkaConsumerConfig());
    }
...

@Configuration
@ConfigurationProperties
public class KafkaConsumerProperties {
    protected Map<String, Object> kafkaConsumerConfig = new HashMap<>();

    @ConfigurationProperties("kafkaConsumerConfig")
    public Map<String, Object> getKafkaConsumerConfig() {
        return (kafkaConsumerConfig);
    }
...

要从属性文件提供kafkaConsumer配置，可以使用：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

要从yaml文件提供kafkaConsumer配置，可以使用“ [key]”：value在application.yml文件中：

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

Answer 7

以下为我工作：

SpingBoot 2.1.7.RELEASE

YAML 属性（用单引号括起来的通知值）

property:
   name: '{"key1": false, "key2": false, "key3": true}'

在 Java/Kotlin 中使用 (Notice use of #) 注释字段（对于 Java 不需要用 '\' 转义 '$'）

@Value("#{\${property.name}}")