Gradle插件任务怎么支持构建缓存

夜婷同学_1480

夜婷同学_1480

2026-10-22

562人浏览

原创

自定义 gradle task 必须显式声明 inputs/outputs 才能启用构建缓存,否则会被跳过;需用 @cacheabletask 标注类、避免可变集合与隐式输入,并通过 build scan 验证缓存状态。

gradle插件任务怎么支持构建缓存

自定义 Gradle Task 必须显式声明 inputs/outputs

Gradle 构建缓存不会自动识别你写的 Task 是否可缓存——它只对“输入确定、输出明确、无副作用”的任务启用缓存。如果你写了一个自定义 task(比如打包配置文件、生成代码),默认情况下它会被跳过缓存,每次构建都重新执行。

必须手动用 inputs 和 outputs 告诉 Gradle:“这些是影响结果的输入”“这是本次任务真正产出的文件”。否则 Gradle 会认为该 task 不可缓存,日志里会出现 Skipping task ':myTask' as it has no outputs 或类似提示。

  • inputs.files("src/main/config") —— 声明目录为输入,内容变更即触发重执行
  • inputs.property("version", project.version) —— 声明字符串属性为输入,避免因版本号变化却未感知
  • outputs.dir(layout.buildDirectory.dir("generated")) —— 用 layout.buildDirectory 而不是硬拼 "$buildDir/generated",否则配置缓存会失败
  • 不要在 task 动作里调用 new Date()、System.currentTimeMillis() 或读取未声明的环境变量,这会让缓存键不稳定

使用 Kotlin DSL 定义 task 时避免 mutable 集合

在 build.gradle.kts 中用 mutableListOf 或 mutableMapOf 收集 task 配置,会导致配置缓存序列化失败——因为 mutable 集合对象无法被安全地冻结和还原。Gradle 会报错类似 Cannot serialize object of type java.util.ArrayList。

正确做法是全部改用不可变容器,并在注册 task 时一次性声明清楚:

tasks.register<mycodegentask>("generateApi") {
    inputs.property("apiSpec", layout.projectDirectory.file("openapi.yaml"))
    outputs.dir(layout.buildDirectory.dir("generated/src"))
    // ✅ 不要在这里做 list.add(...) 或 map.put(...)
}</mycodegentask>

如果逻辑复杂,把参数组装提前到 task 注册前,用 val 绑定好再传入,而不是在 task 执行时动态构造。

继承 DefaultTask 时需标注 @CacheableTask

当你写一个自定义 task 类(比如 class ZipAssetsTask : DefaultTask()),即使已声明 inputs/outputs,Gradle 默认仍不认为它可缓存。必须加上 @CacheableTask 注解,否则构建缓存完全忽略这个类。

PaperXie智能写作
PaperXie智能写作

PaperXie智能写作是一款AI论文写作工具,AI学术写作辅助工具,覆盖全流程服务。

下载

注意两点:

  • 注解必须加在 class 上,不是方法上;Kotlin 中要加 @get:CacheableTask(因注解目标是 getter)
  • 类中所有非 transient 字段,只要参与逻辑,都应通过 inputs/outputs 显式暴露,否则可能造成缓存误命中
  • 避免在 task 类构造函数里做 I/O 或状态初始化,构造阶段不参与缓存判定,但会影响配置阶段稳定性

插件 apply 后注册的 task 容易漏掉缓存声明

很多第三方插件(比如 com.github.johnrengelman.shadow)或自研插件会在 apply 时动态注册 task。这类 task 很容易没设置 inputs/outputs,尤其当它基于 Copy 或 Exec 等内置 task 扩展而来时。

验证方式很简单:执行 ./gradlew build --dry-run,看目标 task 是否标有 FROM-CACHE;或者运行 ./gradlew build --scan,在 Build Scan 的 Task Execution 页面里查缓存状态。

修复建议:

  • 在插件 apply 后立即对关键 task 补充声明:tasks.named("shadowJar") { outputs.file(layout.buildDirectory.file("libs/shadow.jar")) }
  • 优先用 tasks.withType<shadowjar></shadowjar> 而不是 tasks.getByName,更安全且兼容配置缓存
  • 如果插件本身不维护缓存兼容性(如某些老版本 kotlin-serialization 插件),考虑升级或换用官方推荐替代方案

最常被忽略的是 task 的“隐式输入”:比如依赖了某个 project.property 却没用 inputs.property 声明,缓存就会在 property 变更后继续复用旧结果——这种 bug 很难排查,只能靠严格声明兜底。

相关文章

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

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

下载

相关标签:

gradle gradle插件开发

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系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

369

25

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

2026.10.22

0

11

Gradle Wrapper配置教程
Gradle Wrapper配置教程

本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。

2026.10.22

0

10

Golangci-lint检查器使用教程
Golangci-lint检查器使用教程

本专题整理Golangci-lint常用Linters的用途与配置方法,覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查,帮助项目合理选规则。

2026.10.22

0

15

Gradle怎么构建Java项目
Gradle怎么构建Java项目

本专题介绍Gradle Java项目构建方法,涵盖Java插件配置、依赖声明、源码编译、测试执行和打包检查,帮助你理解各阶段的任务关系,逐步完成项目构建。

2026.10.22

0

10

PHP时间戳漏洞修复教程
PHP时间戳漏洞修复教程

本专题汇总PHP常见时间戳漏洞,包括2038年溢出、时区漂移、时间戳伪造、重放攻击、时间盲注与日志审计失效等,并给出升级64位环境、使用 DateTimeImmutable、统一UTC、严格超时校验、预处理绑定、hash_equals 比对等修复方案,帮助开发者快速排查和加固时间相关代码。

2026.10.22

0

25

Golangci-lint配置文件与规则设置
Golangci-lint配置文件与规则设置

本专题聚焦Golangci-lint YAML配置文件,讲清运行参数、规则启停、目录排除、问题过滤及严重级别设置,便于团队统一检查标准。

2026.10.22

0

15

Golangci-lint安装与入门教程
Golangci-lint安装与入门教程

本专题讲解Golangci-lint的安装、初始化、基础命令和首次代码检查,覆盖本地环境、Docker及多平台用法,帮助Go开发者快速上手。

2026.10.22

0

15

PHP2Shell高危漏洞修复教程
PHP2Shell高危漏洞修复教程

PHP2Shell漏洞是什么,哪些PHP版本和运行环境会受到影响,服务器应该如何检测与修复?本专题提供版本自查脚本、Linux与Docker升级命令、PHP-FPM和Apache排查步骤,以及修复验证、临时缓解和应急响应方案。

2026.10.22

40

12

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Gradle 9 主版本升级指南
Gradle 9 主版本升级指南

共0课时 | 0人学习

Gradle 安全最佳实践
Gradle 安全最佳实践

共0课时 | 0人学习

Gradle 依赖校验手册
Gradle 依赖校验手册

共0课时 | 0人学习