Gradle插件怎么创建自定义依赖配置

云萱酱_1539

云萱酱_1539

2026-11-03

565人浏览

原创

Gradle插件通过project.configurations.create()在apply阶段注册自定义依赖分组,需指定唯一名称、显式继承标准配置(如extendsFrom configurations.api),并设置isVisible=true、isCanBeResolved=true等属性以确保IDE识别与正确解析,避免覆盖AGP预置配置或在错误时机操作。

gradle插件怎么创建自定义依赖配置

Gradle 插件本身不直接“创建依赖配置”,而是通过操作 Project.configurations 来声明和注册新的依赖分组(configuration),供下游项目在 dependencies 块中使用。关键在于:插件必须在 apply(Project) 阶段完成配置注册,且需明确其继承关系与可见性。

configurations.create() 声明新配置

最常用的方式是在插件的 apply 方法里调用 project.configurations.create()。注意不是 createIfNotExists —— 插件应保证幂等,但首次注册必须成功,否则下游 dependencies { myConf '...' } 会报错 “Unknown configuration”。

  • 必须传入唯一 name,如 'apiOnly';不能含空格或特殊字符
  • 建议设置 extendsFrom,例如 extendsFrom configurations.implementation,否则该配置默认不参与编译类路径,仅作声明用途
  • 若希望该配置出现在 IDE 的依赖树中,需额外调用 configuration.isVisible = true 和 configuration.isCanBeResolved = true(可解析)或 isCanBeConsumed = true(可消费)

让配置支持 implementation/api 语义

Android Gradle 插件(AGP)和 Java 插件都预置了标准生命周期配置(如 implementation、api)。自定义配置若想复用其行为(比如自动传递依赖、影响编译/运行时 classpath),不能只靠名字模仿,而要显式继承:

  • configurations.create('myApi') { extendsFrom configurations.api } → 会把该配置下的依赖作为 API 暴露给消费者
  • configurations.create('myRuntimeOnly') { extendsFrom configurations.runtimeOnly } → 仅加入运行时 classpath,不参与编译
  • 错误做法:configurations.create('api') —— 会覆盖 AGP 的原生 api 配置,导致模块间依赖失效

在插件中暴露配置供下游使用

单纯创建配置还不够,下游项目需要能识别并使用它。常见疏漏点:

  • 插件未 apply java 或 com.android.library 等基础插件,导致 configurations 尚未初始化就调用 create(),抛出 IllegalStateException: Configurations cannot be created before project is configured
  • 配置名未文档化,下游写 myconf(小写)而插件注册的是 myConf,报错 Could not find method myconf() for arguments [...]
  • 未设置 configuration.attributes.attribute(Usage.USAGE_ATTRIBUTE, objects.named(Usage.class, Usage.JAVA_API)),导致在 Kotlin Multiplatform 或 Android 的 variant-aware 解析中被忽略

避免与 AGP 冲突的典型场景

在 Android 项目中开发自定义插件时,configurations 行为受 AGP 强约束:

  • AGP 会在 afterEvaluate 阶段重写部分配置的 canBeResolved/canBeConsumed 属性,所以不要在 afterEvaluate 里注册配置,应在 apply 直接注册
  • 不要尝试修改 compileClasspath 或 runtimeClasspath 这类聚合配置,它们由 AGP 动态生成;应继承自 implementation 等稳定基线
  • 如果插件目标是 Android 库模块,务必检查 configurations.findByName('myConf')?.isVisible 是否为 true,否则 Android Studio 不会在 Project Structure → Dependencies 中显示该配置

真正难的不是写几行 create(),而是让配置在 Java/Kotlin/Android/KMM 多种上下文中保持行为一致,并被 IDE 正确索引 —— 这要求你清楚每种构建类型对 Configuration 生命周期和属性的隐式约定。

相关文章

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

389

25

Tailwind CSS 如何制作导航栏和卡片
Tailwind CSS 如何制作导航栏和卡片

用 Tailwind CSS 制作导航栏和卡片,可先搭建语义化结构,再组合 Flex、Grid、间距、圆角与阴影类。这里整理横向导航、移动端菜单、卡片网格及悬停效果的相关文章,帮助你把常见页面组件做得清晰且适配不同屏幕。

2026.11.03

0

17

Tailwind CSS 响应式布局怎么写
Tailwind CSS 响应式布局怎么写

Tailwind CSS 响应式布局通常从移动端样式写起,再用 sm、md、lg 等前缀调整不同屏幕宽度下的网格、间距和导航。本专题整理断点配置、Grid 与 Flex 自适应布局及常见溢出问题,帮助你逐步完成多设备适配。

2026.11.03

0

19

Tailwind CSS 常用类名怎么记
Tailwind CSS 常用类名怎么记

Tailwind CSS 类名很多,先按布局、间距、文字、颜色和状态分组记忆,再通过官方文档检索具体写法。本专题结合类名排序、动态拼接失效、自定义实用类等问题,帮助你建立常用类名的速查方法。

2026.11.03

0

12

码上飞入口地址合集
码上飞入口地址合集

本专题汇总了码上飞(CodeFlying)的官方入口地址合集,涵盖官网主站及网页版在线使用入口,支持注册登录后直接在线体验零代码AI应用生成。同时整理了APP端下载渠道与小程序入口,助你快速访问平台,通过自然语言描述需求即可生成应用、小程序或网站。

2026.11.03

0

10

Uvicorn 报错与问题解决教程
Uvicorn 报错与问题解决教程

本专题汇总了Uvicorn服务器常见问题与报错解决的教程合集,涵盖启动失败、端口占用、模块导入错误、事件循环冲突及热重载失效等典型故障的排查思路。同时整理了多进程与Worker配置、SSL/HTTPS证书报错、跨域与代理配置等实战解决方案,助你快速定位并解决Uvicorn运行中的各类问题。

2026.11.02

20

14

Uvicorn使用教程
Uvicorn使用教程

本专题汇总了Uvicorn使用教程与启动运行指南,涵盖其作为Python ASGI服务器的定位与特点,以及命令行启动(uvicorn main:app --reload)、参数配置(host/port/workers)、程序内嵌运行与Gunicorn结合部署等核心用法。同时整理了热重载调试、日志配置与生产环境部署优化等技巧,助你快速掌握Uvicorn的运行与配置。

2026.11.02

20

17

Uvicorn安装配置教程
Uvicorn安装配置教程

本专题汇总了Uvicorn的安装配置教程与部署指南,涵盖通过pip安装Uvicorn、启动FastAPI/Starlette应用、开发模式热重载(--reload)及多进程工作模式配置等核心操作。同时整理了结合Gunicorn的生产部署方案、HTTPS与反向代理配置及性能调优技巧,助你快速完成Uvicorn服务的安装与上线部署。

2026.11.02

20

17

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

2026.10.28

120

16

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习