Skip to content

All-open 编译器插件 ​

在 Kotlin 中,类及其成员默认都是 final 的。这可能会给依赖子类化和运行时代理的框架与库带来问题,因为它们要求类必须是 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 的
}

该插件还支持元注解。如果使用 @AllOpenMarker 标记另一个注解, 则所有带有该新注解的类及其成员也都会变为 open:

kotlin
package com.example

// 使用之前创建的注解进行标记的注解
@AllOpenMarker
annotation class AnotherAllOpenMarker

@AllOpenMarker
class NewClass {
    // 该类及其所有成员都是 open 的
}

@AnotherAllOpenMarker
class AnotherClass {
    // 该类及其所有成员也都是 open 的
}

后续步骤 ​