gradle 自定义任务 class 使其自身不可编译

Question

我正在尝试编写自定义 Gradle 任务 class 并在另一个子项目中使用它。我在将构建捆绑在一起时遇到问题。

在这个例子中，我将子项目命名为“a”（对于应用程序）和“p”（对于插件，虽然我没有使用插件对象，只是提供了一个任务 class构建脚本）。

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

a文件夹内：

../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 仓库中，重建插件将再次用工作版本覆盖它。

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

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

Answer 1

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

中的所有项目

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

gradle 自定义任务 class 使其自身不可编译

gradle custom task class makes itself uncompilable

plugins

build-script

multi-project

gradle

gradle-multi-project-build