此版本仍在开发中,尚未被视为稳定版本。如需最新稳定版本,请使用 Spring Boot 4.0.4!spring-doc.cadn.net.cn

Kotlin 支持

Kotlin 是一种面向 JVM(及其他平台)的静态类型语言,它支持编写简洁优雅的代码,同时提供与现有 Java 编写的库的互操作性spring-doc.cadn.net.cn

Spring Boot 通过利用其他 Spring 项目(例如 Spring 框架、Spring Data 和 Reactor)中的支持,提供了对 Kotlin 的支持。 有关更多信息,请参阅 Spring 框架 Kotlin 支持文档spring-doc.cadn.net.cn

开始使用 Spring Boot 和 Kotlin 的最简单方法是遵循 本全面教程。 您可以使用 start.spring.io 创建新的 Kotlin 项目。 如需支持,欢迎加入 Kotlin Slack 的 #spring 频道,或在 Stack Overflow 上使用 springkotlin 标签提问。spring-doc.cadn.net.cn

要求

Spring Boot 至少需要 Kotlin 1.7.x 版本,并通过依赖管理自动维护合适的 Kotlin 版本。 要使用 Kotlin,类路径中必须包含 org.jetbrains.kotlin:kotlin-stdliborg.jetbrains.kotlin:kotlin-reflectkotlin-stdlib 的变体 kotlin-stdlib-jdk7kotlin-stdlib-jdk8 也可使用。spring-doc.cadn.net.cn

由于Kotlin 类默认为 final,您可能需要配置kotlin-spring插件,以便自动开放带有 Spring 注解的类,使其能够被代理。spring-doc.cadn.net.cn

Jackson 的 Kotlin 模块 是在 Kotlin 中序列化/反序列化 JSON 数据所必需的。 当该模块出现在类路径中时,会自动注册。spring-doc.cadn.net.cn

如果在 start.spring.io 上启动一个 Kotlin 项目,则默认会提供这些依赖项和插件。

空值安全性

Kotlin 的关键特性之一是 空安全。 它在编译时处理 null 值,而非将问题推迟到运行时并引发 NullPointerException。 这有助于消除一类常见的 Bug,同时无需承担类似 Optional 这类包装器的开销。 Kotlin 还支持对可空值使用函数式构造,具体说明详见本 Kotlin 空安全综合指南spring-doc.cadn.net.cn

尽管 Java 无法在其类型系统中表达空安全性,但 Spring 框架、Spring Data 和 Reactor 现已通过工具友好的注解为其 API 提供了空安全性支持。 默认情况下,Kotlin 中使用的 Java API 类型被识别为 平台类型,针对这些类型,空值检查会被放宽。 Kotlin 对 JSR 305 注解的支持 结合可空性注解,可为 Kotlin 中相关的 Spring API 提供空安全性。spring-doc.cadn.net.cn

JSR 305 检查可通过添加 -Xjsr305 编译器标志并配合以下选项进行配置:-Xjsr305={strict|warn|ignore}。 默认行为与 -Xjsr305=warn 相同。 若需在 Kotlin 类型(由 Spring API 推断得出)中启用空安全性检查,则必须使用 strict 值;但请注意,Spring API 的可空性声明可能在小版本更新之间发生变化,未来还可能增加更多检查。spring-doc.cadn.net.cn

泛型类型参数、可变参数(varargs)以及数组元素的空值性(nullability)尚不支持。 有关最新信息,请参阅 SPR-15942。 此外请注意,Spring Boot 自身的 API 尚未添加空值性注解

Kotlin API

运行应用程序

Spring Boot 提供了一种符合惯例的方式来运行应用程序,如以下示例中所示,退出码为 runApplication<MyApplication>(*args)spring-doc.cadn.net.cn

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) 的即插即用替代方案。 它还支持对应用程序进行自定义,如下例所示:spring-doc.cadn.net.cn

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

扩展

Kotlin 扩展 功能可为现有类添加额外的功能。 Spring Boot Kotlin API 利用这些扩展功能,为现有 API 添加了专用于 Kotlin 的新便利特性。spring-doc.cadn.net.cn

TestRestTemplate 个扩展,类似于 Spring Framework 为 RestOperations 提供的扩展。 这些扩展还支持利用 Kotlin 的实化类型参数等功能。spring-doc.cadn.net.cn

依赖管理

为避免类路径中混入不同版本的 Kotlin 依赖项,Spring Boot 导入了 Kotlin 的 BOM。spring-doc.cadn.net.cn

使用 Maven 时,可通过设置 kotlin.version 属性来自定义 Kotlin 版本,并为 kotlin-maven-plugin 提供插件管理。 使用 Gradle 时,Spring Boot 插件会自动将 kotlin.version 与 Kotlin 插件的版本保持一致。spring-doc.cadn.net.cn

Spring Boot 还通过导入 Kotlin 协程 BOM 来管理协程依赖项的版本。 可通过设置 kotlin-coroutines.version 属性来自定义该版本。spring-doc.cadn.net.cn

org.jetbrains.kotlinx:kotlinx-coroutines-reactor 依赖项在使用 start.spring.io 创建至少包含一个响应式依赖项的 Kotlin 项目时,默认提供。

@ConfigurationProperties(配置属性)

@ConfigurationProperties构造函数绑定 结合使用时,支持具有不可变 val 属性的数据类,如下例所示:spring-doc.cadn.net.cn

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

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

由于值类与 Java 的互操作性存在限制,因此对值类的支持较为有限。 特别是,依赖值类的默认值在配置属性绑定中将无法正常工作。 在这种情况下,应改用数据类。spring-doc.cadn.net.cn

要使用注解处理器生成您自己的元数据,需将kapt 配置为包含 spring-boot-configuration-processor 依赖项。 请注意,由于 kapt 提供的模型存在限制,部分功能(例如检测默认值或已弃用的项)尚无法正常工作。

测试

虽然可以使用 JUnit 4 来测试 Kotlin 代码,但默认提供并推荐使用 JUnit 5。 JUnit 5 允许对测试类仅实例化一次,并在该类的所有测试中重复使用。 这使得可以在非静态方法上使用 @BeforeAll@AfterAll 注解,这非常契合 Kotlin 的特性。spring-doc.cadn.net.cn

如需模拟 Kotlin 类,建议使用 MockK。 如果您需要与 Mockito 特定的 @MockitoBean@MockitoSpyBean 注解等效的 MockK 注解,可以使用 SpringMockK,它提供了类似的 @MockkBean@SpykBean 注解。spring-doc.cadn.net.cn