Gradle 中怎么编写自定义 Task 任务扩展构建流程

轻墨姑娘_6254

轻墨姑娘_6254

2026-08-07

647人浏览

原创

gradle自定义task的核心是继承defaulttask类并用@taskaction标注执行方法,需配合@input/@output声明实现增量构建,支持kotlin/groovy两种dsl注册与配置。

gradle 中怎么编写自定义 task 任务扩展构建流程

在 Gradle 中编写自定义 Task 是扩展构建流程最常用、最直接的方式。核心思路是:定义一个继承 DefaultTask(或实现 Task)的类,用 @TaskAction 标注执行逻辑,并在构建脚本中注册使用。

定义自定义 Task 类(推荐方式)

把任务逻辑封装为独立的类,便于复用、测试和维护。放在 buildSrc/src/main/groovy/(Groovy)或 buildSrc/src/main/kotlin/(Kotlin)下,Gradle 会自动编译并加入构建类路径。

  • 以 Kotlin 为例(buildSrc/src/main/kotlin/HelloTask.kt):
import org.gradle.api.DefaultTask
import org.gradle.api.tasks.TaskAction

abstract class HelloTask : DefaultTask() {
    @get:Input
    abstract val name: Property<string>

    @TaskAction
    fun sayHello() {
        println("Hello, ${name.get()}!")
    }
}</string>
  • 关键点:@Input 标记输入属性,支持增量构建;Property<t></t> 是 Gradle 推荐的类型,比普通字段更安全、可配置化更强。

在 build.gradle(.kts) 中注册并配置任务

注册后即可像内置任务一样调用,支持 DSL 配置、依赖声明、分组等。

js2java
js2java

JavaScript 到 Java 全栈翻译助手,专为前端开发者学习 Java 或快速实现后端业务逻辑而设计。当用户提到以下场景时必须使用此技能: - "帮我把这段 JS 代码转成 Java" - "用 Java 怎么写这个逻辑" - "我习惯用 JS 写,想翻译成 Java" - "教我 Java,我要写后端接...

下载
  • Kotlin DSL(build.gradle.kts):
tasks.register<hellotask>("sayHi") {
    name.set("Gradle")
    group = "custom"
    description = "A simple custom task"
}</hellotask>
  • 执行:./gradlew sayHi → 输出 Hello, Gradle!
  • 可与其他任务建立依赖:sayHi.dependsOn("classes")
  • 支持命令行参数传入:./gradlew sayHi -Pname=World(需配合 project.findProperty() 或额外配置)

快速定义内联 Task(适合简单逻辑)

不写单独类,直接在构建脚本中用闭包或 lambda 定义,适合一次性、轻量逻辑。

  • Groovy(build.gradle):
tasks.register('printTime') {
    doLast {
        println "Build time: ${new Date()}"
    }
}
  • Kotlin DSL(build.gradle.kts):
tasks.register("printTime") {
    doLast {
        println("Build time: ${java.time.LocalDateTime.now()}")
    }
}
  • 注意:doFirst/doLast 是对已有任务追加动作,适用于临时增强;而 @TaskAction 是自定义类的唯一执行入口。

进阶技巧:支持输入输出与增量构建

让自定义任务真正融入 Gradle 的增量构建体系,避免重复执行。

  • 标注输入:@Input(简单值)、@InputFile/@InputDirectory、@Classpath
  • 标注输出:@OutputFile/@OutputDirectory
  • 示例片段:
@get:InputDirectory
abstract val inputDir: DirectoryProperty

@get:OutputDirectory
abstract val outputDir: DirectoryProperty

@TaskAction
fun processFiles() {
    inputDir.get().asFile.walkTopDown()
        .filter { it.name.endsWith(".txt") }
        .forEach { 
            val out = outputDir.get().file(it.relativePath).asFile
            out.parentFile.mkdirs()
            out.writeText(it.readText().uppercase())
        }
}
  • 这样 Gradle 就能自动跳过未变更输入/输出的任务,大幅提升构建效率。

相关文章

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

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

下载

相关标签:

java

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

相关专题

更多
Java Maven/Gradle 构建与依赖管理合集
Java Maven/Gradle 构建与依赖管理合集

系统讲解 Java 项目构建工具的使用与进阶配置,涵盖 Maven 的 POM 文件结构、生命周期(clean/compile/package/install/deploy)与插件机制、依赖范围(compile/provided/test/runtime)与传递依赖管理、多模块聚合与继承、私有 Nexus 仓库发布,以及 Gradle 的 Groovy / Kotlin DSL 语法、Task 自定义与增量构建、依赖版本目录(Versi

2026.05.09

349

25

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

2026.10.16

20

10

OpenJDK怎么配置Java开发环境
OpenJDK怎么配置Java开发环境

怎样用OpenJDK搭建开发环境?本专题介绍版本选择、下载安装、环境变量配置和编译运行验证,帮助你理清JDK的作用及基本配置流程,并通过简单程序检查环境是否可用,为后续项目开发做好准备。

2026.10.16

0

10

OpenJDK怎么部署Java应用
OpenJDK怎么部署Java应用

Java项目开发完成后,怎样部署到目标环境并正常运行?本专题介绍OpenJDK应用部署流程,涵盖运行环境准备、版本兼容检查、应用打包、启动参数配置和日志查看,帮助你理清部署前后的操作顺序,减少环境差异造成的运行问题。

2026.10.16

0

10

Revel框架模板渲染与表单验证
Revel框架模板渲染与表单验证

本专题围绕Revel框架视图层开发,介绍模板语法、变量输出、布局复用、表单提交、参数绑定与验证规则,帮助开发者完成安全规范的页面交互。

2026.10.16

0

15

Revel框架MVC路由与控制器
Revel框架MVC路由与控制器

本专题聚焦Revel框架MVC核心机制,讲解路由定义、控制器Action、参数绑定、请求响应和反向路由,并结合常见场景梳理接口请求处理流程。

2026.10.16

0

15

Revel框架入门与安装配置
Revel框架入门与安装配置

本专题从Revel框架环境搭建讲起,系统介绍命令行工具安装、项目创建、目录结构、配置文件及热代码重载,帮助开发者快速完成首个Go Web应用。

2026.10.16

0

15

Linux 新手先学哪些命令
Linux 新手先学哪些命令

Linux新手命令专题汇集终端基础、文件目录操作、文本查看、软件安装和权限管理等入门文章,帮助按实际任务练习常用命令并建立命令行操作习惯。

2026.10.15

20

20

MySQL 忘记密码怎么办
MySQL 忘记密码怎么办

MySQL忘记密码专题汇集不同版本与系统下的root密码重置方法,覆盖MySQL 5.7、8.0、Mac、Linux及本地集成环境,并提示恢复权限与重新登录的检查步骤。

2026.10.15

20

18

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习