Spring Boot - inyectar mapa desde application.yml

Tengo una aplicación Spring Boot con lo siguiente application.yml, tomado básicamente de aquí :

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

Puedo inyectar valores particulares, p. Ej.

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

Sin embargo, me gustaría inyectar todo el mapa, es decir, algo como esto:

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

¿Es eso (o algo similar) posible? Obviamente, puedo cargar yaml directamente, pero me preguntaba si Spring ya admite algo.

Puede inyectar un mapa usando @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;
        }
    }
}

Ejecutar esto con el yaml en la pregunta produce:

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

Hay varias opciones para establecer un prefijo, controlar cómo se manejan las propiedades que faltan, etc. Consulte el javadoc para obtener más información.

La siguiente solución es una abreviatura de la solución de @Andy Wilkinson, excepto que no tiene que usar una clase separada o un @Beanmétodo anotado.

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

}

Podemos club tanto con @Valueanotaciones como @ConfigurationPropertiessin problemas. Pero los captadores y los setters son importantes y @EnableConfigurationPropertieses imprescindible tener la @ConfigurationPropertiescapacidad para funcionar.

Probé esta idea de la maravillosa solución proporcionada por @Szymon Stepniak, pensé que sería útil para alguien.

Hoy me encuentro con el mismo problema, pero desafortunadamente la solución de Andy no funcionó para mí. En Spring Boot 1.2.1.RELEASE es aún más fácil, pero debes tener en cuenta algunas cosas.

Aquí está la parte interesante de mi 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 contiene solo una entrada de mapa, mi objetivo es proporcionar una configuración dinámica para otros proveedores de OAuth. Quiero inyectar este mapa en un servicio que inicializará los servicios según la configuración proporcionada en este archivo yaml. Mi implementación inicial fue:

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

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

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

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

Después de iniciar la aplicación, el providersmapa OAuth2ProvidersServiceno se inicializó. Probé la solución sugerida por Andy, pero no funcionó tan bien. Yo uso Groovy en esa aplicación, así que decidí eliminar privatey dejar que Groovy genere getter y setter. Entonces mi código se veía así:

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

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

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

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

Después de ese pequeño cambio, todo funcionó.

Aunque hay una cosa que vale la pena mencionar. Después de hacerlo funcionar, decidí crear este campo privatey proporcionar al setter un tipo de argumento directo en el método setter. Desafortunadamente, eso no funcionará. Causa org.springframework.beans.NotWritablePropertyExceptioncon mensaje:

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?

Téngalo en cuenta si está utilizando Groovy en su aplicación Spring Boot.

Para recuperar el mapa de la configuración, necesitará la clase de configuración. La anotación @Value no funcionará, desafortunadamente.

Application.yml

entries:
  map:
     key1: value1
     key2: value2

Clase de configuración:

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

Solución para extraer el mapa usando @Value de la propiedad application.yml codificada como multilínea

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 

Aquí el valor de nuestra propiedad de mapa "my-map-property-name" se almacena en formato JSON dentro de una cadena y hemos obtenido varias líneas usando \ al final de la línea

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

}

Mas explicacion

• \ en yaml se usa para dividir la cadena en varias líneas

• \ " es el carácter de escape para" (cita) en la cadena yaml

• {clave: valor} JSON en yaml que será convertido a mapa por @Value

• # {} es expresión SpEL y se puede usar en @Value para convertir json int Map o Array / list Reference

Probado en un proyecto de arranque de primavera

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

Puede hacerlo aún más simple, si desea evitar estructuras adicionales.

service:
  mappings:
    key1: value1
    key2: value2

@Configuration
@EnableConfigurationProperties
public class ServiceConfigurationProperties {

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

}

Y luego úselo como de costumbre, por ejemplo con un constructor:

public class Foo {

  private final Map<String, String> serviceMappings;

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

}