All-openコンパイラープラグイン
Kotlinでは、クラスとそのメンバーはデフォルトでfinalです。これは、サブクラス化やランタイムプロキシに依存し、クラスがopenであることを要求するフレームワークやライブラリで問題を引き起こす可能性があります。
all-openコンパイラープラグインは、openキーワードを明示的に記述することなく、コンパイル時にクラスとそのメンバーをopenにします。 アノテーションを作成し、プラグインのオプションに追加した上で、openにしたいクラスにそのアノテーションを付与するだけです。
@YourAnnotation
class MyService {
// このクラスとそのすべてのメンバーはopenになります
fun doWork() { /* ... */ }
}クラスまたはそのスーパークラスのいずれかに設定されたアノテーションが付与されている場合、そのクラスとそのメンバーはopenになります。
Kotlinを使用したSpringアプリケーションでは、kotlin-springコンパイラープラグインを使用できます。 これにより、Springのアノテーションが付与されたクラスとそのメンバーがopenになります。
アノテーションの宣言
all-openプラグインは、その設定に登録したアノテーションでマークされたクラスのみを処理します。 そのため、プラグインを有効にする前に、openにしたいクラスをマークするためのアノテーションを宣言してください。 例えば、AllOpenMarkerです。
package com.example
annotation class AllOpenMarkerプラグインの適用
Gradle
プラグインを有効にするには、build.gradle(.kts)ファイルのplugins {}ブロックに追加します。
// build.gradle.kts
plugins {
kotlin("jvm") version "2.4.21"
kotlin("plugin.allopen") version "2.4.21"
}// build.gradle
plugins {
id "org.jetbrains.kotlin.jvm" version "2.4.21"
id "org.jetbrains.kotlin.plugin.allopen" version "2.4.21"
}次に、先ほど宣言したアノテーション(例: com.example.AllOpenMarker)、またはクラスをopenにするアノテーションのリストを指定します。
allOpen {
annotation("com.example.AllOpenMarker")
// 複数のアノテーションを指定することもできます:
// annotations("com.example.AllOpenMarker", "com.anotherPackage.OtherAnnotation")
}allOpen {
annotation("com.example.AllOpenMarker")
// 複数のアノテーションを指定することもできます:
// annotations("com.example.AllOpenMarker", "com.anotherPackage.OtherAnnotation")
}Maven
pom.xmlファイルにプラグインを追加します。
<properties>
<kotlin.version>2.4.21</kotlin.version>
</properties>
<plugin>
<artifactId>kotlin-maven-plugin</artifactId>
<groupId>org.jetbrains.kotlin</groupId>
<version>${kotlin.version}</version>
<configuration>
<compilerPlugins>
<plugin>all-open</plugin>
</compilerPlugins>
<pluginOptions>
<!-- 複数のアノテーションを指定する場合は行を追加します -->
<option>all-open:annotation=com.example.AllOpenMarker</option>
<option>all-open:annotation=com.anotherPackage.OtherAnnotation</option>
</pluginOptions>
</configuration>
<dependencies>
<dependency>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-maven-allopen</artifactId>
<version>${kotlin.version}</version>
</dependency>
</dependencies>
</plugin>all-openプラグインの使用
クラスまたはそのスーパークラスのいずれかに作成したcom.example.AllOpenMarkerアノテーションが付与されている場合、そのクラスとすべてのメンバーがopenになります。
package com.example
@AllOpenMarker
class TestClass {
// このクラスとそのすべてのメンバーはopenになります
}このプラグインはメタアノテーションにも対応しています。別のアノテーションを@AllOpenMarkerでマークすると、そのアノテーションが付与されたすべてのクラスとメンバーもopenになります。
package com.example
// 事前に作成したアノテーションでマークされたアノテーション
@AllOpenMarker
annotation class AnotherAllOpenMarker
@AllOpenMarker
class NewClass {
// このクラスとそのすべてのメンバーはopenになります
}
@AnotherAllOpenMarker
class AnotherClass {
// このクラスとそのすべてのメンバーも同様にopenになります
}次のステップ
- Springアプリケーションの場合は、Springアノテーションが付与されたクラスを
openにする設定済みラッパーであるkotlin-springプラグインを使用してください。 - JPAエンティティの場合は、エンティティを
openにし、引数なしのコンストラクタ(zero-argument constructor)を生成するkotlin-jpaプラグインを使用してください。 all-openコンパイラープラグインのソースコードを確認してください。
