본문으로 건너뛰기

All-open 컴파일러 플러그인

Kotlin은 클래스와 해당 멤버가 기본적으로 final이기 때문에, Spring AOP와 같이 클래스가 open되어야 하는 프레임워크 및 라이브러리를 사용하는 데 불편함이 있습니다. all-open 컴파일러 플러그인은 Kotlin을 이러한 프레임워크의 요구 사항에 맞게 조정하고, 특정 어노테이션으로 어노테이트된 클래스와 해당 멤버를 명시적인 open 키워드 없이 open되도록 만듭니다.

예를 들어 Spring을 사용할 때 모든 클래스를 open할 필요는 없지만 @Configuration 또는 @Service와 같은 특정 어노테이션으로 어노테이트된 클래스만 open하면 됩니다. all-open 플러그인을 사용하면 이러한 어노테이션을 지정할 수 있습니다.

Kotlin은 완전한 IDE 통합과 함께 Gradle 및 Maven 모두에 대한 all-open 플러그인 지원을 제공합니다.

노트

Spring의 경우 kotlin-spring 컴파일러 플러그인을 사용할 수 있습니다.

Gradle​

build.gradle(.kts) 파일에 플러그인을 추가합니다:

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

그런 다음 클래스를 open되도록 만드는 어노테이션 목록을 지정합니다:

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을 사용하는 경우 Spring 어노테이션을 수동으로 지정하는 대신 kotlin-spring 컴파일러 플러그인을 활성화할 수 있습니다. kotlin-spring은 all-open을 래핑한 것으로, 완전히 동일한 방식으로 동작합니다.

build.gradle(.kts) 파일에 spring 플러그인을 추가합니다:

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

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>

플러그인은 다음 어노테이션을 지정합니다.

메타 어노테이션 지원 덕분에 @Configuration, @Controller, @RestController, @Service 또는 @Repository 로 어노테이트된 클래스는 이러한 어노테이션이 @Component로 메타 어노테이트되어 있기 때문에 자동으로 열립니다.

물론 동일한 프로젝트에서 kotlin-allopen과 kotlin-spring을 모두 사용할 수 있습니다.

노트

start.spring.io 서비스로 프로젝트 템플릿을 생성하면 kotlin-spring 플러그인이 기본적으로 활성화됩니다.

Command-line compiler​

All-open 컴파일러 플러그인 JAR은 Kotlin 컴파일러의 바이너리 배포판에서 사용할 수 있습니다. -Xplugin kotlinc 옵션을 사용하여 해당 JAR 파일의 경로를 제공하여 플러그인을 연결할 수 있습니다.

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

annotation 플러그인 옵션을 사용하여 all-open 어노테이션을 직접 지정하거나 _preset_을 활성화할 수 있습니다.

# 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입니다.