具有接收者的 SAM 編譯器外掛程式 (SAM-with-receiver compiler plugin)

sam-with-receiver 編譯器外掛程式使帶有註解的 Java「單一抽象方法」(Single Abstract Method, SAM) 介面方法的第一個參數在 Kotlin 中成為接收器 (receiver)。 這種轉換僅在 SAM 介面作為 Kotlin lambda 傳遞時才有效，適用於 SAM 适配器和 SAM 構造函數（更多詳細資訊，請參閱 SAM 轉換文檔）。

以下是一個範例：

public @interface SamWithReceiver {}

@SamWithReceiver
public interface TaskRunner {
    void run(Task task);
}

fun test(context: TaskContext) {
    val runner = TaskRunner {
        // Here 'this' is an instance of 'Task'

        println("$name is started")
        context.executeTask(this)
        println("$name is finished")
    }
}

Gradle

其用法與 all-open 和 no-arg 相同，唯一的區別是 sam-with-receiver 沒有任何內建預設值，你需要指定你自己的特殊處理註解清單。

Kotlin

plugins {
    kotlin("plugin.sam.with.receiver") version "2.1.20"
}

Groovy

plugins {
    id "org.jetbrains.kotlin.plugin.sam.with.receiver" version "2.1.20"
}

然後指定 SAM-with-receiver 註解的清單：

samWithReceiver {
    annotation("com.my.SamWithReceiver")
}

Maven

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

    <configuration>
        <compilerPlugins>
<plugin>sam-with-receiver</plugin>
        </compilerPlugins>
<pluginOptions>
            <option>
                sam-with-receiver:annotation=com.my.SamWithReceiver
            </option>
        </pluginOptions>
    </configuration>

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

Command-line compiler

將外掛程式 JAR 檔案新增到編譯器外掛程式類別路徑，並指定 sam-with-receiver 註解的清單：

-Xplugin=$KOTLIN_HOME/lib/sam-with-receiver-compiler-plugin.jar
-P plugin:org.jetbrains.kotlin.samWithReceiver:annotation=com.my.SamWithReceiver