การกำหนดค่า yaml ของ Spring Boot สำหรับรายการสตริง

ฉันพยายามโหลดอาร์เรย์ของสตริงจากไฟล์ application.yml นี่คือการกำหนดค่า:

ignore:
    filenames:
        - .DS_Store
        - .hg

นี่คือคลาส:

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

มีการกำหนดค่าอื่น ๆ ในคลาสเดียวกันที่โหลดได้ดี ไม่มีแท็บในไฟล์ yaml ของฉัน ฉันยังได้รับข้อยกเว้นต่อไปนี้:

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

ฉันเดาว่าที่@Valueไม่สามารถรับมือกับ "ซับซ้อน" ประเภท คุณสามารถไปกับคลาส prop ได้ดังนี้:

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

หมายเหตุ:รหัสนี้เป็นGroovy - ไม่ Java - เพื่อให้สั้นตัวอย่าง! ดูความคิดเห็นสำหรับเคล็ดลับวิธีการนำไปใช้

ดูตัวอย่างที่สมบูรณ์https://github.com/christoph-frick/so-springboot-yaml-string-list

ใช้ค่าที่คั่นด้วยเครื่องหมายจุลภาคใน application.yml

ignoreFilenames: .DS_Store, .hg

รหัส java สำหรับการเข้าถึง

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

มันใช้งานได้;)

จาก doc boot ฤดูใบไม้ผลิ https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-external-config.html

รายการ YAML จะแสดงเป็นคีย์คุณสมบัติที่มี [ดัชนี] dereferencers เช่น YAML นี้:

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

จะถูกเปลี่ยนเป็นคุณสมบัติเหล่านี้:

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

หากต้องการเชื่อมโยงกับคุณสมบัติเช่นนั้นโดยใช้ยูทิลิตี Spring DataBinder (ซึ่งเป็นสิ่งที่@ConfigurationPropertiesทำ) คุณต้องมีคุณสมบัติในถั่วประเภทเป้าหมายjava.util.Listและคุณต้องจัดเตรียม setter หรือกำหนดค่าเริ่มต้นด้วยค่าที่ไม่แน่นอนเช่นจะเป็นการผูก กับคุณสมบัติข้างต้น นี่คือลักษณะของคำถามของคำถาม

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

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

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

นอกจากคำตอบของ Ahmetคุณสามารถเพิ่มตัวแบ่งบรรทัดในสตริงที่คั่นด้วยอาการโคม่าโดยใช้>สัญลักษณ์

application.yml :

ignoreFilenames: >
  .DS_Store, 
  .hg

รหัส Java :

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

คำตอบของ Ahmetให้วิธีการกำหนดค่าที่คั่นด้วยเครื่องหมายจุลภาคให้กับอาร์เรย์สตริง

หากต้องการใช้การกำหนดค่าข้างต้นในคลาสที่แตกต่างกันคุณอาจต้องสร้าง getters / setters สำหรับสิ่งนี้ .. แต่ถ้าคุณต้องการโหลดการกำหนดค่านี้เพียงครั้งเดียวและใช้สิ่งนี้เป็นถั่วที่มีคำอธิบายประกอบแบบอัตโนมัตินี่คือวิธีที่ฉันทำได้:

ใน ConfigProvider.java

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

ในชั้นเรียนภายนอก:

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

คุณสามารถใช้รายการเดียวกันทุกที่อื่นโดยการลงทะเบียนอัตโนมัติ

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

ไฟล์ yml:

your:
 elements: element1, element2, element3

มีอีกมากมายที่คุณสามารถเล่นกับสปริง spel

มีเพียงสิ่งเดียวที่ฉันสามารถทำให้มันทำงานได้:

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

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

และอย่าลืม @Configuration เหนือชั้นเรียนของคุณ ....

หากไม่มีการแยก "," ก็ไม่มีโชค ...

ทำงานด้วย (บูต 1.5.8 รุ่น)

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

ในกรณีของฉันนี่เป็นปัญหาไวยากรณ์ในไฟล์ .yml ฉันมี:

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

และรายการในไฟล์ .yml ของฉัน:

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

ไม่ได้อ่านในช่อง @ Value-annotated เมื่อฉันเปลี่ยนไวยากรณ์ในไฟล์ .yml เป็น:

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

มันทำงานได้ดี

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

ไฟล์ yml:

your:
 elements: element1, element2, element3