如何使用@Value Spring注解注入一个Map？

Question

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

我的 Spring Java class 是，我尝试使用 $，但收到以下错误消息：

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 "${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

您可以使用 @Resource 注释将 .properties 作为地图注入 class。

如果您正在使用 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 2

我相信 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 annotation 来启用此功能。

此功能的妙处在于您可以 validate your properties。

Answer 3

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

属性文件中的属性。

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

在你的代码中。

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

注意标签作为注释的一部分。

Answer 4

这是我们的做法。两个样本类如下：

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 5

我有一个用于 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 6

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

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

Answer 7

以下对我有用：

SpingBoot 2.1.7.RELEASE

YAML 属性（注意值用单引号括起来）

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

在 Java/Kotlin 中用（注意使用 #）注释字段（对于 java 不需要用 '\' 转义 '$'）

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

Answer 8

您可以使用下面的代码。

下面是 application.yml

的代码

my:
  mapValues:
    dbData: '{
      "connectionURL": "http://tesst:3306",
        "userName": "myUser",
        "password": "password123"
    }'

使用下面的 java 代码使用 @Value 注释访问这些键和值。

@Value("#{${my.mapValues.dbData}}")
private Map<String,String> dbValues;

如何使用@Value Spring注解注入一个Map？

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

java

spring

dependency-injection

annotations

spring-annotations

阅读

使用