使用Java创建Gradle自定义插件

Question

我正在用Gradle创建一个构建过程，我想提供一个使用Java代码的插件。Gradle
插件文档 说
这是可能的：

您可以使用任何喜欢的语言来实现自定义插件，前提是该实现最终会编译为字节码。对于此处的示例，我们将使用Groovy作为实现语言。如果需要，可以改用Java或Scala。

但是，经过数小时的谷歌搜索和阅读之后，我还没有找到有关如何使用Java创建Gradle自定义插件的任何说明。似乎您可以在以下目录中为其创建代码：

<rootProjectDir>/buildSrc/src/main/java/
  MyGradlePlugin.java
  MyGradleTasks.java

但是问题就变成了：

1. 如何在Java中实现插件类和任务以与Gradle兼容？
2. 如何使Gradle识别Java类和任务，以便可以在构建中使用它们？

您可以像对Groovy一样引用插件类吗？

src/main/resources/META-INF/gradle-plugins/myjavaplugin.properties
implementation-class=org.me.MyGradlePlugin

我意识到我可以使用project.javaexec或调用Java代码JavaExec，但是我担心这会使我的构建过程变得不那么容易移植。

Answer 1

这是一个基本的，独立的，基于Java的Gradle插件，以及使其工作的步骤：

1. 确保Gradle 1.6或更高版本并安装了Java JDK
2. 使用指定的目录结构在下面创建这些文件
3. 将<projectRoot>/plugin目录更改为目录
4. 执行插件构建：$ gradle uploadArchives此步骤（非常重要）将编译Java代码并将其放入本地Maven存储库（../repo）中。
5. 现在，通过将目录更改为 <projectRoot>/consumer
6. 执行依赖于插件的脚本： $ gradle checkitout

Java类

projectRoot /插件/src/main/java/org/joefernandez/gradle/MyJavaPlugin.java

package org.joefernandez.gradle;

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

public class MyJavaPlugin implements Plugin<Project> {

    @Override
    public void apply(Project target) {
        target.task("javaTask");
    }

}

projectRoot /插件/src/main/java/org/joefernandez/gradle/MyJavaTask.java

package org.joefernandez.gradle;

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

public class MyJavaTask extends DefaultTask {

    @TaskAction
    public void javaTask() {
        System.out.println("Hello from MyJavaTask");
    }

}

插件类声明

projectRoot /插件/src/main/resources/META-INF/gradle-plugins/test-
plugin.properties

implementation-class=org.joefernandez.gradle.MyJavaPlugin

插件构建脚本

请注意 uploadArchives 任务：您必须运行此任务以使插件可用于使用者脚本。

projectRoot /插件/build.gradle

apply plugin: 'java'

dependencies {
    compile gradleApi()
}

apply plugin: 'maven'

repositories {
    mavenCentral()
}

dependencies {
    testCompile 'junit:junit:4.11'
}

group = 'org.joefernandez'
version = '1.0-SNAPSHOT'

uploadArchives {
    repositories {
        mavenDeployer {
            repository(url: uri('../repo'))
        }
    }
}

插件设置

projectRoot /插件/settings.gradle

rootProject.name = 'MyJavaPlugin'

根脚本

projectRoot / build.gradle

apply plugin: 'java'

dependencies {
    compile gradleApi()
}

消费者脚本

projectRoot /消费者/build.gradle

buildscript {
    repositories {
        maven {
            url uri('../repo')
        }
    }
    dependencies {
        classpath group: 'org.joefernandez',
                   name: 'MyJavaPlugin',
                version: '1.0-SNAPSHOT'
    }
}
apply plugin: 'test-plugin'

task checkitout(type: org.joefernandez.gradle.MyJavaTask) {
    println("running consumer task!")
}