跳到主要内容

Kotlin 支持

DeepSeek V3 中英对照 Kotlin Support

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

Spring Boot 通过在 Spring Framework、Spring Data 和 Reactor 等其他 Spring 项目中的支持提供了 Kotlin 支持。有关更多信息，请参阅 Spring Framework Kotlin 支持文档。

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

需求​

Spring Boot 至少需要 Kotlin 1.7.x，并通过依赖管理来管理合适的 Kotlin 版本。要使用 Kotlin，必须确保 org.jetbrains.kotlin:kotlin-stdlib 和 org.jetbrains.kotlin:kotlin-reflect 存在于类路径中。也可以使用 kotlin-stdlib 的变体 kotlin-stdlib-jdk7 和 kotlin-stdlib-jdk8。

由于 Kotlin 类默认是 final 的，你可能会想要配置 kotlin-spring 插件，以便自动打开带有 Spring 注解的类，使它们能够被代理。

Jackson 的 Kotlin 模块 是在 Kotlin 中序列化/反序列化 JSON 数据所必需的。当在类路径中找到时，它会自动注册。如果 Jackson 和 Kotlin 存在但缺少 Jackson Kotlin 模块，则会记录一条警告信息。

提示

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

空安全​

Kotlin 的一个关键特性是空安全。它在编译时处理 null 值，而不是将问题推迟到运行时并遇到 NullPointerException。这有助于消除常见的错误来源，而无需像 Optional 这样的包装器的开销。Kotlin 还允许在可为空的值上使用函数式构造，如这篇关于 Kotlin 空安全的全面指南所述。

尽管 Java 不允许在其类型系统中表达空安全，Spring Framework、Spring Data 和 Reactor 现在通过工具友好的注解提供了其 API 的空安全性。默认情况下，Kotlin 中使用的 Java API 类型被视为平台类型，对其空检查较为宽松。Kotlin 对 JSR 305 注解的支持与可空性注解相结合，为 Kotlin 中的相关 Spring API 提供了空安全性。

可以通过添加 -Xjsr305 编译器标志来配置 JSR 305 检查，可用的选项为：-Xjsr305={strict|warn|ignore}。默认行为与 -Xjsr305=warn 相同。strict 值用于确保从 Spring API 推断的 Kotlin 类型考虑到空安全性，但使用时需注意 Spring API 的空声明可能会在次要版本之间发生变化，且未来可能会添加更多检查）。

注意

泛型类型参数、可变参数和数组元素的可空性目前尚未支持。有关最新信息，请参阅 SPR-15942。另外请注意，Spring Boot 自身的 API 尚未进行注解。

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)
}
kotlin

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

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

扩展​

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

TestRestTemplate 扩展功能，类似于 Spring Framework 为 RestOperations 提供的功能，已经被实现。这些扩展功能使得开发者能够利用 Kotlin 的具体化类型参数。

依赖管理​

为了避免在类路径上混合不同版本的 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 在与构造函数绑定结合使用时，支持具有不可变 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
    )
}
kotlin

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

提示

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

测试​

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

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

资源​

延伸阅读​

示例​