gradle自定义任务类使其无法编译

问题描述

我试图编写一个自定义的Gradle任务类，并在另一个子项目中使用它。我在将构建版本捆绑在一起时遇到问题。

在此示例中，我将子项目命名为“ a”（对于应用程序）和“ p”（对于插件，尽管我不使用插件对象，而只是向构建脚本提供任务类）。

settings.gradle

include 'p'
include 'a'

p / build.gradle

apply plugin: 'java'
apply plugin: 'groovy'
apply plugin: 'maven-publish'

group 'test'
version '1.0'

publishing {
    publications {
        mavenJava(MavenPublication) {
            from components.java
        }
    }
}

dependencies {
    implementation gradleApi()
    implementation localGroovy()
}

p / src / main / groovy / p / MyTask.groovy

package p

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

class MyTask extends DefaultTask {
    @TaskAction
    void run() {
        System.out.println('yay!');
    }
}

a / build.gradle

buildscript {

    repositories {
        mavenLocal()
    }

    dependencies {
        classpath 'test:p:1.0'
    }

}

group = 'test'
version = '1.0'

apply plugin: 'java'

task myTask(type: p.MyTask) {
}

“插件”是通过在p文件夹中运行来构建的：

../gradlew clean build publishToMavenLocal

在文件夹内：

../gradlew myTask

打印“是！”

但是，在开发过程中会发生错误。当我在MyTask中模拟错误时：

MyTask() {
    throw new RuntimeException("an error");
}

并构建插件（在文件夹p中）：

../gradlew clean build publishToMavenLocal

它按预期失败。

现在，我通过再次删除损坏的构造函数来“修复”该错误，然后在文件夹p中进行重建：

../gradlew clean build publishToMavenLocal

但是此命令失败，并出现相同的错误。

据我了解，原因是：

• 损坏的插件在我的本地Maven存储库中
• 尝试构建插件会检测到父文件夹中的settings.gradle
• gradle尝试配置从settings.gradle引用的所有项目
• 这将加载损坏的插件
• 构建失败

要验证，我将settings.gradle中的a的包含行注释掉，它再次起作用。还原settings.gradle，它仍然可以工作，因为现在“固定”插件已在我的Maven存储库中，并且重建该插件只会用工作版本再次覆盖它。

最重要的是，我的自定义任务类（或自定义插件或任何其他buildscript代码）中的错误有可能使其自身无法编译，其解决方法是编辑或临时重命名settings.gradle。项目变得越复杂，则变得越麻烦：如果插件代码本身包含多个子项目，重命名将不起作用，甚至注释掉也将成为“注释正确的行”。

解决此问题的预期方法是什么？

解决方法

单个（多个）项目的复杂逻辑最好在buildSrc中组织。在大多数情况下，您可以将其视为正常的子项目，但只能将其视为构建类路径。您在此处创建的插件和任务可自动用于多项目中的所有项目。

如果出于某种原因，您宁愿继续使用本地Maven存储库，则可以考虑发布具有版本号的稳定版本的插件，以便于回滚。