Gradle自定义任务类外部化失败及buildSrc方案报错求助

一、外部化自定义任务类到Gradle脚本文件的问题 #

问题场景 #

将自定义任务类定义在独立的mytask.gradle文件中，通过apply from引入主build.gradle后，主脚本无法识别该任务类，导致构建失败。

解决方法 #

在mytask.gradle中定义任务类后，通过ext属性将其导出，让主脚本可以访问：

修改mytask.gradle：

class doSomethingTask extends DefaultTask {
    @Input
    String someData

    @TaskAction
    void taskAction() {
        // 实现任务逻辑
    }
}
// 将任务类导出到ext命名空间
ext.doSomethingTask = doSomethingTask

主build.gradle中使用方式：

apply from: 'mytask.gradle'
task doSomething(type: ext.doSomethingTask) {
    dependsOn(clean, build)
    someData = "$mydata"
}

二、buildSrc方案的错误修正 #

问题场景 #

使用buildSrc存放自定义任务类时，出现错误：Could not get unknown property 'PostProcessOpenApiCodeTask3' for project ':buildSrc'，配置后无法正常运行任务。

错误排查与修正步骤 #

1. 修正拼写错误

   • 类文件名MyTaks3.groovy存在拼写错误（Taks应为Task），需改为MyTask3.groovy，确保文件名与类名一致。
   • 错误信息中的PostProcessOpenApiCodeTask3与定义的MyTask3不符，需检查代码中是否存在类名引用错误。

2. 调整buildSrc配置
   buildSrc是主项目的构建依赖模块，不应在其内部的build.gradle中注册主项目任务。正确配置如下：

   • buildSrc/build.gradle仅需配置Groovy依赖与仓库：

     plugins {
         id 'groovy'
     }
     
     repositories {
         mavenCentral()
     }
     
     dependencies {
         implementation gradleApi()
         implementation localGroovy()
     }
     

   • 自定义任务类buildSrc/src/main/groovy/MyTask3.groovy：

     import org.gradle.api.DefaultTask
     import org.gradle.api.tasks.TaskAction
     import org.gradle.api.tasks.Input
     
     class MyTask3 extends DefaultTask {
         @Input String name
     
         @TaskAction
         void taskAction(){
             // 任务逻辑
             println "执行任务：${name}"
         }
     }
     

   • 在主项目的build.gradle中注册任务：

     task myTask3(type: MyTask3) {
         name = "自定义任务测试"
     }
     

3. Gradle 5.5兼容处理
   Gradle 5.5要求buildSrc明确配置仓库与依赖，添加mavenCentral()仓库和gradleApi()、localGroovy()依赖，确保Gradle API能正常引入。

内容的提问来源于stack exchange，提问作者Oscar Besga Panel