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

Question

我正在尝试编写一个自定义 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

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 中的包含行，它又可以工作了。恢复 settings.gradle，它仍然有效，因为现在“固定”插件在我的 maven 存储库中，重建插件只会用工作版本再次覆盖它。

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

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

Answer 1

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

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