Java 中怎么在 Gradle 中编写自定义 Task 与 Groovy 脚本逻辑

大墨同学_6229

大墨同学_6229

2026-08-14

110人浏览

原创

gradle 中编写自定义 task 和嵌入 groovy 脚本逻辑,核心是利用其 dsl 扩展构建行为:可用 tasks.register() 定义延迟执行的 task,通过 @inputfile/@outputfile 支持增量构建,直接在 build.gradle 中写 groovy 代码(如变量、方法、配置),复杂逻辑可提取至 buildsrc 或 external script 复用。

java 中怎么在 gradle 中编写自定义 task 与 groovy 脚本逻辑

在 Gradle 中编写自定义 Task 和嵌入 Groovy 脚本逻辑,核心是利用 Gradle 的 DSL(基于 Groovy 或 Kotlin)扩展构建行为。Java 项目中通常用 Groovy 编写的 build.gradle,天然支持直接写 Groovy 代码,无需额外配置。

定义一个简单的自定义 Task

Gradle 提供了多种方式声明 Task,最常用的是 tasks.register()(推荐,延迟执行)或 task 闭包(旧式,立即配置)。

示例:定义一个打印当前时间的 Task

tasks.register('printTime') {
    doLast {
        println "当前时间: ${new Date()}"
    }
}

运行:./gradlew printTime 即可执行。

注意:doLast 是 Task 执行阶段的动作;若需在配置阶段运行,用 doFirst 或直接写在闭包内(但不推荐含副作用的逻辑)。

创建带输入输出、支持增量构建的 Task

让 Task 可被跳过(如输入未变),需声明 inputs 和 outputs,并继承 DefaultTask 或使用注解。

deep-java-review
deep-java-review

Java项目代码review工具。分析Git变更+完整调用链路上下文,推断业务需求,进行多维度评分和分类汇总,生成完整PRD文档。包含细粒度Java代码审查清单(Null安全、异常处理、Streams、并发、equals/hashCode、资源管理、API设计、性能、MyBatis/ORM、事务边界、SQL/DD...

下载

示例:一个将文本文件转为大写的简单转换 Task

class UppercaseTask extends DefaultTask {
    @InputFile
    final RegularFileProperty inputFile = project.objects.fileProperty()

    @OutputFile
    final RegularFileProperty outputFile = project.objects.fileProperty()

    @TaskAction
    void process() {
        def content = inputFile.get().asFile.text
        outputFile.get().asFile.write content.toUpperCase()
    }
}

tasks.register('uppercase', UppercaseTask) {
    inputFile.set(file('src/main/resources/input.txt'))
    outputFile.set(file('build/output.txt'))
}

这样 Gradle 就能自动判断是否跳过该 Task —— 只要 input.txt 和 output.txt 时间戳/内容未变,执行 uppercase 时会显示 UP-TO-DATE。

在 build.gradle 中直接写 Groovy 脚本逻辑

Gradle 构建脚本本身就是 Groovy(或 Kotlin)脚本,可直接调用 Groovy API、定义变量、方法、甚至类。

  • 定义本地变量:def versionName = '1.2.3'
  • 写工具方法:def parseVersion = { String v -> v.split('\.').collect { it.toInteger() } }
  • 读取外部配置:def props = new Properties(); file('gradle.properties').withInputStream { props.load(it) }
  • 动态配置依赖:dependencies { implementation "com.example:lib:$versionName" }

这些逻辑放在 build.gradle 任意位置(只要不在 Task 内部且需提前求值)都有效。注意避免在 doLast 外直接执行耗时操作,否则每次运行 Gradle 都会执行(影响性能)。

复用逻辑:提取到 buildSrc 或独立脚本

当 Groovy 逻辑变复杂,建议移出主脚本:

  • buildSrc:在项目根目录建 buildSrc/src/main/groovy/,放自定义 Task 类或工具类,会自动编译进构建 classpath,所有 build.gradle 可直接 import 使用。
  • external script:用 apply from: 'scripts/utils.gradle' 引入外部 Groovy 脚本,适合共享配置片段。

例如 scripts/version.gradle 中写:ext.appVersion = project.hasProperty('release') ? '2.0.0' : '2.0.0-SNAPSHOT',然后在主脚本中 apply from: 'scripts/version.gradle',再用 appVersion。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9517

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

6662

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

5932

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1044

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

868

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1236

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2489

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19831

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1135

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习