Spring Boot Yaml-Konfiguration für eine Liste von Zeichenfolgen

Ich versuche, ein Array von Zeichenfolgen aus der Datei application.yml zu laden. Dies ist die Konfiguration:

ignore:
    filenames:
        - .DS_Store
        - .hg

Das ist die Klasse:

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

Es gibt andere Konfigurationen in derselben Klasse, die einwandfrei geladen werden. In meiner Yaml-Datei befinden sich keine Registerkarten. Trotzdem bekomme ich folgende Ausnahme:

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

Meine Vermutung ist, dass die @Value"komplexen" Typen nicht bewältigen können. Sie können mit einer Requisitenklasse wie dieser gehen:

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

Bitte beachten Sie: Dieser Code ist Groovy - nicht Java - um das Beispiel kurz zu halten! In den Kommentaren finden Sie Tipps zur Übernahme.

Siehe das vollständige Beispiel https://github.com/christoph-frick/so-springboot-yaml-string-list

Verwenden Sie in application.yml durch Kommas getrennte Werte

ignoreFilenames: .DS_Store, .hg

Java-Code für den Zugriff

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

Es funktioniert ;)

Aus den Spring Boot-Dokumenten https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html

YAML-Listen werden als Eigenschaftsschlüssel mit [Index] -Deferenzern dargestellt, z. B. diese YAML:

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

Würde in diese Eigenschaften umgewandelt werden:

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

Um mit den Spring DataBinder-Dienstprogrammen an solche Eigenschaften zu binden (was auch immer der @ConfigurationPropertiesFall ist), müssen Sie eine Eigenschaft in der Ziel-Bean des Typs haben java.util.Listund entweder einen Setter bereitstellen oder sie mit einem veränderlichen Wert initialisieren, z. B. wird dies binden zu den Eigenschaften oben. So würde der Code der Frage aussehen.

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

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

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

Zusätzlich zu Ahmets Antwort können Sie der durch Koma getrennten Zeichenfolge mithilfe eines >Symbols Zeilenumbrüche hinzufügen .

application.yml :

ignoreFilenames: >
  .DS_Store, 
  .hg

Java-Code :

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

Ahmets Antwort enthält Informationen zum Zuweisen der durch Kommas getrennten Werte zum String-Array.

Um die obige Konfiguration in verschiedenen Klassen zu verwenden, müssen Sie möglicherweise Getter / Setter dafür erstellen. Wenn Sie diese Konfiguration jedoch einmal laden und diese weiterhin als Bean mit Autowired-Annotation verwenden möchten, habe ich Folgendes erreicht:

In ConfigProvider.java

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

In externen Klassen:

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

Sie können dieselbe Liste überall sonst verwenden, indem Sie automatisch verdrahten.

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

yml-Datei:

your:
 elements: element1, element2, element3

Es gibt noch viel mehr, was Sie mit Spring Spel spielen können.

Nun, das einzige, was ich zum Laufen bringen kann, ist wie folgt:

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

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

Und vergessen Sie nicht die @ Konfiguration über Ihrer Klasse ...

Ohne die "," Trennung kein solches Glück ...

Funktioniert auch (Boot 1.5.8 Versie)

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

In meinem Fall war dies ein Syntaxproblem in der .yml-Datei. Ich hatte:

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

und die Liste in meiner .yml-Datei:

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

hat nicht in das mit @ Value annotierte Feld gelesen. Als ich die Syntax in der .yml-Datei geändert habe in:

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

es hat gut funktioniert.

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

yml-Datei:

your:
 elements: element1, element2, element3