Gradle buildSrc模块详解:集中管理构建逻辑的利器
文章目录
- buildSrc模块
- 二 buildSrc的使命
- 三 如何使用buildSrc
- 1. 创建目录结构
- 2. 配置buildSrc的构建脚本
- 3. 编写共享逻辑
- 4. 在模块中引用
- 四 典型使用场景
- 1. 统一依赖版本管理
- 2. 自定义Gradle任务
- 3. 封装通用插件
- 4. 扩展Gradle API
- 五 注意事项
- 六 与复合构建(Composite Builds)的区别
- 七 总结
buildSrc模块
buildSrc是Gradle项目中一个特殊的目录,用于存放与构建过程相关的代码(如自定义任务、插件、依赖版本管理等)。该目录下的代码会被Gradle自动编译并添加到项目的构建脚本类路径中,从而实现构建逻辑的复用和集中管理。
二 buildSrc的使命
1. 解决痛点
- 重复配置:在多模块项目中,多个子模块的
build.gradle可能包含相同的插件版本、依赖声明或自定义任务。 - 维护困难:当需要修改公共配置时,需逐个文件调整,易出错。
- 代码复用:无法直接在构建脚本中共享工具类或扩展逻辑。
2. 核心优势
- 自动可见性:
buildSrc中的代码对所有模块的构建脚本直接可见,无需手动导入。 - 触发重建:修改
buildSrc中的代码会触发Gradle的增量编译,确保构建逻辑及时生效。 - 代码结构化:支持使用Kotlin/Groovy/Java编写结构化代码,提升可维护性。
三 如何使用buildSrc
1. 创建目录结构

在项目根目录下创建buildSrc模块目录,结构如下:
project-root/
├── buildSrc/
│ ├── src/
│ │ ├── main/
│ │ │ ├── kotlin/ # 或 groovy/java
│ │ │ └── resources/
│ │ └── test/ # 可选测试代码
│ └── build.gradle.kts # buildSrc自身的构建配置
├── app/
│ └── build.gradle.kts
└── settings.gradle.kts
2. 配置buildSrc的构建脚本
- 编辑
buildSrc/build.gradle.kts,声明依赖(如、Kotlin DSL):
// buildSrc/build.gradle.kts
plugins {`kotlin-dsl` // 启用Kotlin DSL支持
}repositories {mavenCentral()gradlePluginPortal() // 访问Gradle插件仓库
}dependencies {implementation("com.android.tools.build:gradle:8.2.0") // 示例:引入Android Gradle插件API
}
3. 编写共享逻辑
在buildSrc/src/main/kotlin中定义公共代码,例如版本管理:
// buildSrc/src/main/kotlin/Dependencies.kt
object Versions {const val kotlin = "1.9.0"const val junit = "5.8.2"
}object Libs {const val junitJupiter = "org.junit.jupiter:junit-jupiter:${Versions.junit}"
}
4. 在模块中引用
- 在子模块的
build.gradle.kts中直接使用:
// app/build.gradle.kts
plugins {kotlin("jvm") version Versions.kotlin
}dependencies {testImplementation(Libs.junitJupiter)
}
四 典型使用场景
1. 统一依赖版本管理
- 定义所有依赖的版本号和坐标,避免多模块版本不一致。
- 示例:集中管理Android SDK版本、Kotlin版本等。
2. 自定义Gradle任务
编写可复用的任务逻辑:
// buildSrc/src/main/kotlin/Tasks.kt
tasks.register("helloWorld") {doLast {println("Hello from buildSrc!")}
}
3. 封装通用插件
- 将重复的插件配置抽象为自定义插件:
// buildSrc/src/main/kotlin/JavaConventionPlugin.kt
class JavaConventionPlugin : Plugin<Project> {override fun apply(project: Project) {project.apply {plugin("java-library")plugin("checkstyle")}// 统一配置源码集、测试等}
}
4. 扩展Gradle API
- 添加DSL扩展或工具类:
// buildSrc/src/main/kotlin/MyExtensions.kt
open class MyExtension(project: Project) {var enableFeature: Boolean = false
}project.extensions.create("myConfig", MyExtension::class.java, project)
五 注意事项
- 目录命名强制要求:必须命名为
buildSrc,且位于项目根目录。若使用Kotlin,需通过kotlin-dsl插件启用支持。 - 构建缓存:修改
buildSrc代码会触发项目整体重新编译,适合低频变更的配置。对高频修改的逻辑,考虑使用复合构建(Composite Builds)。 - 依赖限制:
buildSrc不能依赖项目其他模块的代码。避免在buildSrc中引入大型依赖(如Spring Framework),否则会拖慢构建速度。
六 与复合构建(Composite Builds)的区别
| 特性 | buildSrc | Composite Builds |
|---|---|---|
| 代码变更触发重建 | 修改即触发全项目重建 | 需手动执行构建或通过--include-build |
| 作用范围 | 仅当前项目 | 可跨多个项目复用 |
| 适用场景 | 项目内共享逻辑 | 跨项目共享插件/构建逻辑 |
七 总结
使用buildSrc的核心价值:
- ✅ 自动化依赖管理:告别手动同步版本号
- ✅ 提升可维护性:集中管理构建逻辑,减少重复代码
- ✅ 增强扩展性:轻松实现自定义DSL、插件和任务
推荐使用场景:
- 中大型多模块项目
- 需要统一配置或自定义插件
- 团队协作时规范构建逻辑
建议:
- 从简单的版本管理开始,逐步迁移公共配置到
buildSrc - 探索结合
Version Catalogs(Gradle版本目录)实现更灵活的依赖管理 - 参考官方文档:Gradle Build Sources
相关文章:
Gradle buildSrc模块详解:集中管理构建逻辑的利器
文章目录 buildSrc模块二 buildSrc的使命三 如何使用buildSrc1. 创建目录结构2. 配置buildSrc的构建脚本3. 编写共享逻辑4. 在模块中引用 四 典型使用场景1. 统一依赖版本管理2. 自定义Gradle任务 3. 封装通用插件4. 扩展Gradle API 五 注意事项六 与复合构建(Compo…...
【Airsim 仿真】查找配置文件 settings json 的路径优先级
Airsim 查找配置文件 settings.json 的路径优先级 参考官方文档 Settings - AirSim 文件格式要求 settings.json 文件采用常规的 JSON 格式。在首次启动时,AirSim 会在用户的主文件夹中创建一个没有设置的 settings.json 文件(待测试)。为…...
【FreeRTOS 教程 四】队列创建与发布项目到队列
目录 一、FreeRTOS队列: (1)队列介绍: (2)用户模型说明: (3)阻塞队列: 二、队列管理 API: (1)uxQueueMessagesWaiti…...
STM32项目分享:智能厨房安全检测系统
目录 一、前言 二、项目简介 1.功能详解 2.主要器件 三、原理图设计 四、PCB硬件设计 PCB图 五、程序设计 六、实验效果 七、资料内容 项目分享 一、前言 项目成品图片: 哔哩哔哩视频链接: STM32智能厨房安全检测系统 (资料分…...
2025美赛数学建模MCM/ICM选题建议与分析,思路+模型+代码
2025美赛数学建模MCM/ICM选题建议与分析,思路模型代码,详细更新见文末名片 一、问题A:测试时间:楼梯的恒定磨损(Archaeological Modeling) 适合专业:考古学、历史学、数学、机械工程 难度:中等…...
高并发问题的多维度解决之道
…...
Ubuntu环境 nginx 源码 编译安装
ubuntu 终端 使用 wget 下载源码 sudo wget http://nginx.org/download/nginx-1.24.0.tar.gz解压刚下载的源码压缩包 nginx-1.24.0.tar.gz sudo tar -zxvf nginx-1.24.0.tar.gz 解压完成 产生 nginx-1.24.0 目录 进入该目录 cd ./nginx-1.24.0 目录下有一个可执行文件 con…...
K8S中的数据存储之基本存储
基本存储类型 EmptyDir 描述:当 Pod 被调度到节点上时,Kubernetes 会为 Pod 创建一个空目录,所有在该 Pod 中的容器都可以访问这个目录。特点: 生命周期与 Pod 绑定,Pod 删除时,数据也会丢失。适用于临时…...
编码器和扩散模型
目录 摘要abstract1.自动编码器2.变分编码器(VAE)3.论文阅读3.1 介绍3.2 方法3.3 结论 4.总结参考文献 摘要 本周学习了自动编码器(AE)和变分自动编码器(VAE)的基本原理与实现,分析其在数据降维…...
PAT甲级-1024 Palindromic Number
题目 题目大意 一个非回文数,加上它的翻转数所得的和,进行k次,有可能会得到一个回文数。给出一个数n,限制相加次数为k次,如果小于k次就得到回文数,那么输出该回文数和相加的次数;如果进行k次还…...
FS8405 Release FS0B
复位场景:FS8405正常工作后,RSTB后期产生拉低复位信号。 1 故障与PGOOD、RSTB和FS0B引脚的联系 FS8405出现故障时,会对PGOOD、RSTB和FS0B引脚产生不同的影响,具体影响如下: 橙色标记,反应是不可配置的。…...
IGBT的损耗计算的学习【2025/1/24】
可以通过示波器实测IGBT电压电流波形,然后通过示波器的math功能将电压电流波形乘积后积分求损耗。 软开管:给了导通信号,但是电流并没有从此IGBT流过 IGBT(绝缘栅双极晶体管)的损耗主要分为 导通损耗 和 开关损耗 两部…...
Unity|小游戏复刻|见缝插针1(C#)
准备 创建Scenes场景,Scripts脚本,Prefabs预制体文件夹 修改背景颜色 选中Main Camera 找到背景 选择颜色,一种白中透黄的颜色 创建小球 将文件夹里的Circle拖入层级里 选中Circle,位置为左右居中,偏上&…...
No.1|Godot|俄罗斯方块复刻|棋盘和初始方块的设置
删掉基础图标新建assets、scenes、scripts文件夹 俄罗斯方块的每种方块都是由四个小方块组成的,很适合放在网格地图中 比如网格地图是宽10列,高20行 要实现网格的对齐和下落 Node2D节点 新建一个Node2D 添加2个TileMapLayer 一个命名为Board&…...
SSM框架探秘:Spring 整合 SpringMVC 框架
搭建和测试 SpringMVC 的开发环境: web.xml 元素顺序: 在 web.xml 中配置 DisPatcherServlet 前端控制器: <!-- 配置前端控制器 --> <servlet><servlet-name>dispatcherServlet</servlet-name><servlet-class>…...
2025.1.20——二、buuctf BUU UPLOAD COURSE 1 1 文件上传
题目来源:buuctf BUU UPLOAD COURSE 1 1 目录 一、打开靶机,查看信息 二、解题思路 step 1:上传一句话木马.php文件康康回显 step 2:蚁剑连接 三、小结 一、打开靶机,查看信息 这里提示到了文件会被上传到./uplo…...
【架构面试】三、高可用高性能架构设计
高可用高性能架构设计 面试要点引入:架构原理、分布式技术等是面试必考领域,高可用高性能需求考察频繁。面试常通过询问系统架构设计来考察能力,讲解架构设计过程就是证明系统高可用的过程,其中涉及SLA指标。SLA指标详解 定义与衡…...
11.渲染管线——光栅化阶段
光栅化阶段是渲染管线中的一个关键步骤,负责将3D模型转换成屏幕上的2D像素。用通俗易懂的方式来解释: 通俗解释:光栅化就像把3D模型“投影”到2D屏幕上 想象你是一个画家,正在把3D场景画到2D画布上: 3D模型到2D屏幕的…...
【数据分享】1929-2024年全球站点的逐月平均能见度(Shp\Excel\免费获取)
气象数据是在各项研究中都经常使用的数据,气象指标包括气温、风速、降水、湿度等指标!说到气象数据,最详细的气象数据是具体到气象监测站点的数据! 有关气象指标的监测站点数据,之前我们分享过1929-2024年全球气象站点…...
二叉树的深度
二叉树深度的定义: 二叉树的深度(高度)是指从根节点到最远叶子节点的最长路径上的节点数。例如,一个只有根节点的二叉树,其深度为1;如果根节点有两个子节点,且每个子节点又分别有两个子节点&…...
K8S认证|CKS题库+答案| 11. AppArmor
目录 11. AppArmor 免费获取并激活 CKA_v1.31_模拟系统 题目 开始操作: 1)、切换集群 2)、切换节点 3)、切换到 apparmor 的目录 4)、执行 apparmor 策略模块 5)、修改 pod 文件 6)、…...
React hook之useRef
React useRef 详解 useRef 是 React 提供的一个 Hook,用于在函数组件中创建可变的引用对象。它在 React 开发中有多种重要用途,下面我将全面详细地介绍它的特性和用法。 基本概念 1. 创建 ref const refContainer useRef(initialValue);initialValu…...
多场景 OkHttpClient 管理器 - Android 网络通信解决方案
下面是一个完整的 Android 实现,展示如何创建和管理多个 OkHttpClient 实例,分别用于长连接、普通 HTTP 请求和文件下载场景。 <?xml version"1.0" encoding"utf-8"?> <LinearLayout xmlns:android"http://schemas…...
抖音增长新引擎:品融电商,一站式全案代运营领跑者
抖音增长新引擎:品融电商,一站式全案代运营领跑者 在抖音这个日活超7亿的流量汪洋中,品牌如何破浪前行?自建团队成本高、效果难控;碎片化运营又难成合力——这正是许多企业面临的增长困局。品融电商以「抖音全案代运营…...
Qt Http Server模块功能及架构
Qt Http Server 是 Qt 6.0 中引入的一个新模块,它提供了一个轻量级的 HTTP 服务器实现,主要用于构建基于 HTTP 的应用程序和服务。 功能介绍: 主要功能 HTTP服务器功能: 支持 HTTP/1.1 协议 简单的请求/响应处理模型 支持 GET…...
代理篇12|深入理解 Vite中的Proxy接口代理配置
在前端开发中,常常会遇到 跨域请求接口 的情况。为了解决这个问题,Vite 和 Webpack 都提供了 proxy 代理功能,用于将本地开发请求转发到后端服务器。 什么是代理(proxy)? 代理是在开发过程中,前端项目通过开发服务器,将指定的请求“转发”到真实的后端服务器,从而绕…...
Mobile ALOHA全身模仿学习
一、题目 Mobile ALOHA:通过低成本全身远程操作学习双手移动操作 传统模仿学习(Imitation Learning)缺点:聚焦与桌面操作,缺乏通用任务所需的移动性和灵活性 本论文优点:(1)在ALOHA…...
HDFS分布式存储 zookeeper
hadoop介绍 狭义上hadoop是指apache的一款开源软件 用java语言实现开源框架,允许使用简单的变成模型跨计算机对大型集群进行分布式处理(1.海量的数据存储 2.海量数据的计算)Hadoop核心组件 hdfs(分布式文件存储系统)&a…...
Python基于历史模拟方法实现投资组合风险管理的VaR与ES模型项目实战
说明:这是一个机器学习实战项目(附带数据代码文档),如需数据代码文档可以直接到文章最后关注获取。 1.项目背景 在金融市场日益复杂和波动加剧的背景下,风险管理成为金融机构和个人投资者关注的核心议题之一。VaR&…...
push [特殊字符] present
push 🆚 present 前言present和dismiss特点代码演示 push和pop特点代码演示 前言 在 iOS 开发中,push 和 present 是两种不同的视图控制器切换方式,它们有着显著的区别。 present和dismiss 特点 在当前控制器上方新建视图层级需要手动调用…...
