Spring Boot如何不通过包装类直接注入@ConfigurationProperties列表？

问题背景 #

我有这样的YAML配置：

topLevel:
  - mapKey1: value1
    mapKey2: value2
  - mapKey1: value3
    mapKey2: value4

目前我是通过定义一个包装类MyRoot来让Spring加载这个列表的：

@ConfigurationProperties
@Component
class MyRoot {var topLevel = mutableListOf<MyElement>()}
class MyElement {var mapKey1 = ""; var mapKey2 = ""}

但我并不关心这个包装类MyRoot，只想直接获取MyElement对象的列表。有没有办法不用定义MyRoot，直接注入这个列表呢？

解决方案 #

当然可以！这里有两种靠谱的方式实现你的需求：

方法1：用@ConfigurationProperties配合@Bean直接绑定列表（推荐）

这种方式完全符合Spring Boot的配置绑定规范，不需要外层包装类，直接把配置中的topLevel列表绑定到List<MyElement>：

首先在配置类中定义一个@Bean方法，指定@ConfigurationProperties的prefix为topLevel：

@Configuration
class ElementConfig {
    @Bean
    @ConfigurationProperties(prefix = "topLevel")
    fun myElementList(): List<MyElement> {
        // 这里返回空列表只是占位，Spring会自动填充配置中的数据
        return mutableListOf()
    }
}

之后在任何需要使用这个列表的地方，直接注入List<MyElement>即可：

@Component
class MyBusinessService(private val elementList: List<MyElement>) {
    // 在这里直接使用elementList处理业务逻辑
}

这种方式的优势是：配置绑定自动完成，无需手动处理属性映射，维护性强，尤其适合元素数量不固定或者配置结构复杂的场景。

方法2：用@Value结合SpEL手动构建列表（适合简单场景）

如果你的列表元素数量固定且配置结构简单，也可以通过@Value配合Spring表达式语言（SpEL）逐个注入属性，然后手动构建MyElement列表：

@Component
class MySimpleService {
    private val elementList = mutableListOf<MyElement>()

    // 注入第一个元素的属性
    @Value("\${topLevel[0].mapKey1}")
    fun setFirstElementKey1(value: String) {
        if (elementList.size < 1) elementList.add(MyElement())
        elementList[0].mapKey1 = value
    }

    @Value("\${topLevel[0].mapKey2}")
    fun setFirstElementKey2(value: String) {
        elementList[0].mapKey2 = value
    }

    // 同理注入第二个元素的属性
    @Value("\${topLevel[1].mapKey1}")
    fun setSecondElementKey1(value: String) {
        if (elementList.size < 2) elementList.add(MyElement())
        elementList[1].mapKey1 = value
    }

    @Value("\${topLevel[1].mapKey2}")
    fun setSecondElementKey2(value: String) {
        elementList[1].mapKey2 = value
    }
}

不过这种方式比较繁琐，一旦配置中的元素数量变化，就需要修改代码，所以只推荐在简单场景下使用。

内容的提问来源于stack exchange，提问作者piotrek