Kotlin Academy · Pelajaran

Mengintegrasikan Pemroses KSP ke Build Gradle

Konfigurasikan KSP di Gradle, tambahkan sumber yang dibuat, dan debug output pemroses.

Mengintegrasikan Pemroses KSP ke Build Gradle adalah pelajaran Kotlin Academy gratis di CoddyKit. Ini adalah pelajaran 4 dari 4. Kamu bisa membaca pelajaran lengkapnya di bawah secara gratis — lalu praktikkan langsung di browser dengan editor kode bawaan dan tutor AI 24/7. Ini adalah bagian dari jalur belajar Kotlin Academy, dan progresmu tersinkronisasi di web dan aplikasi CoddyKit. Kursus Kotlin Academy mencakup 4 pelajaran total.

Struktur Multimodul

Penyiapan KSP biasanya memiliki setidaknya dua modul: :annotation (berisi kelas anotasi Anda) dan :processor (berisi SymbolProcessor). Modul konsumen menerapkan pengaya KSP serta mendeklarasikan dependensi ksp dan implementation.

Menerapkan Pengaya KSP

Dalam build.gradle.kts milik modul konsumen:

plugins {
    kotlin("jvm")  // or android, multiplatform
    id("com.google.devtools.ksp") version "2.0.0-1.0.21"
}

Mendeklarasikan Dependensi ksp

Gunakan konfigurasi ksp (bukan implementation) untuk menambahkan pemroses KSP. Pemroses hanya berjalan saat pembangunan dan tidak disertakan dalam artefak final:

dependencies {
    implementation(project(":annotation"))
    ksp(project(":processor"))
}

Direktori Berkas Sumber yang Dihasilkan

KSP menulis berkas yang dihasilkan di bawah build/generated/ksp/<sourceSet>/kotlin/. Pengaya KSP secara otomatis menambahkan direktori ini ke kumpulan sumber Kotlin, sehingga kelas yang dihasilkan dapat dilihat oleh kode Anda tanpa konfigurasi manual.

Meneruskan Opsi ke Pemroses

Teruskan opsi saat pembangunan dari Gradle ke pemroses Anda melalui ksp { arg("key", "value") }. Baca opsi tersebut dalam pemroses melalui environment.options["key"]:

// build.gradle.kts (consumer)
ksp {
    arg("generateMocks", "true")
    arg("outputPackage", "com.example.generated")
}

Membaca Opsi dalam Pemroses

Dalam metode SymbolProcessorProvider.create(), akses opsi dari lingkungan:

class MyProcessorProvider : SymbolProcessorProvider {
    override fun create(environment: SymbolProcessorEnvironment): SymbolProcessor {
        val genMocks = environment.options["generateMocks"] == "true"
        return MyProcessor(environment.codeGenerator, environment.logger, genMocks)
    }
}

Pembangunan Inkremental

KSP melacak dependensi input-output. Kaitkan setiap berkas yang dihasilkan dengan simbol sumbernya saat memanggil codeGenerator.createNewFile(). KSP kemudian melewati pemrosesan ulang jika tidak ada input yang dilacak berubah.

val deps = Dependencies(aggregating = false, *symbols.map { it.containingFile!! }.toTypedArray())
codeGenerator.createNewFile(deps, packageName, fileName)

KSP dengan Android

Untuk proyek Android, ganti kapt dengan ksp dalam deklarasi pengaya dan dependensi. Gunakan konfigurasi per varian seperti kspDebug atau kspRelease jika perilaku pemroses perlu berbeda antara jenis pembangunan.

KSP dengan Kotlin Multiplatform

Dalam proyek KMP, terapkan pengaya KSP dan gunakan add(kotlinCompilation.defaultSourceSetName + "ksp", project(":processor")) atau singkatan kspCommonMainMetadata, kspJvmMain, dan seterusnya, bergantung pada target yang didukung pemroses Anda.

Melihat Berkas yang Dihasilkan

Setelah menjalankan ./gradlew build (atau kspKotlin / kspDebugKotlin untuk Android), periksa build/generated/ksp/. IntelliJ dan Android Studio menandai folder ini sebagai sumber yang dihasilkan dan memungkinkan navigasi dari penggunaan ke deklarasi yang dihasilkan.

Men-debug Pemroses

Jalankan tugas Gradle dengan --debug atau tambahkan jvmArgs("-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005") ke konfigurasi ksp untuk menghubungkan pengawakutu jarak jauh ke JVM pemrosesan anotasi.

Pemeriksaan Singkat

Konfigurasi Gradle mana yang digunakan untuk menambahkan pemroses KSP yang berjalan saat pembangunan tetapi tidak disertakan dalam jalur kelas saat aplikasi berjalan?

Rekapitulasi: Mengintegrasikan KSP ke dalam Pembangunan Gradle

Poin penting:

Terapkan pengaya com.google.devtools.ksp; tambahkan pemroses dengan dependensi ksp()
Sumber yang dihasilkan ditempatkan di build/generated/ksp/ dan otomatis ditambahkan ke kumpulan sumber
Teruskan opsi dari Gradle melalui ksp { arg() }; baca opsi tersebut melalui environment.options
Gunakan Dependencies dengan createNewFile() untuk pembangunan ulang inkremental yang akurat
Berfungsi dengan Android (konfigurasi per varian) dan Kotlin Multiplatform

Pertanyaan yang Sering Diajukan

Apakah pelajaran “Mengintegrasikan Pemroses KSP ke Build Gradle” gratis?

Ya — teks lengkap “Mengintegrasikan Pemroses KSP ke Build Gradle” gratis dibaca di sini di web. Untuk praktiknya secara interaktif (editor kode bawaan dan tutor AI 24/7) dan buka sisa kursus Kotlin Academy, upgrade ke CoddyKit PRO. Kursus Kotlin Academy mencakup 4 pelajaran total.

Apa yang akan aku pelajari di “Mengintegrasikan Pemroses KSP ke Build Gradle”?

Konfigurasikan KSP di Gradle, tambahkan sumber yang dibuat, dan debug output pemroses. Kamu berlatih Kotlin Academy dengan kode praktik yang langsung kamu jalankan di browser, dan tutor AI 24/7 menjawab pertanyaanmu saat kamu mengerjakan pelajaran ini.

Apakah aku perlu pengalaman untuk memulai Kotlin Academy?

Tidak diperlukan pengalaman sebelumnya. Kotlin Academy di CoddyKit dirancang untuk pemula hingga pelajar tingkat lanjut, jadi kamu bisa memulai di sini atau dari awal dan belajar sesuai kecepatan kamu sendiri. Ini adalah pelajaran 4 dari 4.

Berapa lama pelajaran “Mengintegrasikan Pemroses KSP ke Build Gradle” memakan waktu?

Sebagian besar pelajaran CoddyKit memakan waktu sekitar 5–10 menit. Setiap pelajaran ringkas dan interaktif, jadi kamu membuat kemajuan stabil dan melanjutkan dari tempat kamu tinggalkan di web dan aplikasi.

Bisakah aku menulis dan menjalankan kode dalam pelajaran Kotlin Academy ini?

Ya. Setiap pelajaran Kotlin Academy menyertakan editor kode bawaan, jadi kamu menulis dan menjalankan kode nyata langsung di browser dan mendapatkan umpan balik AI instan — tidak diperlukan penyiapan lokal.

Semua pelajaran dalam kursus ini

KSP vs KAPT: Mengapa KSP Lebih Cepat
Menulis SymbolProcessor Pertama Anda
Membuat File Sumber Kotlin dengan KotlinPoet
Mengintegrasikan Pemroses KSP ke Build Gradle

← Kembali ke Kotlin Academy