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

Gradle怎么开发Settings插件

风婷姑娘_1262

风婷姑娘_1262

发布时间:2026-10-28 08:49:31

|

638人浏览过

|

来源于php中文网

原创

Settings插件必须用Kotlin DSL(settings.gradle.kts)编写,本质是封装复用的配置逻辑为函数或类并在顶层调用,不支持传统插件机制;唯一稳定复用方式是apply(from = "...")加载外部.kts脚本。

gradle怎么开发settings插件

Settings插件必须用 Kotlin DSL(settings.gradle.kts)编写

Gradle 的 Settings 对象本身不支持传统插件机制——你不能像对 Project 那样 apply 一个二进制插件到 Settings。所谓“Settings 插件”,本质是把复用的 settings 配置逻辑封装成 Kotlin 函数或类,然后在 settings.gradle.kts 中调用。

这意味着:没有 Plugin<settings></settings> 接口实现、没有 apply(plugin = "...")、也不支持通过 plugins { id("...") } 块引入。

  • 所有逻辑必须在 settings.gradle.kts 文件顶层作用域或其导入的 Kotlin 脚本中执行
  • 若想复用,只能靠 includeBuild 引入另一个构建(含 settings.gradle.kts),或通过 apply(from = "...") 加载外部 .kts 脚本
  • Gradle 8.4+ 支持 settings.pluginManagement { ... },但仅用于配置插件仓库和版本,不等于“应用插件”

apply(from = "...") 是最实用的复用方式

把通用 settings 逻辑(如统一 include 模块、动态解析目录结构、设置构建缓存地址)抽成独立 .kts 文件,再用 apply(from = "...") 加载——这是目前最稳定、最易调试的做法。

示例:gradle/settings-conventions.kts

rootProject.name = "my-project"
include(":app", ":core", ":data")
enableFeaturePreview("VERSION_CATALOGS")

在 settings.gradle.kts 中:

pluginManagement { repositories { mavenCentral() } }
apply(from = "$rootDir/gradle/settings-conventions.kts")
  • 路径必须是绝对路径或相对于 settings.gradle.kts 的相对路径;$rootDir 在 apply(from = ...) 中不可用,得写成 file("../gradle/settings-conventions.kts") 或用 layout.projectDirectory.file("gradle/settings-conventions.kts")
  • 被加载脚本里不能用 plugins { ... } 块(会报错 “Plugin management is not allowed in script plugins”),只能用 pluginManagement { ... } 或纯 Settings API 调用
  • 多个 apply(from = ...) 顺序敏感:后加载的可以覆盖前者的 rootProject.name 或 include 结果

别试图在 init.gradle 或 gradle.properties 里改 Settings 行为

有人想绕过 settings.gradle.kts 直接干预 Settings 生命周期,比如在 init.gradle 里 hook Settings 实例——这行不通。Init 脚本运行时 Settings 尚未创建,且 Gradle 明确禁止在 init 阶段修改 project / settings 结构。

  • gradle.properties 只能提供键值对,无法执行逻辑;org.gradle.configuration-cache=true 这类开关有效,但不能用来驱动 include 判断
  • 自定义 GradleLauncher 或嵌入式调用属于 Gradle 内部 API,不稳定、无文档、跨版本极易崩
  • 如果真需要条件化 include(例如按环境变量开关模块),唯一可靠方式是在 settings.gradle.kts 顶层用 System.getenv("CI") != null 或 providers.systemProperty(...) 判断,再决定是否 include

Settings 脚本里访问不到 Project API,也别混用 buildSrc

settings.gradle.kts 的闭包接收者是 Settings,不是 Project。你不能在这里调用 dependencies { ... }、tasks.register(...),也不能直接引用 buildSrc 里的类——因为 buildSrc 是为 Project 构建服务的,在 Settings 阶段尚未编译、不可见。

  • 如果需要类型安全的工具函数(比如解析 TOML 版本目录),得把它们打包成独立 jar,放在 gradle/libs 下,再用 pluginManagement { classpath(...) 注册,最后通过 settings.classLoader.loadClass(...) 反射调用(不推荐,太重)
  • 更轻量做法:用 Kotlin 标准库原生能力,比如 File("...").walk().find { it.name == "build.gradle.kts" } 动态发现子项目,避免硬编码 include
  • 所有涉及 I/O 的操作(读文件、查环境变量)必须在 settings.gradle.kts 顶层执行,不能包裹在 gradle.beforeProject 等回调里——那些回调只对 Project 生效
真正难的不是写代码,是厘清 Gradle 构建生命周期里 Settings 阶段的边界:它只有一次解析机会,没有缓存重用,不能依赖 Project 层产物,任何“想让它更像 build.gradle”的尝试都会撞墙。

热门AI工具

更多
WorkBuddy

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

立刻MV
立刻MV Hot

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

DeepSeek

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

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

豆包大模型

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 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

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

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

20

2026.10.28

Vite 如何搭配 Vue.js
Vite 如何搭配 Vue.js

Vite搭配Vue.js专题汇集创建Vue 3项目、配置开发环境、路径别名、Vue插件、代理、多环境构建与调试的已审核文章,帮助读者完成从初始化到日常开发的配置。

0

2026.10.28

Vite 项目目录怎么看
Vite 项目目录怎么看

Vite项目目录专题汇集入口文件、src源码、public静态资源、路径别名、项目根目录和构建输出目录相关的已审核文章,帮助读者理解各文件夹的用途与引用方式。

0

2026.10.28

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

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

120

2026.10.22

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

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

60

2026.10.22

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

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

60

2026.10.22

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

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

40

2026.10.22

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

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

60

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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