gradle
Gradle-plug-ins

Eenvoudige gradle-plug-in van `buildSrc`

Eenvoudig voorbeeld van het maken van een aangepaste plug-in en DSL voor uw gradle-project.
In dit voorbeeld wordt een van de drie mogelijke manieren gebruikt om plug-ins te maken.
De drie manieren zijn:

• in lijn
• buildSrc
• zelfstandige plug-ins

Dit voorbeeld toont het maken van een plug-in vanuit de map buildSrc .

In dit voorbeeld worden vijf bestanden gemaakt

// project's build.gradle
build.gradle
// build.gradle to build the `buildSrc` module
buildSrc/build.gradle
// file name will be the plugin name used in the `apply plugin: $name`
// where name would be `sample` in this example
buildSrc/src/main/resources/META-INF/gradle-plugins/sample.properties
// our DSL (Domain Specific Language) model
buildSrc/src/main/groovy/so/docs/gradle/plugin/SampleModel.groovy
// our actual plugin that will read the values from the DSL
buildSrc/src/main/groovy/so/docs/gradle/plugin/SamplePlugin.groovy

build.gradle:

group 'so.docs.gradle'
version '1.0-SNAPSHOT'

apply plugin: 'groovy'
// apply our plugin... calls SamplePlugin#apply(Project)
apply plugin: 'sample'

repositories {
    mavenCentral()
}

dependencies {
    compile localGroovy()
}

// caller populates the extension model applied above
sample {
    product = 'abc'
    customer = 'zyx'
}

// dummy task to limit console output for example
task doNothing <<{}

buildSrc / build.gradle

apply plugin: 'groovy'

repositories {
    mavenCentral()
}

dependencies {
    compile localGroovy()
}

buildSrc / src / main / groovy / zo / docs / gradle / plugin / SamplePlugin.groovy:

package so.docs.gradle.plugin

import org.gradle.api.Plugin
import org.gradle.api.Project

class SamplePlugin implements Plugin<Project> {
    @Override
    void apply(Project target) {
        // create our extension on the project for our model
        target.extensions.create('sample', SampleModel)
        // once the script has been evaluated the values are available
        target.afterEvaluate {
            // here we can do whatever we need to with our values
            println "populated model: $target.extensions.sample"
        }
    }
}

buildSrc / src / main / groovy / zo / docs / gradle / plugin / SampleModel.groovy:

package so.docs.gradle.plugin

// define our DSL model
class SampleModel {
    public String product;
    public String customer;

    @Override
    public String toString() {
        final StringBuilder sb = new StringBuilder("SampleModel{");
        sb.append("product='").append(product).append('\'');
        sb.append(", customer='").append(customer).append('\'');
        sb.append('}');
        return sb.toString();
    }
}

buildSrc / src / main / resources / META-INF / gradle-plugins / sample.properties

implementation-class=so.docs.gradle.plugin.SamplePlugin

Met deze opstelling kunnen we de waarden zien die door de beller in uw DSL-blok zijn opgegeven

 $ ./gradlew -q doNothing
SampleModel{product='abc', customer='zyx'}

Een zelfstandige plug-in schrijven

Om een aangepaste zelfstandige Gradle-plug-in te maken met behulp van Java (u kunt ook Groovy gebruiken), moet u een structuur als deze maken:

plugin
|-- build.gradle
|-- settings.gradle
|-- src
    |-- main
    |   |-- java
    |   |-- resources
    |       |-- META-INF
    |           |-- gradle-plugins
    |-- test

Gradle-configuratie instellen

In het build.gradle bestand definieert u uw project.

apply plugin: 'java'
apply plugin: 'maven'

dependencies {
    compile gradleApi()
} 

De java plug-in wordt gebruikt om Java-code te schrijven.
De gradleApi() -afhankelijkheid geeft ons alle methoden en eigenschappen die nodig zijn om een Gradle-plug-in te maken.

In het bestand settings.gradle :

rootProject.name = 'myplugin' 

Het definieert het artefact-ID in Maven.
Als het bestand settings.gradle niet aanwezig is in de map met plug-ins, is de standaardwaarde de naam van de map.

Maak de plug-in

Definieer een klasse in de src/main/java/org/sample/MyPlugin.java die de Plugin interface implementeert.

import org.gradle.api.Plugin;
import org.gradle.api.Project;

public class MyPlugin implements Plugin<Project> {

    @Override
    public void apply(Project project) {
         project.getTasks().create("myTask", MyTask.class);
    }

} 

Definieer de taak die de klasse DefaultTask uitbreidt:

import org.gradle.api.DefaultTask;
import org.gradle.api.tasks.TaskAction;

public class MyTask extends DefaultTask {

    @TaskAction
    public void myTask() {
        System.out.println("Hello World");
    }
}

Plugin Class verklaring

In de META-INF/gradle-plugins moet u een eigenschappenbestand maken dat de eigenschap implementation-class definieert die de implementation-class Plugin identificeert.

In de META-INF/gradle-plugins/testplugin.properties

implementation-class=org.sample.MyPlugin.java

Merk op dat de bestandsnaam van de eigenschappen overeenkomt met de plug-ID .

Hoe het te bouwen en te publiceren

Wijzig het build.gradle bestand door wat informatie toe te voegen om de plug-in in een maven-repo te uploaden:

apply plugin: 'java'
apply plugin: 'maven'

dependencies {
    compile gradleApi()
}

repositories {
    jcenter()
}


group = 'org.sample'
version = '1.0'

uploadArchives {
    repositories {
        mavenDeployer {
        repository(url: mavenLocal().url)
        }
    }
} 

U kunt de Gradle-plug-in bouwen en publiceren naar de Maven-repo die in het bestand plugin/build.gradle gedefinieerd met de volgende opdracht.

$ ./gradlew clean uploadArchives 

Hoe te gebruiken

Om de plug-in te gebruiken, voegt u de build.gradle van uw project toe:

buildscript {
     repositories {
         mavenLocal()
     }
 dependencies {
    classpath group: 'org.sample',    // Defined in the build.gradle of the plugin
              name: 'myplugin',       // Defined by the rootProject.name 
              version: '1.0'
    }
 }

apply plugin: 'testplugin'            // Defined by the properties filename

Vervolgens kunt u de taak oproepen met:

 $ ./gradlew myTask