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 的一个关键特性是空安全。它在编译时处理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 的空值声明甚至在小版本之间也可能发生变化,并且将来可能会添加更多检查。
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 的便利性。
提供了类似于 Spring Framework 为 Spring Framework 中的 RestOperations
提供的 TestRestTemplate
扩展。除其他事项外,这些扩展使得利用 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
)
}
要使用注释处理器生成 自己的元数据,kapt 应使用 spring-boot-configuration-processor 依赖项进行配置。请注意,由于 kapt 提供的模型中的限制,某些功能(例如检测默认值或已弃用的项)不起作用。
|
测试
虽然可以使用 JUnit 4 测试 Kotlin 代码,但默认提供了 JUnit 5,并且推荐使用它。JUnit 5 允许对测试类进行一次实例化,并将其用于该类的所有测试。这使得可以在非静态方法上使用 @BeforeAll
和 @AfterAll
注释,这非常适合 Kotlin。
要模拟 Kotlin 类,建议使用 MockK。如果您需要 Mockito 特定的 @MockBean
和 @SpyBean
注释 的 MockK
等效项,则可以使用 SpringMockK,它提供了类似的 @MockkBean
和 @SpykBean
注释。
资源
进一步阅读
-
Kotlin Slack(有一个专门的 #spring 频道)
示例
-
spring-boot-kotlin-demo:常规 Spring Boot + Spring Data JPA 项目
-
mixit:Spring Boot 2 + WebFlux + Reactive 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:协程示例项目