Kotlin 支持
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 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 注解的类,以便它们可以被代理。
在 Kotlin 中序列化/反序列化 JSON 数据需要 Jackson 的 Kotlin 模块。当在类路径中找到它时,它会自动注册。如果 Jackson 和 Kotlin 存在但 Jackson Kotlin 模块不存在,则会记录一条警告消息。
| 如果在 start.spring.io 上启动 Kotlin 项目,默认会提供这些依赖项和插件。 |
空安全
Kotlin 的主要特性之一是空安全。它在编译时处理 null 值,而不是将问题推迟到运行时并遇到 NullPointerException。这有助于消除常见的 bug 源,而无需付出 Optional 等包装器的代价。Kotlin 还允许将函数式构造与可空值一起使用,如 Kotlin 空安全综合指南中所述。
从 Kotlin 2.1 开始,Kotlin 强制严格处理 org.jspecify.annotations 包中的可空性注解。
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 来管理 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 互操作性的限制,对值类的支持是有限的。特别是,依赖值类的默认值将不适用于配置属性绑定。在这种情况下,应改用数据类。
测试
虽然可以使用 JUnit 4 测试 Kotlin 代码,但默认提供并推荐使用 JUnit 6。JUnit 6 允许测试类只实例化一次并重复用于该类的所有测试。这使得在非静态方法上使用 @BeforeAll 和 @AfterAll 注解成为可能,这非常适合 Kotlin。
为了模拟 Kotlin 类,推荐使用 MockK。如果您需要 Mockito 特定的 @MockitoBean 和 @MockitoSpyBean 注解的 MockK 等价物,可以使用 SpringMockK,它提供了类似的 @MockkBean 和 @SpykBean 注解。
资源
示例
-
spring-boot-kotlin-demo:常规 Spring Boot + Spring Data JPA 项目
-
mixit:Spring Boot 2 + WebFlux + 响应式 Spring Data MongoDB
-
spring-kotlin-fullstack:WebFlux Kotlin 全栈示例,前端使用 Kotlin2js 而不是 JavaScript 或 TypeScript
-
spring-petclinic-kotlin:Spring PetClinic 示例应用程序的 Kotlin 版本
-
spring-kotlin-deepdive:从 Boot 1.0 + Java 到 Boot 2.0 + Kotlin 的逐步迁移
-
spring-boot-coroutines-demo:协程示例项目