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

Gradle预编译脚本插件怎么开发

小明小哥_6327

小明小哥_6327

发布时间:2026-11-02 12:07:33

|

168人浏览过

|

来源于php中文网

原创

预编译脚本插件是Gradle 6.0+推荐的轻量级插件形式,需置于gradle/plugins/目录下,以plugins{id("plugin.xxx")}方式应用,不可用apply plugin:,且不可在顶层直接访问project。

gradle预编译脚本插件怎么开发

预编译脚本插件(Precompiled Script Plugins)是 Gradle 6.0+ 引入的推荐方式,替代了旧版的“构建脚本插件”(即直接写在 build.gradle 里的类),它用 .gradle.kts 或 .gradle 文件定义逻辑,经 Gradle 自动编译为二进制插件,具备类型安全、IDE 支持好、可复用等优势。它不是 buildSrc,也不是独立插件项目,而是以脚本文件为单元、放在固定位置、被自动识别和编译的轻量级插件形式。

脚本文件必须放在 gradle/plugins/ 目录下

Gradle 只会在项目根目录的 gradle/plugins/ 子路径中查找并编译预编译脚本插件。其他位置(如 buildSrc、src/main/kotlin 或任意自定义路径)都不会被识别为预编译插件。

  • 正确路径示例:gradle/plugins/my-convention.gradle.kts
  • 错误路径示例:buildSrc/src/main/kotlin/MyPlugin.kt(这是 buildSrc 插件,非预编译脚本插件)
  • 错误路径示例:gradle/my-convention.gradle.kts(少了一级 plugins/)

Gradle 会为每个 .gradle.kts 文件生成一个唯一的插件 ID,格式为 plugin.<filename_without_extension></filename_without_extension>,比如 my-convention.gradle.kts 对应插件 ID plugin.my-convention。

apply 时不能用字符串 ID,必须用 plugins { id(...) } 块

预编译脚本插件只能通过 plugins { id "plugin.my-convention" }(Groovy)或 plugins { id("plugin.my-convention") }(KTS)方式应用,不支持 apply plugin: "plugin.my-convention" 这种旧式写法——后者会报错 Plugin with id 'plugin.my-convention' not found,因为 Gradle 的插件解析器在传统 apply plugin: 模式下根本不会扫描 gradle/plugins/ 目录。

  • ✅ 正确:
    plugins {
        id("plugin.my-convention")
    }
  • ❌ 错误:
    apply plugin: "plugin.my-convention"
  • ⚠️ 注意:该 plugins 块必须出现在构建脚本顶部(KTS 中甚至要求在任何 import 之前),否则会触发解析失败

脚本内不能直接访问 project,要用 gradle.includedBuilds 或 settings 扩展点

预编译脚本插件本质是 Settings Plugin 或 Project Plugin,其作用域取决于你把它用在哪。如果你把它应用在 settings.gradle.kts 中,它就运行在 Settings 上下文;如果应用在 build.gradle.kts 中,则运行在 Project 上下文。但关键点是:你**不能在脚本顶层直接调用 project.version = "1.0" 这类语句**,因为此时 project 尚未初始化(会报 Cannot access project without initialization)。

  • ✅ 正确做法(在 build.gradle.kts 中应用时):
    plugins {
        id("plugin.my-convention")
    }
    
    // 在 afterEvaluate 或 tasks.register 中操作 project</afterEvaluate>
  • ✅ 更推荐做法:把配置逻辑封装进 configureEach 或 withType,例如:
    tasks.withType<Jar> {
        archiveBaseName.set("mylib")
    }
  • ⚠️ 容易忽略:预编译脚本插件默认没有 gradleApi() 或 localGroovy() 依赖,所以不能像 buildSrc 那样随意使用 Gradle 内部 API;所有对外暴露的类型必须是公开、稳定的公共 API

真正容易卡住的地方,是以为“写个 .gradle.kts 就算完成了”,结果发现 IDE 不提示、plugins { id(...) } 找不到、或者一写 project. 就报空指针——其实问题往往出在路径不对、应用方式错、或过早访问未就绪的构建对象上。预编译脚本插件轻量,但边界清晰,越早按它的规则来,越少掉坑里。

热门AI工具

更多
豆包大模型

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

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

UpDream
UpDream Hot

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

切问学术

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

DeepSeek

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

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

创客贴AI

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

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的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

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

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

0

2026.11.02

Uvicorn使用教程
Uvicorn使用教程

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

0

2026.11.02

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

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

0

2026.11.02

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

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

120

2026.10.28

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

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

80

2026.10.28

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

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

260

2026.10.28

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

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

160

2026.10.22

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

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

140

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