Configuration yaml de Spring Boot pour une liste de chaînes

J'essaie de charger un tableau de chaînes à partir du fichier application.yml. Voici la configuration:

ignore:
    filenames:
        - .DS_Store
        - .hg

Voici la classe:

@Value("${ignore.filenames}")
private List<String> igonoredFileNames = new ArrayList<>();

Il existe d'autres configurations de la même classe qui se chargent très bien. Il n'y a pas d'onglets dans mon fichier yaml. J'obtiens toujours l'exception suivante:

Caused by: java.lang.IllegalArgumentException: Could not resolve placeholder 'ignore.filenames' in string value "${ignore.filenames}"

Je suppose que le @Valuene peut pas faire face aux types "complexes". Vous pouvez utiliser une classe d'accessoires comme celle-ci:

@Component
@ConfigurationProperties('ignore')
class IgnoreSettings {
    List<String> filenames
}

Veuillez noter: ce code est Groovy - pas Java - pour garder l'exemple court! Voir les commentaires pour savoir comment adopter.

Voir l'exemple complet https://github.com/christoph-frick/so-springboot-yaml-string-list

utiliser des valeurs séparées par des virgules dans application.yml

ignoreFilenames: .DS_Store, .hg

code java pour l'accès

@Value("${ignoreFilenames}")    
String[] ignoreFilenames

Ça fonctionne ;)

À partir de la documentation de démarrage du printemps https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html

Les listes YAML sont représentées comme des clés de propriété avec des déréférenceurs [index], par exemple ce YAML:

my:
   servers:
       - dev.bar.com
       - foo.bar.com

Serait transformé en ces propriétés:

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

Pour lier à des propriétés comme celle en utilisant les utilitaires Spring DataBinder (ce qui est ce qui @ConfigurationPropertiesfait), vous devez avoir une propriété dans le bean cible de type java.util.Listet vous devez soit fournir un setter, soit l'initialiser avec une valeur mutable, par exemple, cela liera aux propriétés ci-dessus. Voici à quoi ressemblerait le code de la question.

@ConfigurationProperties(prefix="ignore")
public class Filenames {

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

    public List<String> getFilenames() {
        return this.ignoredFilenames;
    }
}

En plus de la réponse d' Ahmet, vous pouvez ajouter des sauts de ligne à la chaîne séparée par des virgules à l'aide du >symbole.

application.yml :

ignoreFilenames: >
  .DS_Store, 
  .hg

Code Java :

@Value("${ignoreFilenames}")    
String[] ignoreFilenames;

La réponse d'Ahmet explique comment attribuer les valeurs séparées par des virgules au tableau String.

Pour utiliser la configuration ci-dessus dans différentes classes, vous devrez peut-être créer des getters / setters pour cela. Mais si vous souhaitez charger cette configuration une fois et continuer à l'utiliser comme un bean avec l'annotation Autowired, voici comment j'ai accompli:

Dans ConfigProvider.java

@Bean (name = "ignoreFileNames")
@ConfigurationProperties ( prefix = "ignore.filenames" )
public List<String> ignoreFileNames(){
    return new ArrayList<String>();
}

Dans les cours extérieurs:

@Autowired
@Qualifier("ignoreFileNames")
private List<String> ignoreFileNames;

vous pouvez utiliser la même liste partout ailleurs en autowiring.

@Value("#{'${your.elements}'.split(',')}")  
private Set<String> stringSet;

fichier yml:

your:
 elements: element1, element2, element3

Vous pouvez jouer beaucoup plus avec Spring SpEL.

Eh bien, la seule chose que je peux faire fonctionner est comme ça:

servers: >
    dev.example.com,
    another.example.com

@Value("${servers}")
private String[] array;

Et n'oubliez pas la @Configuration au-dessus de votre classe ....

Sans la séparation ",", pas de chance ...

Fonctionne aussi (boot 1.5.8 versie)

servers: 
       dev.example.com,
       another.example.com

Dans mon cas, il s'agissait d'un problème de syntaxe dans le fichier .yml. J'ai eu:

@Value("${spring.kafka.bootstrap-servers}")
public List<String> BOOTSTRAP_SERVERS_LIST;

et la liste dans mon fichier .yml:

bootstrap-servers:
  - s1.company.com:9092
  - s2.company.com:9092
  - s3.company.com:9092

n'a pas lu dans le champ annoté @ Value. Lorsque j'ai changé la syntaxe du fichier .yml en:

bootstrap-servers >
  s1.company.com:9092
  s2.company.com:9092
  s3.company.com:9092

cela a bien fonctionné.

@Value("${your.elements}")    
private String[] elements;

fichier yml:

your:
 elements: element1, element2, element3