All-open 编译器插件

Kotlin 中的类及其成员默认是 final 的，这使得在使用 Spring AOP 等需要类为 open 的框架和库时很不方便。all-open 编译器插件使 Kotlin 适应这些框架的要求，并使得用特定注解标记的类及其成员无需显式 open 关键字即可变为 open。

例如，当您使用 Spring 时，不需要所有类都是 open 的，而只需要用 @Configuration 或 @Service 等特定注解标记的类。all-open 插件允许您指定此类注解。

Kotlin 为 Gradle 和 Maven 都提供了 all-open 插件支持，并具有完整的 IDE 集成。

对于 Spring，您可以使用 kotlin-spring 编译器插件。

Gradle

在您的 build.gradle(.kts) 文件中添加该插件：

KotlinGroovy

plugins {
    kotlin("plugin.allopen") version "2.2.21"
}

plugins {
    id "org.jetbrains.kotlin.plugin.allopen" version "2.2.21"
}

然后指定将使类变为 open 的注解列表：

KotlinGroovy

allOpen {
    annotation("com.my.Annotation")
    // annotations("com.another.Annotation", "com.third.Annotation")
}

allOpen {
    annotation("com.my.Annotation")
    // annotations("com.another.Annotation", "com.third.Annotation")
}

如果类（或其任何超类）用 com.my.Annotation 注解，则该类本身及其所有成员都将变为 open。

它也适用于元注解：

@com.my.Annotation
annotation class MyFrameworkAnnotation

@MyFrameworkAnnotation
class MyClass // will be all-open

MyFrameworkAnnotation 用 all-open 元注解 com.my.Annotation 注解，因此它也成为了 all-open 注解。

Maven

在您的 pom.xml 文件中添加该插件：

<plugin>
    <artifactId>kotlin-maven-plugin</artifactId>
    <groupId>org.jetbrains.kotlin</groupId>
    <version>${kotlin.version}</version>

    <configuration>
        <compilerPlugins>
            <!-- Or "spring" for the Spring support -->
            <plugin>all-open</plugin>
        </compilerPlugins>

        <pluginOptions>
            <!-- Each annotation is placed on its own line -->
            <option>all-open:annotation=com.my.Annotation</option>
            <option>all-open:annotation=com.their.AnotherAnnotation</option>
        </pluginOptions>
    </configuration>

    <dependencies>
        <dependency>
            <groupId>org.jetbrains.kotlin</groupId>
            <artifactId>kotlin-maven-allopen</artifactId>
            <version>${kotlin.version}</version>
        </dependency>
    </dependencies>
</plugin>

关于 all-open 注解如何工作的详细信息，请参见 Gradle 小节。

Spring 支持

如果您使用 Spring，可以启用 kotlin-spring 编译器插件，而不是手动指定 Spring 注解。kotlin-spring 是 all-open 的一个包装器，其行为方式与 all-open 完全相同。

在您的 build.gradle(.kts) 文件中添加 spring 插件：

KotlinGroovy

plugins {
    id("org.jetbrains.kotlin.plugin.spring") version "2.2.21"
}

plugins {
    id "org.jetbrains.kotlin.plugin.spring" version "2.2.21"
}

在 Maven 中，spring 插件由 kotlin-maven-allopen 插件依赖项提供，因此要在 pom.xml 文件中启用它：

<compilerPlugins>
    <plugin>spring</plugin>
</compilerPlugins>

<dependencies>
    <dependency>
        <groupId>org.jetbrains.kotlin</groupId>
        <artifactId>kotlin-maven-allopen</artifactId>
        <version>${kotlin.version}</version>
    </dependency>
</dependencies>

该插件指定了以下注解：

• @Component
• @Async
• @Transactional
• @Cacheable
• @SpringBootTest

由于 @Configuration、@Controller、@RestController、@Service 或 @Repository 这些注解都用 @Component 进行了元注解，因此得益于元注解支持，用它们标记的类也会自动变为 open。

当然，您可以在同一个项目中同时使用 kotlin-allopen 和 kotlin-spring。

如果您通过 start.spring.io 服务生成项目模板，则 kotlin-spring 插件将默认启用。

命令行编译器

All-open 编译器插件 JAR 文件在 Kotlin 编译器的二进制发行版中可用。您可以通过使用 -Xplugin kotlinc 选项提供其 JAR 文件路径来附加该插件：

-Xplugin=$KOTLIN_HOME/lib/allopen-compiler-plugin.jar

您可以直接指定 all-open 注解，使用 annotation 插件选项，或者启用“预设”：

# The plugin option format is: "-P plugin:<plugin id>:<key>=<value>". 
# Options can be repeated.

-P plugin:org.jetbrains.kotlin.allopen:annotation=com.my.Annotation
-P plugin:org.jetbrains.kotlin.allopen:preset=spring

可用于 all-open 插件的预设包括：spring、micronaut 和 quarkus。