Kotlin 支持
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
标签提问。
要求
Spring Boot 需要至少 Kotlin 1.7.x,并通过依赖管理来管理合适的 Kotlin 版本。
要使用 Kotlin,必须在类路径上存在 org.jetbrains.kotlin:kotlin-stdlib
和 org.jetbrains.kotlin:kotlin-reflect
。
也可以使用 kotlin-stdlib
变体 kotlin-stdlib-jdk7
和 kotlin-stdlib-jdk8
。
由于 Kotlin 类默认是 final 的,你可能需要配置 kotlin-spring 插件,以便自动打开带有 Spring 注解的类,使它们可以被代理。
Jackson 的 Kotlin 模块 是序列化/反序列化 Kotlin 中 JSON 数据所必需的。 当在类路径上找到它时,它会自动注册。 如果存在 Jackson 和 Kotlin 但缺少 Jackson Kotlin 模块,则会记录警告消息。
如果你在 start.spring.io 上引导一个 Kotlin 项目,这些依赖项和插件会默认提供。 |
空安全
Kotlin 的关键特性之一是 {url-kotlinlang.org}/null-safety.html[空安全]。
它在编译时处理 null
值,而不是将问题推迟到运行时并遇到 NullPointerException
。
这有助于消除常见的错误来源,而无需支付像 Optional
这样的包装器的成本。
Kotlin 还允许使用可空值的函数式构造,如这个 Kotlin 空安全综合指南 中所述。
虽然 Java 不允许在其类型系统中表达空安全,但 Spring Framework、Spring Data 和 Reactor 现在通过工具友好的注解提供其 API 的空安全。 默认情况下,在 Kotlin 中使用的 Java API 的类型被识别为 {url-kotlinlang.org}/java-interop.html#null-safety-and-platform-types[平台类型],对这些类型的空检查是宽松的。 {url-kotlinlang.org}/java-interop.html#jsr-305-support[Kotlin 对 JSR 305 注解的支持] 结合空值注解为 Kotlin 中的相关 Spring API 提供空安全。
JSR 305 检查可以通过添加 -Xjsr305
编译器标志来配置,选项如下:-Xjsr305={strict|warn|ignore}
。
默认行为与 -Xjsr305=warn
相同。
strict
值需要从 Spring API 推断的 Kotlin 类型中考虑空安全,但应该知道 Spring 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 {url-kotlinlang.org}/extensions.html[扩展] 提供了使用附加功能扩展现有类的能力。 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 的互操作性限制,对值类的支持有限。 特别是,依赖值类的默认值将无法与配置属性绑定一起工作。 在这种情况下,应该使用数据类。
要使用注解处理器生成 你自己的元数据,应该使用 spring-boot-configuration-processor 依赖项配置 {url-kotlinlang.org}/kapt.html[kapt ]。
注意,由于 kapt 提供的模型限制,某些功能(如检测默认值或已弃用项)无法工作。
|
测试
虽然可以使用 JUnit 4 测试 Kotlin 代码,但默认提供并推荐使用 JUnit 5。
JUnit 5 允许测试类实例化一次并重用于该类的所有测试。
这使得可以在非静态方法上使用 @BeforeAll
和 @AfterAll
注解,这非常适合 Kotlin。
要模拟 Kotlin 类,推荐使用 MockK。
如果你需要 Mockito 特定的 @MockitoBean
和 @MockitoSpyBean
注解 的 MockK
等效项,你可以使用 SpringMockK,它提供了类似的 @MockkBean
和 @SpykBean
注解。
资源
进一步阅读
-
{url-kotlinlang.org}[Kotlin 语言参考]
-
Kotlin Slack(有专门的 #spring 频道)
示例
-
spring-boot-kotlin-demo:常规 Spring Boot + Spring Data JPA 项目
-
mixit:Spring Boot 2 + WebFlux + 响应式 Spring Data MongoDB
-
spring-kotlin-fullstack:使用 Kotlin2js 代替 JavaScript 或 TypeScript 的 WebFlux Kotlin 全栈示例
-
spring-petclinic-kotlin:Spring PetClinic 示例应用程序的 Kotlin 版本
-
spring-kotlin-deepdive:从 Boot 1.0 + Java 到 Boot 2.0 + Kotlin 的逐步迁移
-
spring-boot-coroutines-demo:协程示例项目