Kotlin-spring 编译器插件
kotlin-spring 编译器插件用于为 Spring 配置 Kotlin 项目,通过在编译时自动将带有某些 Spring 注解的类和成员标记为 open。
该插件是围绕 all-open 插件 的预配置包装器,其行为方式相同:当类带有 Spring 注解时,它会将该类及其成员标记为 open。你可以在同一个项目中同时使用 all-open 和 kotlin-spring。
如果你使用 start.spring.io 生成项目模板, 则 kotlin-spring 插件默认启用。
支持的 Spring 注解
当类带有以下任意 Spring 注解时,该插件会将该类及其成员标记为 open:
该插件还支持元注解。使用 @Configuration、 @Controller、 @RestController、 @Service 或 @Repository 注解的类也会变为 open,因为 Spring 用 @Component 对这些注解进行了元注解标记。
应用插件
Gradle
在 build.gradle(.kts) 文件的 plugins {} 块中添加 kotlin-spring 插件:
kotlin
plugins {
kotlin("jvm") version "2.3.21" // 要使用的 Kotlin 版本
kotlin("plugin.spring") version "2.3.21" // Kotlin Spring 插件
}groovy
plugins {
id "org.jetbrains.kotlin.jvm" version "2.3.21"
id "org.jetbrains.kotlin.plugin.spring" version "2.3.21"
}Maven
在 Maven 中,对 kotlin-spring 插件的支持由 kotlin-maven-allopen 插件提供。 请将其添加到你的 pom.xml 文件中:
xml
<properties>
<kotlin.version>2.3.21</kotlin.version>
</properties>
<plugin>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-maven-plugin</artifactId>
<version>${kotlin.version}</version>
<configuration>
<args>
<arg>-Xjsr305=strict</arg>
</args>
<compilerPlugins>
<plugin>spring</plugin>
</compilerPlugins>
</configuration>
<dependencies>
<dependency>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-maven-allopen</artifactId>
<version>${kotlin.version}</version>
</dependency>
</dependencies>
</plugin>使用 kotlin-spring 插件
应用该插件后,编译器在编译时会将带有常见 Spring 注解的类视为 open。 你可以在编写这些类时无需显式添加 open 关键字:
kotlin
import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.RequestMapping
import org.springframework.web.bind.annotation.RestController
@RestController
@RequestMapping("/")
class MessageController {
// 此类及其所有成员均为 open
@GetMapping
fun listMessages() = listOf(
Message("1", "Hello!"),
Message("2", "Bonjour!"),
Message("3", "Privet!"),
)
}后续步骤
- 对于需要无参构造函数的 JPA 实体,请使用
kotlin-jpa插件, 该插件通过@Entity、@Embeddable和@MappedSuperclass等 JPA 注解来配置no-arg插件。 - 参阅 Spring Boot 与 Kotlin 入门教程,创建你的第一个 Spring Boot 应用程序。
