讲师中心 微信公众号
AI工具推荐 视频效率加速

Gradle插件怎么定义可配置的扩展

轻瑶大大_3089

轻瑶大大_3089

发布时间:2026-11-07 12:45:13

|

622人浏览过

|

来源于php中文网

原创

Gradle插件扩展必须在Plugin.apply()开头注册,否则DSL配置块不生效;嵌套配置需用Provider+@Nested;字段须为Property类型并避免业务逻辑。

gradle插件怎么定义可配置的扩展

Gradle插件的扩展(Extension)不是“加个类就能用”,而是必须和 project.extensions 的契约对齐,否则配置块(如 myPlugin { ... })会被解析却完全不生效。

extension 实例必须在 project 初始化早期注册

很多人把 extensions.create() 放在 project.afterEvaluate 或自定义 task 里,这是错的——此时 DSL 闭包早已被跳过,不会绑定到任何实例上。

  • extensions.create("myPlugin", MyExtension.class) 必须在 Plugin.apply(Project) 方法体最开始就调用
  • 不能延迟到 afterEvaluate、tasks.register 或任意构建逻辑之后
  • Gradle 在解析 build.gradle 时,会按顺序查找同名 extension;如果没提前注册,闭包直接丢弃,无报错也无日志

嵌套 extension 要用 Provider + nested() 声明

想支持类似 myPlugin { options { timeout = 5000 } } 这种结构?别手写 setter,得靠 Gradle 的类型安全嵌套机制。

  • 主 extension 类中字段必须声明为 Provider<nestedoptions></nestedoptions>,不能是 NestedOptions 实例
  • 注册时用 extensions.create("myPlugin", MyExtension.class).options = objects.newInstance(NestedOptions.class) 是错的——破坏延迟求值
  • 正确方式:在 MyExtension 构造器里调用 objects.domainObjectSet(NestedOptions.class) 或用 objects.newInstance() + nested() 配合 @Nested 注解(Gradle 8.5+ 推荐)
  • 否则 Kotlin DSL 会报 Unresolved reference: options,Groovy DSL 会静默失败

配置块闭包绑定靠 ConfigurationAction,不是反射

你写的 myPlugin { outputDir = "out" } 不是靠 Groovy 的 setOutputDir() 反射调用生效的,而是 Gradle 内部通过 ConfigurationAction 把闭包委托给 extension 实例。

  • extension 类所有可配置字段必须是 public、有 getter/setter(Kotlin 中需用 var + 默认 getter/setter)
  • 字段类型要能被 Gradle 的 Property 系统识别:优先用 Property<string></string>、ListProperty<file></file>,而非原始类型
  • 如果用了 @Input / @OutputDirectory 等注解,必须搭配 Provider 使用,否则配置缓存(--configuration-cache)会失败
  • 避免在 extension 类里做实际逻辑:它只负责承载配置,不负责执行;执行应交给 task 或 project.afterEvaluate 中的 hook

最容易被忽略的一点:extension 类本身不能有无参构造函数以外的构造参数。Gradle 实例化它时不会传参,所有初始化逻辑(比如默认值)必须放在字段声明处或 ObjectsFactory 创建时完成。

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

花生AI
花生AI Hot

一款AI视频创作工具,主要用于B站推出的AI视频创作工具,适合需要提升相关任务效率的用户。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

相关专题

更多
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

389

2026.05.09

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

0

2026.11.06

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

0

2026.11.06

Postman接口请求发送教程
Postman接口请求发送教程

详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。

0

2026.11.06

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

20

2026.11.05

DBeaver安全防护教程大全
DBeaver安全防护教程大全

DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。

20

2026.11.05

DBeaver连接创建与配置教程
DBeaver连接创建与配置教程

本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。

20

2026.11.04

XORM框架结构体映射与表结构同步
XORM框架结构体映射与表结构同步

本专题围绕XORM框架的结构体映射展开,说明表名与字段的命名策略、xorm标签常用属性、主键自增与时间字段自动填充,并演示Sync2自动建表、增量字段升级、索引声明与反向生成结构体的完整流程。

20

2026.11.04

XORM框架安装配置与数据库连接
XORM框架安装配置与数据库连接

本专题聚焦XORM框架的配置与连接环节,拆解MySQL、PostgreSQL、SQLite、SQL Server的DSN写法与驱动选择,讲清连接池参数、多数据源拆分、读写分离与超时重连的处理方式,并补充容器与兼容数据库的适配经验。

20

2026.11.04

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn