Gradle+Groovy提高篇

原创

FunTester 2021-12-13 10:02:10 ©著作权

文章标签 自动化测试自定义 jar java 测试框架 文章分类 Java 后端开发

©著作权归作者所有：来自51CTO博客作者FunTester的原创作品，请联系作者获取转载授权，否则将追究法律责任

创建自定义任务

打开build.gradle文件，并在末尾添加以下内容：


println "1" 

task howdy {  
    println "2" 
    doLast {  
        println "Howdy" 
    }  
}  

println "3"

println "1"    task howdy {      println "2"     doLast {          println "Howdy"     }  }     println "3"

这将演示有关Gradle脚本如何工作的一些信息。使用以下命令运行它：

./gradlew howdy

您将看到（省略了一些多余的行）：


> Configure project :
1
2
3

> Task :howdy
Howdy

> Configure project :123 > Task :howdyHowdy

在这里，Configure project任务将生成并运行生成脚本。在Gradle执行Configure project任务时，它会执行以下操作：它打第一个println并打印“1”它找到要执行的

howdy任务定义块，一个闭包，并显示“2”。请注意，它不会执行doLast关闭操作，因此尚未打印“Howdy”。它继续执行脚本，直到第四个println，然后打印“3”。至此，构建脚本本身已完成对构建环境的配置。下一步是执行命令行中指定的所有任务，在本例中为howdy任务。这是task.doLast{}执行块的地方，因此您会在输出中看到“Howdy”字样。doLast是该块的别称；它的真正含义是类似于“任务操作”，而外部块是任务配置。


task howdy {  
    // 始终在初始构建脚本配置期间执行
    doLast {  
        // 仅在任务本身被调用时执行 
    }
    // 始终在初始构建脚本配置期间执行
}

task howdy {      // 始终在初始构建脚本配置期间执行    doLast {          // 仅在任务本身被调用时执行     }    // 始终在初始构建脚本配置期间执行}

使用Graovy DSL根据Gradle文档定义任务的各种方法如下：


task taskName
task taskName { configure closure }
task taskName(type: SomeType)
task taskName(type: SomeType) { configure closure }

task taskNametask taskName { configure closure }task taskName(type: SomeType)task taskName(type: SomeType) { configure closure }

只是为了锤炼，在运行构建脚本时立即执行“配置闭包”，而在doLast专门执行任务时执行在配置闭包中定义的闭包。将第二个自定义任务添加到build.gradle文件：


task partner {  
    println "4" 
    doLast {  
        println "Partner" 
    }  
}  
println "5"

task partner {      println "4"     doLast {          println "Partner"     }  }  println "5"

如果您./gradlew partner看到的是：


> Configure project :
1
2
3
4
5

> Task :partner
Partner

> Configure project :12345 > Task :partnerPartner

如果您希望一个自定义任务依赖另一个任务怎么办？这简单。build.gradle 在定义两个自定义任务之后，将以下行添加到文件中的某处。partner.dependsOn howdy并运行：./gradlew partner


...
> Task :howdy
Howdy

> Task :partner
Partner

...> Task :howdyHowdy > Task :partnerPartner

您也可以使用task属性表示类似的关系finalizedBy。如果将dependsOn行替换为：

howdy.finalizedBy partner并运行：/gradlew howdy。


...
> Task :howdy
Howdy

> Task :partner
Partner

...> Task :howdyHowdy > Task :partnerPartner

您得到相同的输出。当然，他们表达不同的关系。

关于任务的最后一点：在实践中，您很少编写自定义任务来说诸如“Howdy Partner”之类的东西（我很难相信，我知道）。实际上，通常您会覆盖已经定义的任务类型。例如，Gradle定义了Copy一个将文件从一个位置复制到另一个位置的任务。

这是一个将文档复制到构建目标的示例：


task copyDocs(type: Copy) {
    from 'src/main/doc'
    into 'build/target/doc'
}

task copyDocs(type: Copy) {    from 'src/main/doc'    into 'build/target/doc'}

当您意识到build.gradle文件实际上是一个Groovy脚本时，就可以使用Groovy和Gradle的真正功能，如果需要，您可以执行任意代码来过滤和转换这些文件。下面的任务转换每个副本文件并排除.DS_Store文件。DSL非常灵活。您可以使用from和多个块excludes，也可以执行诸如重命名文件或专门包含文件之类的操作。再次查看“复制”任务的文档以获取更完整的想法。


task copyDocs(type: Copy) {
    from 'src/main/doc'
    into 'build/target/doc'
    eachFile { file ->
        doSomething(file);
    }
    exclude '**/.DS_Store'
}

task copyDocs(type: Copy) {    from 'src/main/doc'    into 'build/target/doc'    eachFile { file ->        doSomething(file);    }    exclude '**/.DS_Store'}

我在Gradle Jar或中最重视War的任务是负责打包.jar和.war文件以进行最终分发的任务。像Copy任务一样，他们具有定制过程的非常开放的能力，这对于需要定制最终产品的项目可能是巨大的帮助。实际上，您可以使用Gradle DSL来完全控制打包过程的各个方面。Spring Boot插件的bootJar和bootWar任务继承自Jar和War任务，因此它们包括所有配置选项，包括复制，过滤和修改文件的能力以及自定义清单的能力。

提高篇到此结束，大家要是有兴趣欢迎去Gradle官网查看API文档，非常有帮助。