PricingLoginStart free
Groovy & Gradle: JVM Automation and Build Engineering · Lezione

Plugin di convenzione e logica di build

Sviluppi e applichi plugin di convenzione per imporre configurazioni e standard di build coerenti in tutta la Sua organizzazione.

Lezione 3 di 411 passaggi

Plugin di convenzione e logica di build è una lezione Groovy & Gradle: JVM Automation and Build Engineering gratuita su CoddyKit. Questa è la lezione 3 di 4. Puoi leggere la lezione completa qui gratuitamente — poi esercitati direttamente nel browser con un editor di codice integrato e un tutor IA disponibile 24/7. Fa parte del percorso di apprendimento Groovy & Gradle: JVM Automation and Build Engineering, e i tuoi progressi si sincronizzano tra il web e l'app CoddyKit. Il corso Groovy & Gradle: JVM Automation and Build Engineering include 4 lezioni in totale.

Parti di questa lezione non sono ancora state tradotte e vengono mostrate in inglese.

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.

Rispondi nella lezione interattiva

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 buildSrc directory.
  • 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.

Gratis per iniziare

Impara Groovy con un tutor IA — gratis

Scrivi ed esegui vero codice nel tuo browser, ricevi aiuto istantaneo da un tutor IA disponibile 24/7, e riprendi da dove hai lasciato sul web o nell'app.

Corsi
12
Lezioni
48
Inizia a imparare gratisVisualizza il corso completo

Domande Frequenti

La lezione «Plugin di convenzione e logica di build» è gratuita?

Sì — il testo completo di «Plugin di convenzione e logica di build» è gratuito qui sul web. Per esercitarvi in modo interattivo (un editor di codice integrato e un tutor IA 24/7) e sbloccare il resto del corso Groovy & Gradle: JVM Automation and Build Engineering, passa a CoddyKit PRO. Il corso Groovy & Gradle: JVM Automation and Build Engineering include 4 lezioni in totale.

Cosa imparerò in «Plugin di convenzione e logica di build»?

Sviluppi e applichi plugin di convenzione per imporre configurazioni e standard di build coerenti in tutta la Sua organizzazione. Eserciti Groovy & Gradle: JVM Automation and Build Engineering con codice pratico che esegui direttamente nel browser, e un tutor IA 24/7 risponde alle tue domande mentre lavori sulla lezione.

Ho bisogno di esperienza per iniziare Groovy & Gradle: JVM Automation and Build Engineering?

Non è richiesta alcuna esperienza precedente. Groovy & Gradle: JVM Automation and Build Engineering su CoddyKit è strutturato per principianti e studenti avanzati, quindi puoi iniziare da qui o dall'inizio e procedere al tuo ritmo. Questa è la lezione 3 di 4.

Quanto tempo richiede la lezione «Plugin di convenzione e logica di build»?

La maggior parte delle lezioni CoddyKit richiede circa 5–10 minuti. Ogni lezione è breve e interattiva, quindi fai progressi costanti e riprendi esattamente da dove hai lasciato su web e app.

Posso scrivere ed eseguire codice in questa lezione Groovy & Gradle: JVM Automation and Build Engineering?

Sì. Ogni lezione Groovy & Gradle: JVM Automation and Build Engineering include un editor di codice integrato, quindi scrivi ed esegui codice reale direttamente nel tuo browser e ricevi feedback istantaneo dall'IA — nessuna configurazione locale necessaria.

Tutte le lezioni di questo corso

  1. Build Scan e analisi Gradle
  2. Sicurezza e gestione delle credenziali
  3. Plugin di convenzione e logica di build
  4. Cataloghi delle versioni delle dipendenze e piattaforme
← Torna a Groovy & Gradle: JVM Automation and Build Engineering