All-open 編譯器外掛程式
在 Kotlin 中,類別及其成員預設為 final。這可能會導致仰賴子類別化與執行階段代理(runtime proxy)的架構與程式庫出現問題,因為它們需要類別為 open。
all-open 編譯器外掛程式會在編譯期將類別及其成員設為 open,而無需使用 open 關鍵字。 你需要建立一個註解,將其新增至外掛程式選項中,並為要設為 open 的類別加上該註解:
kotlin
@YourAnnotation
class MyService {
// 這個類別及其所有成員現在都是 open 的
fun doWork() { /* ... */ }
}若某個類別或其任何超類別標有已配置的註解,該類別及其成員就會變為 open。
對於使用 Kotlin 的 Spring 應用程式,你可以使用 kotlin-spring 編譯器外掛程式。 它會在類別帶有 Spring 註解時,將該類別及其成員設為 open。
宣告註解
all-open 外掛程式僅會處理標有你在其配置中註冊之註解的類別。 因此在啟用外掛程式之前,請宣告一個註解來標記想要設為 open 的類別。 例如 AllOpenMarker:
kotlin
package com.example
annotation class AllOpenMarker套用外掛程式
Gradle
若要啟用外掛程式,請將其新增至 build.gradle(.kts) 檔案的 plugins {} 區塊中:
kotlin
// build.gradle.kts
plugins {
kotlin("jvm") version "2.4.21"
kotlin("plugin.allopen") version "2.4.21"
}groovy
// 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 的註解清單:
kotlin
allOpen {
annotation("com.example.AllOpenMarker")
// 你可以指定多個註解:
// annotations("com.example.AllOpenMarker", "com.anotherPackage.OtherAnnotation")
}groovy
allOpen {
annotation("com.example.AllOpenMarker")
// 你可以指定多個註解:
// annotations("com.example.AllOpenMarker", "com.anotherPackage.OtherAnnotation")
}Maven
在你的 pom.xml 檔案中新增此外掛程式:
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:
kotlin
package com.example
@AllOpenMarker
class TestClass {
// 這個類別及其所有成員都是 open 的
}此外掛程式也支援元註解(meta-annotation)。若你使用 @AllOpenMarker 標記另一個註解,則所有標有該註解的類別和成員也都會變為 open:
kotlin
package com.example
// 使用先前建立的註解標記的註解
@AllOpenMarker
annotation class AnotherAllOpenMarker
@AllOpenMarker
class NewClass {
// 這個類別及其所有成員都是 open 的
}
@AnotherAllOpenMarker
class AnotherClass {
// 這個類別及其所有成員也都是 open 的
}後續步驟
- 對於 Spring 應用程式,請使用
kotlin-spring外掛程式,這是一個預先設定好的包裝函式,能將帶有 Spring 註解的類別設為open。 - 對於 JPA 實體,請使用
kotlin-jpa外掛程式,它會將實體設為open並為其產生無引數建構函式。 - 探索
all-open編譯器外掛程式 的原始碼。
