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ます。問題はありません。しかし、ゲッターとセッターは重要であり@EnableConfigurationProperties、@ConfigurationProperties動作させるために必要です。

@Szymon Stepniakが提供するグルーヴィーなソリューションからこのアイデアを試しましたが、誰かに役立つと思いました。

今日も同じ問題に遭遇しましたが、残念ながらAndyの解決策はうまくいきませんでした。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

providersマップにはマップエントリが1つだけ含まれています。私の目標は、他の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にゲッターとセッターを生成させることにしました。だから私のコードは次のようになりました：

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

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

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

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

その小さな変更の後、すべてが機能しました。

言及する価値があるかもしれないことが1つありますが。それを機能させた後、私はこのフィールドを作成privateし、セッターメソッドにストレート引数タイプをセッターに提供することを決定しました。残念ながらそれはうまくいきません。これは、原因となる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;
 }

マルチラインとしてコード化されたapplication.ymlプロパティ から@Valueを 使用してマップをプルするためのソリューション

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文字列の"（引用） "のエスケープ文字です

• {key：value} @ValueによってMapに変換されるyamlのJSON

• ＃{}これはSpEL式であり、@ Valueでjson intマップまたは配列/リストの参照を変換するために使用できます

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;
  }

}