Kotlin-springコンパイラプラグイン
kotlin-springコンパイラプラグインは、コンパイル時に特定のSpringアノテーションが付与されたクラスやメンバーを自動的にopenにすることで、KotlinプロジェクトをSpring向けに設定します。
このプラグインは、all-openプラグインの事前設定済みラッパーであり、同様に動作します。 Springアノテーションが付与されている場合、クラスとそのメンバーをopenにします。 同一プロジェクト内でall-openとkotlin-springの両方を使用することもできます。
start.spring.ioを使用してプロジェクトテンプレートを生成した場合、 kotlin-springプラグインはデフォルトで有効になっています。
サポートされているSpringアノテーション
このプラグインは、クラスに以下のいずれかのSpringアノテーションが付与されている場合に、そのクラスとメンバーをopenにします。
このプラグインはメタアノテーションもサポートしています。Springがこれらのアノテーションに@Componentをメタアノテーションとして付与しているため、@Configuration、 @Controller、 @RestController、 @Service、または @Repositoryが付与されたクラスもopenになります。
プラグインの適用
Gradle
build.gradle(.kts)ファイルのplugins {}ブロックにkotlin-springプラグインを追加します:
plugins {
kotlin("jvm") version "2.3.21" // 使用するKotlinのバージョン
kotlin("plugin.spring") version "2.3.21" // Kotlin Springプラグイン
}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ファイルに追加します:
<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キーワードを追加することなく記述できます:
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!"),
)
}次のステップ
- 引数なしのコンストラクタ(zero-argument constructor)を必要とするJPAエンティティには、
kotlin-jpaプラグインを使用してください。これは@Entity、@Embeddable、@MappedSuperclassなどのJPAアノテーションでno-argプラグインを設定します。 - Spring BootとKotlin入門チュートリアルを使用して、最初のSpring Bootアプリケーションを作成しましょう。
