アノテーション付与でopenにしてくれる「kotlin-spring」の正体を見てみる

kotlin+Spring Bootを使っているとお世話になる「kotlin-spring」が何をやっているかが分からなかったので調査。

早速見てみます。これは@Controllerアノテーション付き。
「public open fun index(…」とあります。openを明示してないのにopenになってますね。

こっちは@Controllerアノテーションなし。
「public final fun index(…」になっています。一転、finalになりました。

画像では関数を例にしていますが、アノテーション付きのControllerにもopen修飾子が付くようになっています。
また、アノテーションが付いてないものはfinalになっています。これはKotlinのデフォルト仕様。

クラスに対してアノテーションを付けるとクラス、変数、関数もopen修飾子が付きます。

こんな感じでSpringのアノテーションを付けると勝手にをopenにしてくれる設定をどこでやっているかを探ります。

All-open compiler plugin とは？
これらのアノテーションを使うとopen修飾子が付く
Spring initializr を使ってプロジェクトを作成した場合
メタアノテーションってなんぞや
環境
参考

All-open compiler plugin とは？

元はこれ。
https://kotlinlang.org/docs/all-open-plugin.html

前述した通りクラスに対してのアノテーション付与で自動的にopen修飾子を付けてくれるすごいやつ。

また、Springを使う用途にkotlin-springというコンパイラプラグインが使える。

If you use Spring, you can enable the kotlin-spring compiler plugin instead of specifying Spring annotations manually. The kotlin-spring is a wrapper on top of all-open, and it behaves exactly the same way.

https://kotlinlang.org/docs/all-open-plugin.html#spring-support

これらのアノテーションを使うとopen修飾子が付く

kotlin-springを使用して以下のアノテーションを付与した場合、openになるよ。と書いてある。

The plugin specifies the following annotations:

@Component

@Async

@Transactional

@Cacheable

@SpringBootTest

Thanks to meta-annotations support, classes annotated with @Configuration, @Controller, @RestController, @Service or @Repository are automatically opened since these annotations are meta-annotated with @Component.

Spring initializr を使ってプロジェクトを作成した場合

build.gradle.ktsの場合こんな記述がデフォルトで存在する。

import org.jetbrains.kotlin.gradle.tasks.KotlinCompile

plugins {
	id("org.springframework.boot") version "2.5.6"
	id("io.spring.dependency-management") version "1.0.11.RELEASE"
	kotlin("jvm") version "1.5.31"
	kotlin("plugin.spring") version "1.5.31" // これ
}

kotlin("plugin.spring") version "1.5.31"の記述があるだけで、前述のアノテーションを付与するだけでopen修飾子が付く設定が完了している。

「all-open」みたいな記述がないので一見適用されていることが分かりづらいがこんな感じ。

他にもGradleでの書き方は色々あるので参考に
https://plugins.gradle.org/plugin/org.jetbrains.kotlin.plugin.spring

メタアノテーションってなんぞや

openにすることが出来るアノテーション一覧で見たこんな記述。

Thanks to meta-annotations support, classes annotated with @Configuration, @Controller, @RestController, @Service or @Repository are automatically opened since these annotations are meta-annotated with @Component.

要は@Component使わなくても@Serviceとか@RestControllerでもopenにすることが出来るよ！という話。

これを実現しているのはメタアノテーションのおかげ、と書いてあるが果たしてなんだろうか。