gradle
Gradle Plugins

Einfaches Gradle-Plugin von `buildSrc`

Ein einfaches Beispiel, wie Sie ein benutzerdefiniertes Plugin und DSL für Ihr Gradle-Projekt erstellen.
Dieses Beispiel verwendet eine der drei Möglichkeiten, Plugins zu erstellen.
Die drei Möglichkeiten sind:

• in der Reihe
• buildSrc
• eigenständige Plugins

Dieses Beispiel zeigt das Erstellen eines Plugins aus dem Ordner buildSrc .

In diesem Beispiel werden fünf Dateien erstellt

// 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 / so / 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 / so / 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

Mit diesem Setup können wir die vom Anrufer in Ihrem DSL-Block gelieferten Werte sehen

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

Wie schreibe ich ein eigenständiges Plugin?

Um ein benutzerdefiniertes eigenständiges Gradle-Plug-In mit Java zu erstellen (Sie können auch Groovy verwenden), müssen Sie eine Struktur wie folgt erstellen:

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

Richten Sie die Konfiguration ein

In der Datei build.gradle definieren Sie Ihr Projekt.

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

dependencies {
    compile gradleApi()
} 

Das java Plugin wird zum Schreiben von Java-Code verwendet.
Die Abhängigkeit von gradleApi() gibt uns alle Methoden und Eigenschaften, die zum Erstellen eines Gradle-Plugins erforderlich sind.

In der Datei " settings.gradle ":

rootProject.name = 'myplugin' 

Es definiert die Artefakt-ID in Maven.
Wenn die Datei " settings.gradle " nicht im Plugin-Verzeichnis vorhanden ist, ist der Standardwert der Name des Verzeichnisses.

Erstellen Sie das Plugin

Definieren Sie eine Klasse in der src/main/java/org/sample/MyPlugin.java die die Plugin Schnittstelle implementiert.

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);
    }

} 

Definieren Sie die Task, die die DefaultTask Klasse erweitert:

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");
    }
}

Deklaration der Plugin-Klasse

Im Ordner META-INF/gradle-plugins Sie eine Eigenschaftendatei erstellen, die implementation-class Eigenschaft der implementation-class definiert, die die implementation-class META-INF/gradle-plugins identifiziert.

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

implementation-class=org.sample.MyPlugin.java

Beachten Sie, dass der Eigenschaftendateiname mit der Plugin-ID übereinstimmt .

Wie man es baut und veröffentlicht

Ändern Sie die Datei build.gradle fügen Sie einige Informationen hinzu, um das Plugin in einem Maven-Repo hochzuladen:

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

dependencies {
    compile gradleApi()
}

repositories {
    jcenter()
}


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

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

Sie können das Gradle-Plug-in mit dem folgenden Befehl erstellen und im Maven-Repo veröffentlichen, das in der Datei plugin/build.gradle definiert ist.

$ ./gradlew clean uploadArchives 

Wie man es benutzt

So verwenden Sie das Plugin-Add im build.gradle Ihres Projekts:

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

Dann können Sie die Aufgabe aufrufen mit:

 $ ./gradlew myTask