如何使用@Value Spring注释注入地图?


69

如何在Spring中使用@Value批注将值从属性文件注入Map中?

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

无法自动装配字段:私有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

您将需要使用spring表达式语言。使用列表的类似问题(stackoverflow.com/questions/27390363/…)。我不确定您可以开箱即用地做什么。这个问题stackoverflow.com/questions/28369458/…有点您的意思。使用自定义属性映射器
Laurentiu L.

您到底想在地图上显示什么?看来您还希望对某个类型进行对话Pattern?那是什么样的Pattern课?
K Erlandsson 2015年

@Erlandsson这是一个RegEx模式,我们将在值中定义有效的regex模式字符串
yathirigan

@LaurentuiL uin春季启动,如果地图与课程级别上描述的前缀匹配,我可以直接注入地图,但是,我的问题是课程级别上的前缀,并且此属性级别不同
yathirigan

Answers:


16

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

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

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

像这样变成豆子:

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

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

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

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

关于此功能的很酷的东西是您可以验证属性


是的,但是,我的问题是.. Test类具有自己的@ConfigurationProperties前缀。所以我想单独为此成员变量使用diff前缀。我怎样才能做到这一点 ?
yathirigan 2015年

1
嗯,我错过了。因此,我将使用@ConfiguraitonProperties注释创建单独的两个bean,并将它们自动装配到测试类中。
luboskrnac 2015年

可能对OP有效,但问题未指定启动,并且此问题在没有启动的情况下不适用于一般的Spring。
xenoterracide

4
问题是如何使用@Value注释注入地图,但您是在说各种事情,而不是给出问题的答案。可以选择替代方法,但也请坚持回答
Mukul Anand

143

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

属性文件中的属性。

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

在您的代码中。

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

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


11
如果缺少该属性以防止发生异常,如何设置默认值?
petertc

2
似乎也进行类型转换,例如:@Value("#{${double.map}}") final Map<String, Double> doubleMap
PeterK

4
如何在yml文件中指定相同内容
Mukul Anand

3
@yaml中的@MukulAnand看起来propertyname : > { key1:'value', key2:'value' } 很抱歉,我无法正确设置换行符
joemat

3
从.yaml插入地图时,模式“属性名称:{key1:'value1',key2:'value2',....}”不起作用:java.lang.IllegalArgumentException:无法解析占位符
Andrey M. Stepanov

18

您可以.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;

我们已经使用Spring Cloud Config服务器来提供配置,因此类路径方法可能不起作用。而且我们不使用XML
yathirigan

@Arpit-您能在这里指导我吗:stackoverflow.com/questions/60899860 / ...
Pra_A

7

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

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

7

我有一个简单的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;
}

我认为您对bean mongoConfig的定义不正确。该方法应该这样定义。公共Map <String,String> mongoConfig(){返回新的HashMap(); }
rslj

如果您只是想从application.yml插入地图,这可能是最优雅的方法
Agoston Horvath

6

要使其与YAML一起使用,请执行以下操作:

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

2

以下对我有用:

SpingBoot 2.1.7。发布

YAML属性(单引号引起来的通知值)

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

在Java / Kotlin中,使用(注意使用#)注释字段(对于Java,无需使用'\'转义'$')

@Value("#{\${property.name}}")
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.