Skip to content

編譯器外掛程式 ​

編譯器外掛程式可在程式碼編譯期間掛鉤至編譯過程,藉此分析或修改程式碼,而無需修改編譯器本身。例如,它們可以為程式碼加入註解,或是產生新程式碼以使其與其他架構或 API 相容。

本頁面介紹可供使用的 Kotlin 編譯器外掛程式,以及在這些外掛程式皆不符合您的使用案例時可以採取的做法。

Kotlin 團隊維護以下編譯器外掛程式:

外掛程式說明
All-open自動將帶有註解的類別及其成員設為 open,以便架構能在執行階段擴充它們。
AtomicFU將原子操作轉換為高效且針對特定平台的實作,以實現無鎖並行 (lock-free concurrency)。
DataFrame產生型別化 API,讓您能以安全且符合 Kotlin 慣用語的方式操作 DataFrame。
JPA將帶有 JPA 註解的實體設為 open,並為其產生零引數建構函式;包裝了 all-open 與 no-arg。
js-plain-objects將 Kotlin 類別公開為純 JavaScript 物件,以改善與 JS 工具鏈及程式庫的互通性。
jvm-abi-gen產生應用程式二進位介面 (ABI) JAR 檔。
kapt在 Kotlin 程式碼上執行 Java 註解處理器,並產生額外的原始碼檔案。
Lombok讓 Kotlin 程式碼能夠辨識並使用 Java 原始碼中由 Lombok 註解產生的程式碼。
no-arg為帶有註解的類別產生無引數建構函式,以支援需要此類建構函式的架構。
Power-assert透過顯示運算式各部分的詳細值,增強斷言失敗時的資訊呈現。
SAM with receiver允許 SAM 介面使用帶有接收者的 Lambda 運算式,以實現更貼近 DSL 的語法。
Serialization產生無需透過反射即可序列化與反序列化 Kotlin 物件的程式碼。
Spring將帶有 Spring 註解的類別與成員設為 open;為預先設定好的 all-open 包裝函式。

Google 的 Android 團隊維護:

外掛程式說明
Compose compiler Gradle plugin將 Compose 編譯器與 Gradle 整合,以啟用宣告式 UI 功能與 Compose 專屬的最佳化。
Parcelize plugin自動產生 Parcelable 實作,讓您可以在 Android 元件之間傳遞 Kotlin 物件。

如果您需要調整編譯過程,而上述外掛程式無法涵蓋您的需求,請先確認是否可以使用 Kotlin 符號處理 (KSP) API 或外部程式碼檢查工具(例如 Android lint)。 您可以瀏覽我們的 Kotlin Slack 或與我們聯絡, 針對您的使用案例尋求建議。

如果您仍然找不到符合需求的方案,可以建立自訂編譯器外掛程式。請僅將此做法作為最後手段, 因為 Kotlin 編譯器外掛程式 API 並不穩定。如果您建立了自訂編譯器外掛程式, 由於每個新的編譯器版本都會引入破壞性變更 (breaking changes),您將需要投入大量的持續心力來維護它。