4.28 Kotlin支持

优质

小牛编辑

139浏览

2023-12-01

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

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

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

4.28.1 Requirements

Spring Boot支持Kotlin 1.2.x. 要使用Kotlin，org.jetbrains.kotlin:kotlin-stdlib和org.jetbrains.kotlin:kotlin-reflect必须存在于类路径中。也可以使用kotlin-stdlib变体kotlin-stdlib-jdk7和kotlin-stdlib-jdk8。

由于Kotlin类默认为final，因此您可能需要配置kotlin-spring插件以自动打开Spring-annotated类，以便可以代理它们。

在Kotlin中序列化/反序列化JSON数据需要Jackson的Kotlin模块。在类路径中找到它时会自动注册。如果Jackson和Kotlin存在但Jackson Kotlin模块不存在，则会记录警告消息。

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

4.28.2 Null-safety

Kotlin的一个关键特性是null安全。它在编译时处理空值，而不是将问题推迟到运行时并遇到NullPointerException。这有助于消除常见的错误来源，而无需支付像Optional这样的包装器的成本。 Kotlin还允许使用具有可空值的功能构造，如本Kotlin中关于null安全性的综合指南中所述。

虽然Java不允许在其类型系统中表示null安全性，但Spring Framework，Spring Data和Reactor现在通过易于使用工具的注释提供其API的安全性。默认情况下，Kotlin中使用的Java API类型被识别为放宽空检查的平台类型。 Kotlin对JSR 305注释的支持与可空性注释相结合，为Kotlin中的相关Spring API提供了空安全性。

可以通过使用以下选项添加-Xjsr305编译器标志来配置JSR 305检查：-Xjsr305 = {strict | warn | ignore}。默认行为与-Xjsr305 = warn相同。在从Spring API推断出的Kotlin类型中需要考虑null安全性的严格值，但是应该使用Spring API可空性声明甚至可以在次要版本之间发展并且将来可能添加更多检查的知识。

尚不支持泛型类型参数，varargs和数组元素可空性。有关最新信息，请参见SPR-15942。另请注意，Spring Boot自己的API尚未注释。

4.28.3 Kotlin API

4.28.3.1 运行应用程序

Spring Boot提供了一种使用runApplication(*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)
}

4.28.3.2 扩展

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

提供了类似于Spring Framework中的Spring Framework for RestOperations提供的TestRestTemplate扩展。除此之外，扩展使得可以利用Kotlin reified类型参数。

4.28.4 依赖管理

为了避免在类路径上混合不同版本的Kotlin依赖项，提供了以下Kotlin依赖项的依赖项管理：

kotlin-reflect
kotlin-runtime
kotlin-stdlib
kotlin-stdlib-jdk7
kotlin-stdlib-jdk8
kotlin-stdlib-jre7
kotlin-stdlib-jre8

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

4.28.5 @ConfigurationProperties

@ConfigurationProperties目前仅适用于lateinit或nullable var属性（建议使用前者），因为尚不支持由构造函数初始化的不可变类。

@ConfigurationProperties("example.kotlin")
class KotlinExampleProperties {

	lateinit var name: String

	lateinit var description: String

	val myService = MyService()

	class MyService {

		lateinit var apiToken: String

		lateinit var uri: URI

	}

}

要使用注释处理器生成您自己的元数据，应使用spring-boot-configuration-processordependency配置kapt。

4.28.6 测试

虽然可以使用JUnit 4（spring-boot-starter-test提供的默认值）来测试Kotlin代码，但建议使用JUnit 5。 JUnit 5允许测试类实例化一次，并重用于所有类的测试。这使得可以在非静态方法上使用@BeforeAll和@AfterAll注释，这非常适合Kotlin。

要使用JUnit 5，请从spring-boot-starter-test中排除junit：junit依赖项，添加JUnit 5依赖项，并相应地配置Maven或Gradle插件。有关更多详细信息，请参阅JUnit 5文档。您还需要将测试实例生命周期切换为“per-class”。

为了模拟Kotlin类，建议使用Mockk。如果需要Mockk等效的Mockito特定的@MockBean和@SpyBean注释，则可以使用SpringMockK，它提供类似的@MockkBean和@SpykBean注释。

4.28.7 资源

4.28.7.1 进一步阅读

Kotlin语言参考
Kotlin Slack（带有专用的#spring频道）
Stackoverflow与spring和kotlin标签
在浏览器中试用Kotlin
Kotlin博客
很棒的Kotlin
教程：使用Spring Boot和Kotlin构建Web应用程序
使用Kotlin开发Spring Boot应用程序
带有Kotlin，Spring Boot和PostgreSQL的地理空间信使
在Spring Framework 5.0中引入Kotlin支持
Spring Framework 5 Kotlin API，函数式

4.28.7.2 示例

spring-boot-kotlin-demo：常规Spring Boot + Spring Data JPA项目
mixit：Spring Boot 2 + WebFlux + Reactive Spring Data MongoDB
spring-kotlin-fullstack：WebFlux Kotlin fullstack示例，其中Kotlin2js用于前端而不是JavaScript或TypeScript
spring-petclinic-kotlin：Spring PetClinic简单应用的Kotlin版本
spring-kotlin-deepdive：将Boot 1.0 + Java逐步迁移到Boot 2.0 + Kotlin