Kotlin 和 Spring Boot @ConfigurationProperties

Question

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

目前我喜欢下面的例子：

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

但它看起来很丑，实际上foo 不是variable，foo 是常量 value 并且应该在启动期间初始化并且不会在未来。

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

使用新的 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 3

更新：从 Spring Boot 2.2.0 开始，您可以使用如下数据类：

@ConstructorBinding
@ConfigurationProperties("example.kotlin")
data class KotlinExampleProperties(
        val name: String,
        val description: String,
        val myService: MyService) {

    data class MyService(
            val apiToken: String,
            val uri: URI
    )
}

如需进一步参考，请参阅official documentation。

---

自 Spring Boot 2.2.0 起已过时，问题已关闭

正如docs 中所述：必须提供“Java Bean”才能使用ConfigurationProperties。这意味着您的属性需要有getter 和setter，因此val暂时不可以。

Getter 和 setter 通常是强制性的，因为绑定是通过标准的 Java Bean 属性描述符进行的，就像在 Spring MVC 中一样。在某些情况下，可以省略 setter [...]

这个问题已经在 Spring Boot 2.2.0 中得到解决，应该很快就会发布： https://github.com/spring-projects/spring-boot/issues/8762

Answer 4

在带有 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")

1. 更新属性类

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 5

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

可以这样使用

Answer 6

application.properties

metro.metro2.url= ######

Metro2Config.kt

@Component
@ConfigurationProperties(prefix = "metro")
data class Metro2PropertyConfiguration(

        val metro2: Metro2 = Metro2()
)

data class Metro2(
    var url: String ?= null
)

build.gradle

Plugins:
id 'org.jetbrains.kotlin.kapt' version '1.2.31'

// kapt dependencies required for IntelliJ auto complete of kotlin config properties class
    kapt "org.springframework.boot:spring-boot-configuration-processor"
    compile "org.springframework.boot:spring-boot-configuration-processor"

Answer 7

@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 8

我就是这样做的：

application.properties

my.prefix.myValue=1

MyProperties.kt

import org.springframework.boot.context.properties.ConfigurationProperties
import org.springframework.stereotype.Component

@Component
@ConfigurationProperties(prefix = "my.prefix")
class MyProperties
{
    private var myValue = 0
    fun getMyValue(): Int {
        return myValue;
    }

    fun setMyValue(value: Int){
        myValue = value
    }
}

MyService.kt

@Component
class MyService(val myProperties: MyProperties) {
    fun doIt() {
        System.console().printf(myProperties.getMyValue().toString())
    }
}

Answer 9

除了已经说过的，请注意val 和@ConstructorBinding 有一些限制。您不能将一个变量别名为另一个变量。假设您在 Kubernetes 中运行并想要捕获主机名，该主机名由环境变量 HOSTNAME 给出。最简单的方法是将@Value("\${HOSTNAME}:)" 应用于属性，但它仅适用于可变属性并且没有构造函数绑定。

见@ConstructorBinding with immutable properties don't work with @Value in Spring Boot Kotlin @ConfigurationProperties。