gradle
Gradle Plugins

Enkel gradplugin från `buildSrc`

Enkelt exempel på hur du skapar en anpassad plugin och DSL för ditt gradleprojekt.
Detta exempel använder ett av de tre möjliga sätten att skapa plugins.
De tre sätten är:

• i kö
• buildSrc
• fristående plugins

Detta exempel visar att du skapar ett plugin från buildSrc- mappen.

Detta prov skapar fem filer

// 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 / resurser / META-INF / gradle-plugins / sample.properties

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

Med denna inställning kan vi se värdena som anropas av den som ringer i ditt DSL-block

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

Hur man skriver ett fristående plugin

För att skapa en anpassad fristående Gradle-plugin med java (du kan också använda Groovy) måste du skapa en struktur som denna:

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

Konfigurering av inställningsgrad

I filen build.gradle definierar du ditt projekt.

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

dependencies {
    compile gradleApi()
} 

java plugin kommer att användas för att skriva java-kod.
gradleApi() -beroende ger oss alla metoder och egenskaper som behövs för att skapa ett Gradle-plugin.

I filen settings.gradle :

rootProject.name = 'myplugin' 

Den definierar artefakt-iden i Maven.
Om settings.gradle filen inte finns i plugin-katalogen kommer standardvärdet att vara katalogens namn.

Skapa plugin

Definiera en klass i src/main/java/org/sample/MyPlugin.java implementerar Plugin gränssnittet.

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

} 

Definiera uppgiften som utökar klassen DefaultTask :

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 Classdeklaration

I META-INF/gradle-plugins mappen måste du skapa en egenskapsfil som definierar implementation-class som identifierar Plugin-implementeringsklassen.

I META-INF/gradle-plugins/testplugin.properties

implementation-class=org.sample.MyPlugin.java

Observera att egenskaperna för filnamn stämmer med plugin-id .

Hur man bygger och publicerar det

Ändra build.gradle filen och build.gradle till lite info för att ladda upp plugin i en maven repo:

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

dependencies {
    compile gradleApi()
}

repositories {
    jcenter()
}


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

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

Du kan bygga och publicera Gradle-plugin-programmet till Maven-repo som definieras i plugin/build.gradle filen med följande kommando.

$ ./gradlew clean uploadArchives 

Hur man använder det

För att använda plugin-lägg till i build.gradle för ditt projekt:

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

Sedan kan du ringa uppgiften med:

 $ ./gradlew myTask