Spring Boot-从application.yml注入映射

我有一个带有以下内容的Spring Boot应用程序application.yml-基本上是从这里获取的：

info:
   build:
      artifact: ${project.artifactId}
      name: ${project.name}
      description: ${project.description}
      version: ${project.version}

我可以注入特定的值，例如

@Value("${info.build.artifact}") String value

但是，我想注入整个地图，例如：

@Value("${info}") Map<String, Object> info

那（或类似的东西）可能吗？显然，我可以直接加载yaml，但是想知道Spring是否已经支持了某些东西。

您可以使用插入地图@ConfigurationProperties：

import java.util.HashMap;
import java.util.Map;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableAutoConfiguration
@EnableConfigurationProperties
public class MapBindingSample {

    public static void main(String[] args) throws Exception {
        System.out.println(SpringApplication.run(MapBindingSample.class, args)
                .getBean(Test.class).getInfo());
    }

    @Bean
    @ConfigurationProperties
    public Test test() {
        return new Test();
    }

    public static class Test {

        private Map<String, Object> info = new HashMap<String, Object>();

        public Map<String, Object> getInfo() {
            return this.info;
        }
    }
}

使用问题中的yaml运行它会产生：

{build={artifact=${project.artifactId}, version=${project.version}, name=${project.name}, description=${project.description}}}

有多种选项可用于设置前缀，控制如何处理缺少的属性等。有关更多信息，请参见javadoc。

下面的解决方案是@Andy Wilkinson解决方案的简写，除了它不必使用单独的类或在带@Bean注释的方法上。

application.yml：

input:
  name: raja
  age: 12
  somedata:
    abcd: 1 
    bcbd: 2
    cdbd: 3

SomeComponent.java：

@Component
@EnableConfigurationProperties
@ConfigurationProperties(prefix = "input")
class SomeComponent {

    @Value("${input.name}")
    private String name;

    @Value("${input.age}")
    private Integer age;

    private HashMap<String, Integer> somedata;

    public HashMap<String, Integer> getSomedata() {
        return somedata;
    }

    public void setSomedata(HashMap<String, Integer> somedata) {
        this.somedata = somedata;
    }

}

我们可以同时@Value注释和@ConfigurationProperties，没有问题。但是，getter和setter很重要，@EnableConfigurationProperties必须使它们@ConfigurationProperties起作用。

我从@Szymon Stepniak提供的常规解决方案中尝试了此想法，认为这对某人有用。

我今天遇到了同样的问题，但是不幸的是，安迪的解决方案对我没有用。在Spring Boot 1.2.1.RELEASE中，它甚至更容易，但是您必须了解一些事情。

这是我的有趣部分application.yml：

oauth:
  providers:
    google:
     api: org.scribe.builder.api.Google2Api
     key: api_key
     secret: api_secret
     callback: http://callback.your.host/oauth/google

providersmap仅包含一个map条目，我的目标是为其他OAuth提供程序提供动态配置。我想将此地图注入到服务中，该服务将基于此yaml文件中提供的配置来初始化服务。我最初的实现是：

@Service
@ConfigurationProperties(prefix = 'oauth')
class OAuth2ProvidersService implements InitializingBean {

    private Map<String, Map<String, String>> providers = [:]

    @Override
    void afterPropertiesSet() throws Exception {
       initialize()
    }

    private void initialize() {
       //....
    }
}

启动该应用程序后，未初始化providers映射OAuth2ProvidersService。我尝试了安迪建议的解决方案，但效果不佳。我在该应用程序中使用了Groovy，所以我决定删除private并让Groovy生成getter和setter。所以我的代码看起来像这样：

@Service
@ConfigurationProperties(prefix = 'oauth')
class OAuth2ProvidersService implements InitializingBean {

    Map<String, Map<String, String>> providers = [:]

    @Override
    void afterPropertiesSet() throws Exception {
       initialize()
    }

    private void initialize() {
       //....
    }
}

经过那小小的改变，一切都奏效了。

尽管有一件事可能值得一提。在使其工作之后，我决定创建此字段，private并在setter方法中为setter提供直接参数类型。不幸的是，它不会起作用。它导致以下org.springframework.beans.NotWritablePropertyException消息：

Invalid property 'providers[google]' of bean class [com.zinvoice.user.service.OAuth2ProvidersService]: Cannot access indexed value in property referenced in indexed property path 'providers[google]'; nested exception is org.springframework.beans.NotReadablePropertyException: Invalid property 'providers[google]' of bean class [com.zinvoice.user.service.OAuth2ProvidersService]: Bean property 'providers[google]' is not readable or has an invalid getter method: Does the return type of the getter match the parameter type of the setter?

如果在Spring Boot应用程序中使用Groovy，请记住这一点。

要从配置中检索地图，您将需要配置类。不幸的是，@ Value注释无法解决问题。

Application.yml

entries:
  map:
     key1: value1
     key2: value2

配置类：

@Configuration
@ConfigurationProperties("entries")
@Getter
@Setter
 public static class MyConfig {
     private Map<String, String> map;
 }

使用@Value 从 编码为多行的application.yml属性中提取Map的解决方案

application.yml

other-prop: just for demo 

my-map-property-name: "{\
         key1: \"ANY String Value here\", \  
         key2: \"any number of items\" , \ 
         key3: \"Note the Last item does not have comma\" \
         }"

other-prop2: just for demo 2 

这里，地图属性“ my-map-property-name”的值以JSON格式存储在字符串中， 并且在行尾使用\来实现多行

myJavaClass.java

import org.springframework.beans.factory.annotation.Value;

public class myJavaClass {

@Value("#{${my-map-property-name}}") 
private Map<String,String> myMap;

public void someRandomMethod (){
    if(myMap.containsKey("key1")) {
            //todo...
    } }

}

更多说明

• \在yaml中用于将字符串分成多行

• \“是yaml字符串中”（quote）的转义字符

• {key：value} yaml中的JSON，它将通过@Value转换为Map

• ＃{}是SpEL表达式，可以在@Value中用于转换json int Map或Array / list 参考

在Spring Boot项目中测试

foo.bars.one.counter=1
foo.bars.one.active=false
foo.bars[two].id=IdOfBarWithKeyTwo

public class Foo {

  private Map<String, Bar> bars = new HashMap<>();

  public Map<String, Bar> getBars() { .... }
}

https://github.com/spring-projects/spring-boot/wiki/Spring-Boot-Configuration-Binding

如果要避免额外的结构，可以使其更简单。

service:
  mappings:
    key1: value1
    key2: value2

@Configuration
@EnableConfigurationProperties
public class ServiceConfigurationProperties {

  @Bean
  @ConfigurationProperties(prefix = "service.mappings")
  public Map<String, String> serviceMappings() {
    return new HashMap<>();
  }

}

然后像往常一样使用它，例如，使用构造函数：

public class Foo {

  private final Map<String, String> serviceMappings;

  public Foo(Map<String, String> serviceMappings) {
    this.serviceMappings = serviceMappings;
  }

}