配置属性从YML加载列表

Question

我正在尝试从YML加载配置。如果这些是逗号分隔的值，我可以加载值，也可以加载列表。但我无法加载典型的YML列表。

配置类

@Component
@PropertySource("classpath:routing.yml")
@ConfigurationProperties
class RoutingProperties(){
    var angular = listOf("nothing")
    var value: String = ""
}

工作路线。yml

angular: /init, /home
value: Hello World

不工作。yml

angular:
    - init
    - home

value: Hello World

为什么我不能加载yml的第二个版本/我有一个语法错误？

环境：科特林，Spring2.0.0。M3

Answer 1

根据文件，你的YAML文件将被改写成一个属性文件。第一个YAML文件变成：

angular=/init, /home
value=Hello World

而第二个变成：

angular[0]=init
angular[1]=home
value=Hello World

这显然是两件截然不同的事情，因此表现不同。

此外，在文档的后面部分，YAML甚至不与@PropertySource一起工作：

YAML文件不能通过注释加载。因此，如果您需要以这种方式加载值，您需要使用属性文件。

这让我有点想知道为什么第一个案例对你有效。

文档中提到了生成的…[index]属性：

要使用SpringDataBinder实用程序（这就是@ConfigurationProperties所做的）绑定到这样的属性，您需要在目标bean中有一个java类型的属性。util。列出（或设置），您需要提供一个setter，或使用一个可变值初始化它，例如，这将绑定到上述属性

让我们来看一下Kotlin文档：listOf返回给定元素的新只读列表。因此，该列表不能按照文档的要求进行更改，我认为这就是它不起作用的原因。尝试使用可变列表（因为我从来没有使用过Kotlin，所以我不能给你工作代码）。还可以尝试将其声明为java。util。列出，如果这在科特林是可能的。

Answer 2

有点老了，我知道。但我现在正处在同一个话题上。

到目前为止，PropertySource似乎确实可以处理yaml文件。考虑到它只允许基元类型（看起来是这样），并且不能处理嵌套元素的限制。我可能会更深入地挖掘并相应地更新我的答案，但到目前为止，被接受的答案似乎是一个有效的解决办法。

Answer 3

正如@flyx所说，@PropetySource不适用于yaml文件。但是在Spring，你可以覆盖几乎所有的东西：）

属性源代码有额外的参数：工厂。可以在Default属性源代码工厂的基础上创建自己的属性源代码工厂

open class YamlPropertyLoaderFactory : DefaultPropertySourceFactory() {
    override fun createPropertySource(name: String?, resource: EncodedResource?): org.springframework.core.env.PropertySource<*> {
        if (resource == null)
            return super.createPropertySource(name, resource)

        return YamlPropertySourceLoader().load(resource.resource.filename, resource.resource, null)
    }
}

在propertysource注释中使用此工厂时：

@PropertySource("classpath:/routing.yml", factory = YamlPropertyLoaderFactory::class)

最后需要使用mutableList初始化变量angular

完整代码示例：

@Component
@PropertySource("classpath:/routing.yml", factory = YamlPropertyLoaderFactory::class)
@ConfigurationProperties
open class RoutingProperties {
    var angular = mutableListOf("nothing")
    var value: String = ""


    override fun toString(): String {
        return "RoutingProperties(angular=$angular, value='$value')"
    }
}

open class YamlPropertyLoaderFactory : DefaultPropertySourceFactory() {
    override fun createPropertySource(name: String?, resource: EncodedResource?): org.springframework.core.env.PropertySource<*> {
        if (resource == null)
            return super.createPropertySource(name, resource)

        return YamlPropertySourceLoader().load(resource.resource.filename, resource.resource, null)
    }
}

@SpringBootApplication
@EnableAutoConfiguration(exclude = arrayOf(DataSourceAutoConfiguration::class))
open class Application {
    companion object {
        @JvmStatic
        fun main(args: Array<String>) {
            val context = SpringApplication.run(Application::class.java, *args)

            val bean = context.getBean(RoutingProperties::class.java)

            println(bean)
        }
    }
}