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上使用`spring`和`kotlin`标签提问。

要求

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 注解的类,以便可以对其进行代理。

在 Kotlin 中序列化/反序列化 JSON 数据需要Jackson 的 Kotlin 模块。当它在类路径中找到时,它会自动注册。如果 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 为 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 来管理协程依赖项的版本。可以通过设置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。如果需要 Mockito 特定的 @MockBean@SpyBean注解 的 MockK 等效项,可以使用 SpringMockK,它提供了类似的@MockkBean@SpykBean注解。

资源

示例