Plugin Konvensi & Logika Pembangunan
Kembangkan dan terapkan plugin konvensi untuk menegakkan konfigurasi serta standar pembangunan yang konsisten di seluruh organisasi Anda.
Plugin Konvensi & Logika Pembangunan adalah pelajaran Groovy & Gradle: JVM Automation and Build Engineering gratis di CoddyKit. Ini adalah pelajaran 3 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 Groovy & Gradle: JVM Automation and Build Engineering, dan progresmu tersinkronisasi di web dan aplikasi CoddyKit. Kursus Groovy & Gradle: JVM Automation and Build Engineering mencakup 4 pelajaran total.
Bagian dari pelajaran ini belum diterjemahkan dan ditampilkan dalam bahasa Inggris.
What are Convention Plugins?
In large Gradle multi-project builds, maintaining consistent configurations across many subprojects can become a challenge. This is where Convention Plugins come in handy.
A convention plugin is essentially a way to package and reuse common build logic and configurations specific to your organization or project. They help enforce standards and reduce boilerplate.
The Problem: Inconsistent Build Logic
Imagine you have several Java subprojects. Each needs to apply the java-library plugin, set a specific Java toolchain, and configure common repositories. Without convention plugins, you might end up with repetitive and slightly different configurations in each build.gradle file.
/* project-a/build.gradle */
plugins {
id 'java-library'
}
java {
toolchain {
languageVersion = JavaLanguageVersion.of(17)
}
}
repositories {
mavenCentral()
}
/* project-b/build.gradle */
plugins {
id 'java-library'
}
java {
toolchain {
languageVersion = JavaLanguageVersion.of(17)
}
}
repositories {
mavenCentral()
}Centralizing Build Logic with `buildSrc`
To solve the problem of repetition, Gradle offers a special directory: buildSrc. When present in your project root, Gradle automatically compiles any code (Groovy, Kotlin, Java) found within buildSrc and adds it to the classpath of your build scripts.
This makes buildSrc the perfect place to define internal build logic, custom tasks, and especially, convention plugins.
Crafting Your First Convention Plugin
Let's create a simple convention plugin to standardize our Java library setup. We'll define it in buildSrc/src/main/groovy/my.java-conventions.groovy. This plugin will apply the java-library plugin, set Java 17 as the toolchain, and add mavenCentral().
// buildSrc/src/main/groovy/my.java-conventions.groovy
plugins {
id 'java-library'
}
java {
toolchain {
languageVersion = JavaLanguageVersion.of(17)
}
}
repositories {
mavenCentral()
}Applying Your Convention Plugin
Once you've defined your convention plugin in buildSrc, you can apply it to any subproject's build.gradle file using its ID. Notice how much cleaner and more concise the subproject's build file becomes!
// subproject-a/build.gradle
plugins {
id 'my.java-conventions'
}
// All Java library, Java 17, and Maven Central settings
// are now applied automatically by the convention plugin!Expanding Conventions: Dependencies & Tests
Convention plugins can do much more than just basic settings. You can enforce common dependencies, configure testing frameworks, or standardize other build aspects. Here, we add JUnit Jupiter dependencies and a common test logging configuration.
// buildSrc/src/main/groovy/my.java-conventions.groovy (updated)
plugins {
id 'java-library'
}
// ... (previous Java toolchain and repositories config)
dependencies {
testImplementation platform('org.junit:junit-bom:5.10.0')
testImplementation 'org.junit.jupiter:junit-jupiter'
}
test {
useJUnitPlatform()
testLogging {
events "passed", "skipped", "failed"
}
}Convention Plugins with Kotlin DSL
Just like regular build scripts, convention plugins can also be written using the Kotlin DSL (.gradle.kts files). This provides compile-time safety and better IDE support, which can be very valuable for complex build logic.
The structure remains similar, just with Kotlin syntax.
// buildSrc/src/main/kotlin/my.kotlin-conventions.gradle.kts
plugins {
java
}
java {
toolchain {
languageVersion = JavaLanguageVersion.of(21)
}
}
repositories {
mavenCentral()
}Applying to the Root Project
While convention plugins are often used for subprojects, they can also be applied to the root project's build.gradle. This is useful for defining build-wide properties or configurations that should apply to the entire project, like common dependency versions.
// build.gradle (root project)
plugins {
id 'my.root-conventions'
}
// buildSrc/src/main/groovy/my.root-conventions.groovy
ext {
// Define properties accessible throughout the build
springBootVersion = '3.2.0'
kotlinVersion = '1.9.0'
}Benefits and Best Practices
Convention plugins are a cornerstone of maintainable, large-scale Gradle builds:
- Consistency: Ensures all projects adhere to organizational standards.
- Reduced Duplication: Centralizes common build logic, eliminating copy-pasting.
- Easier Maintenance: Update standards in one place; all projects instantly benefit.
- Improved Readability: Subproject build files become shorter and more focused on project-specific details.
When creating them, keep plugins focused on a single concern, use clear IDs, and leverage Kotlin DSL for type safety.
Convention Checkpoint
Convention plugins are a powerful way to standardize build logic and enforce organizational standards. Let's test your understanding.
Recap: Mastering Convention Plugins
You've now learned about Gradle Convention Plugins! They are an essential tool for managing complex, multi-project builds.
- Convention plugins centralize common build logic.
- They are typically defined in the
buildSrcdirectory. - They help enforce consistent configurations (Java versions, dependencies, test setups).
- They drastically reduce boilerplate and improve maintainability.
By leveraging convention plugins, you can build more robust and scalable Gradle projects.
Belajar Groovy dengan tutor AI — gratis
Tulis dan jalankan kode asli di browser kamu, dapatkan bantuan instan dari tutor AI 24/7, dan lanjutkan di mana kamu tinggalkan di web atau aplikasi.
- Kursus
- 12
- Pelajaran
- 48
Pertanyaan yang Sering Diajukan
Apakah pelajaran “Plugin Konvensi & Logika Pembangunan” gratis?
Ya — teks lengkap “Plugin Konvensi & Logika Pembangunan” gratis dibaca di sini di web. Untuk praktiknya secara interaktif (editor kode bawaan dan tutor AI 24/7) dan buka sisa kursus Groovy & Gradle: JVM Automation and Build Engineering, upgrade ke CoddyKit PRO. Kursus Groovy & Gradle: JVM Automation and Build Engineering mencakup 4 pelajaran total.
Apa yang akan aku pelajari di “Plugin Konvensi & Logika Pembangunan”?
Kembangkan dan terapkan plugin konvensi untuk menegakkan konfigurasi serta standar pembangunan yang konsisten di seluruh organisasi Anda. Kamu berlatih Groovy & Gradle: JVM Automation and Build Engineering 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 Groovy & Gradle: JVM Automation and Build Engineering?
Tidak diperlukan pengalaman sebelumnya. Groovy & Gradle: JVM Automation and Build Engineering 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 3 dari 4.
Berapa lama pelajaran “Plugin Konvensi & Logika Pembangunan” 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 Groovy & Gradle: JVM Automation and Build Engineering ini?
Ya. Setiap pelajaran Groovy & Gradle: JVM Automation and Build Engineering 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
- Gradle Build Scan & Wawasan
- Keamanan & Pengelolaan Kredensial
- Plugin Konvensi & Logika Pembangunan
- Katalog Versi Dependensi dan Platform