跳到主要内容
版本：4.0.2

Kotlin Support

QWen Max 中英对照 Kotlin Support

Kotlin 是一种静态类型语言，面向 JVM（以及其他平台），它允许编写简洁优雅的代码，同时提供与用 Java 编写的现有库的互操作性。

Spring Boot 通过利用其他 Spring 项目（如 Spring Framework、Spring Data 和 Reactor）中的 Kotlin 支持来提供 Kotlin 支持。更多信息请参阅 Spring Framework Kotlin 支持文档。

开始使用 Spring Boot 和 Kotlin 最简单的方法是遵循 这篇全面的教程。你可以通过 start.spring.io 创建新的 Kotlin 项目。如果你需要支持，欢迎加入 Kotlin Slack 的 #spring 频道，或在 Stack Overflow 上使用 spring 和 kotlin 标签提问。

要求​

Spring Boot 至少需要 Kotlin 2.2.x，并通过依赖管理来管理合适的 Kotlin 版本。要使用 Kotlin，org.jetbrains.kotlin:kotlin-stdlib 和 org.jetbrains.kotlin:kotlin-reflect 必须在 classpath 上。

Kotlin 2.2.x 引入了用于将注解传播到参数、字段和属性的新默认规则。为了避免相关的警告，并使用在即将发布的版本中可能成为 Kotlin 默认行为的设置，建议配置 -Xannotation-default-target=param-property 编译器标志。

由于 Kotlin 类默认是 final 的，你很可能需要配置 kotlin-spring 插件，以便自动将带有 Spring 注解的类打开（open），使其能够被代理。

Jackson 的 Kotlin 模块 是在 Kotlin 中序列化 / 反序列化 JSON 数据所必需的。当它在 classpath 中被发现时，会自动注册。

提示

如果在 start.spring.io 上引导一个 Kotlin 项目，这些依赖项和插件会默认提供。

空安全​

Kotlin 的关键特性之一是 null 安全性。它在编译时处理 null 值，而不是将问题推迟到运行时，从而避免遇到 NullPointerException。这有助于消除一个常见的 bug 来源，而无需付出像 Optional 这样的包装类所带来的开销。Kotlin 还允许对可空值使用函数式结构，具体可参见这篇 Kotlin null 安全性全面指南。

尽管 Java 不允许你在其类型系统中表达空安全（null-safety），但大多数 Spring 项目通过 JSpecify 注解提供空安全。

从 Kotlin 2.1 起，Kotlin 对 org.jspecify.annotations 包中的可空性注解实施了严格的处理。

Kotlin API​

runApplication​

Spring Boot 提供了一种惯用的方式，通过 runApplication<MyApplication>(*args) 来运行应用程序，如下例所示：

import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.runApplication

@SpringBootApplication
class MyApplication

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

这是 SpringApplication.run(MyApplication::class.java, *args) 的一个直接替代方案。它还允许对应用程序进行自定义，如下例所示：

runApplication<MyApplication>(*args) {
	setBannerMode(OFF)
}

Extensions​

Kotlin 扩展 提供了为现有类添加额外功能的能力。Spring Boot Kotlin API 利用这些扩展，为现有 API 增加了新的 Kotlin 特有便利功能。

提供了类似于 Spring Framework 为 RestOperations 提供的 TestRestTemplate 扩展。这些扩展使得可以利用 Kotlin 的具体化类型参数（reified type parameters）等特性。

依赖管理​

为了避免在 classpath 中混用不同版本的 Kotlin 依赖，Spring Boot 引入了 Kotlin BOM。

在 Maven 中，可以通过设置 kotlin.version 属性来自定义 Kotlin 版本，并为 kotlin-maven-plugin 提供插件管理。在 Gradle 中，Spring Boot 插件会自动将 kotlin.version 与 Kotlin 插件的版本对齐。

Spring Boot 还通过导入 Kotlin Coroutines BOM 来管理 Coroutines 依赖的版本。可以通过设置 kotlin-coroutines.version 属性来自定义该版本。

提示

如果在 start.spring.io 上引导一个 Kotlin 项目，并且至少包含一个响应式依赖项，则默认会提供 org.jetbrains.kotlinx:kotlinx-coroutines-reactor 依赖。

@ConfigurationProperties​

@ConfigurationProperties 与 构造函数绑定（constructor binding） 结合使用时，支持具有不可变 val 属性的数据类，如下例所示：

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

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

由于值类（value classes）与 Java 的互操作性存在限制，对其的支持是有限的。特别是，在配置属性绑定（configuration property binding）中依赖值类的默认值将无法正常工作。在这种情况下，应改用数据类（data class）。

提示

要使用注解处理器生成 你自己的元数据，应 配置 kapt 并添加 spring-boot-configuration-processor 依赖。请注意，由于 kapt 提供的模型存在一些限制，某些功能（例如检测默认值或已弃用的项）无法正常工作。

测试​

虽然可以使用 JUnit 4 来测试 Kotlin 代码，但默认提供并推荐使用 JUnit 6。JUnit 6 允许测试类仅实例化一次，并在该类的所有测试中复用。这使得可以在非静态方法上使用 @BeforeAll 和 @AfterAll 注解，这与 Kotlin 非常契合。

要模拟 Kotlin 类，推荐使用 MockK。如果你需要与 Mockito 特有的 @MockitoBean 和 @MockitoSpyBean 注解等效的 MockK 功能，可以使用 SpringMockK，它提供了类似的 @MockkBean 和 @SpykBean 注解。

Resources​

延伸阅读​

示例​