Kotlin和Spring Boot @ConfigurationProperties

Question

如何使用Kotlin在Spring Boot中正确初始化ConfigurationProperties ？

目前我喜欢以下示例:

 @ConfigurationProperties("app")
 class Config {
     var foo: String? = null
 }

但它看起来很丑陋,实际上foo并不是一个var可行的,foo是不变的 val,应该在启动时初始化,并且将来不会改变.

Answer 1

以下是我使用application.yml文件的方法.

myconfig:
  my-host: ssl://example.com
  my-port: 23894
  my-user: user
  my-pass: pass

这是kotlin文件:

@Configuration
@ConfigurationProperties(prefix = "myconfig")
class MqttProperties {
    lateinit var myHost: String
    lateinit var myPort: String
    lateinit var myUser: String
    lateinit var myPass: String    
}

这对我很有用.

Answer 2

在带有 Kotlin 1.4.3 的 Spring Boot 2.4.3 上，下一个方法不再有效（可能是因为错误）：

import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.context.properties.EnableConfigurationProperties

@SpringBootApplication
@EnableConfigurationProperties(TestProperties::class)
class Application

fun main(args: Array<String>) {
    runApplication<Application>(*args)
}

import org.springframework.boot.context.properties.ConfigurationProperties
import org.springframework.boot.context.properties.ConstructorBinding

@ConfigurationProperties(prefix = "test")
@ConstructorBinding
data class TestProperties(
    val value: String
)

上面的代码在暗示接下来两种方法之一后开始工作：

1. 添加依赖项

implementation("org.jetbrains.kotlin:kotlin-reflect")

2. 更新属性类

import org.springframework.boot.context.properties.ConfigurationProperties
import org.springframework.boot.context.properties.ConstructorBinding

@ConfigurationProperties(prefix = "test")
data class TestProperties @ConstructorBinding constructor(
    val value: String
)

问题发生在 org/springframework/boot/context/properties/ConfigurationPropertiesBindConstructorProvider.java#68 行

Answer 3

正如文档中所述:必须提供" Java Bean "才能使用ConfigurationProperties.这意味着您的属性需要具有getter和setter,因此val目前无法实现.

getter和setter通常是必需的,因为绑定是通过标准的Java Beans属性描述符,就像在Spring MVC中一样.有些情况下可能会省略一个二传手[...]

虽然有一个与Kotlin相关的开放性问题:https://github.com/spring-projects/spring-boot/issues/8762

Answer 4

使用新的Spring Boot 2.2，您可以这样：

@ConstructorBinding
@ConfigurationProperties(prefix = "swagger")
data class SwaggerProp(
    val title: String, val description: String, val version: String
)

并且不要忘记在依赖项中包含此内容build.gradle.kts：

dependencies {
  annotationProcessor("org.springframework.boot:spring-boot-configuration-processor")
}

Answer 5

@ConstructorBinding
@ConfigurationProperties(prefix = "your.prefix")
data class AppProperties (
    val invoiceBaseDir: String,
    val invoiceOutputFolderPdf: String,
    val staticFileFolder: String
)

不要忘记添加@ConfigurationPropertiesScan

@ConfigurationPropertiesScan
class Application

fun main(args: Array<String>) {
    runApplication<Application>(*args)
}

最后是 application.properties 文件：

your.prefix.invoiceBaseDir=D:/brot-files
your.prefix.invoiceOutputFolderPdf=invoices-pdf
your.prefix.staticFileFolder=static-resources

Answer 6

@Value("\${some.property.key:}")
lateinit var foo:String

可以这样用

Answer 7

从Spring Boot 3.0开始，如果您有一个构造函数，则不再需要使用@ConstructorBinding注释。

 @ConfigurationProperties("app")
 data class Config(
     val foo: String = "default foo"
 )

更多信息在这里