Kotlin 支持

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 上用 springkotlin 标签提问。

要求

Spring Boot 需要至少 Kotlin 1.7.x 并通过依赖管理来管理合适的 Kotlin 版本。要使用 Kotlin,org.jetbrains.kotlin:kotlin-stdliborg.jetbrains.kotlin:kotlin-reflect 必须存在于类路径中。也可以使用 kotlin-stdlib 的变体 kotlin-stdlib-jdk7kotlin-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)
}

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

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

扩展函数

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

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

要使用注解处理器生成你自己的元数据,应该为 spring-boot-configuration-processor 依赖项配置 kapt。请注意,由于 kapt 模型提供的限制,某些特性(例如检测默认值或弃用项)无法正常工作。

测试

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

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

资源

示例