|
此版本仍在开发中,尚未被视为稳定版本。如需最新稳定版本,请使用 Spring Boot 4.0.4! |
Kotlin 支持
Spring Boot 通过利用其他 Spring 项目(例如 Spring 框架、Spring Data 和 Reactor)中的支持,提供了对 Kotlin 的支持。 有关更多信息,请参阅 Spring 框架 Kotlin 支持文档。
开始使用 Spring Boot 和 Kotlin 的最简单方法是遵循 本全面教程。
您可以使用 start.spring.io 创建新的 Kotlin 项目。
如需支持,欢迎加入 Kotlin Slack 的 #spring 频道,或在 Stack Overflow 上使用 spring 和 kotlin 标签提问。
要求
Spring Boot 至少需要 Kotlin 2.2.x,并通过依赖管理来处理合适的 Kotlin 版本。
要使用 Kotlin,org.jetbrains.kotlin:kotlin-stdlib 和 org.jetbrains.kotlin:kotlin-reflect 必须在类路径上。
Kotlin 2.2.x 引入了 用于将注解传播到参数、字段和属性的新默认规则。为了避免相关警告,并使用在即将发布的版本中可能成为 Kotlin 默认行为的功能,建议配置 -Xannotation-default-target=param-property 编译器标志。
由于Kotlin 类默认为 final,您可能需要配置kotlin-spring插件,以便自动开放带有 Spring 注解的类,使其能够被代理。
Jackson 的 Kotlin 模块 是在 Kotlin 中序列化/反序列化 JSON 数据所必需的。 当该模块出现在类路径中时,会自动注册。
| 如果在 start.spring.io 上启动一个 Kotlin 项目,则默认会提供这些依赖项和插件。 |
空值安全性
Kotlin 的关键特性之一是 空安全。
它在编译时处理 null 值,而非将问题推迟到运行时并引发 NullPointerException。
这有助于消除一类常见的 Bug,同时无需承担类似 Optional 这类包装器的开销。
Kotlin 还支持对可空值使用函数式构造,具体说明详见本 Kotlin 空安全综合指南。
从 Kotlin 2.1 开始,Kotlin 对来自 org.jspecify.annotations 包的 nullability 注解实施严格的处理。
Kotlin API
运行应用程序
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 协程 BOM 来管理协程依赖项的版本。
可通过设置 kotlin-coroutines.version 属性来自定义该版本。
org.jetbrains.kotlinx:kotlinx-coroutines-reactor 依赖项在使用 start.spring.io 创建至少包含一个响应式依赖项的 Kotlin 项目时,默认提供。 |
@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 的互操作性存在限制,因此对值类的支持较为有限。 特别是,依赖值类的默认值在配置属性绑定中将无法正常工作。 在这种情况下,应改用数据类。
测试
虽然可以使用 JUnit 4 来测试 Kotlin 代码,但默认提供了 JUnit 6,并且推荐使用。
JUnit 6 允许将测试类实例化一次,并在该类的所有测试中重复使用。
这使得可以在非静态方法上使用 @BeforeAll 和 @AfterAll 注解,这非常适合 Kotlin。
如需模拟 Kotlin 类,建议使用 MockK。
如果您需要与 Mockito 特定的 @MockitoBean 和 @MockitoSpyBean 注解等效的 MockK 注解,可以使用 SpringMockK,它提供了类似的 @MockkBean 和 @SpykBean 注解。
资源
延伸阅读
-
Kotlin Slack(设有专门的 #spring 频道)
示例
-
spring-boot-kotlin-demo:标准的 Spring Boot + Spring Data JPA 项目
-
mixit:Spring Boot 2 + WebFlux + 响应式 Spring Data MongoDB
-
spring-kotlin-fullstack:基于 WebFlux 的 Kotlin 全栈示例,前端使用 Kotlin/JS(而非 JavaScript 或 TypeScript)
-
spring-petclinic-kotlin:Spring PetClinic 示例应用程序的 Kotlin 版本
-
spring-kotlin-deepdive:从 Spring Boot 1.0 + Java 到 Spring Boot 2.0 + Kotlin 的逐步迁移指南
-
spring-boot-coroutines-demo:协程示例项目