Gradle多模块项目怎么通过build-logic共享配置

千枫君_5646

千枫君_5646

2026-10-23

638人浏览

原创

build-logic是gradle 8.0+推荐的buildsrc替代方案,为独立、可缓存、可测试、可发布的插件工程,解决buildsrc污染构建缓存、同步慢、ide卡顿等固有缺陷。

gradle多模块项目怎么通过build-logic共享配置

build-logic 是什么,为什么不用 buildSrc

build-logic 是 Gradle 8.0+ 推荐的替代 buildSrc 的复合构建方案,它把构建逻辑(插件、任务、依赖版本)抽成独立的、可缓存、可测试、可发布的小型 Gradle 项目。相比 buildSrc,它不会污染主项目构建缓存,修改后只重建自身,不触发整个项目重同步。

如果你还在用 buildSrc,尤其在大型多模块工程中频繁改构建逻辑,会明显感知到 Gradle 同步变慢、缓存失效、IDE 卡顿——这些不是错觉,是 buildSrc 的固有限制。

怎么创建和配置 build-logic 模块

在项目根目录下新建 build-logic 目录,并按标准 Gradle 插件结构组织:

build-logic/
├── settings.gradle.kts
├── build.gradle.kts
└── src/
    └── main/
        └── kotlin/
            └── com/example/gradle/
                ├── AndroidApplicationConventionPlugin.kt
                └── JavaLibraryConventionPlugin.kt

settings.gradle.kts 必须启用预览特性并声明为插件构建:

enableFeaturePreview("VERSION_CATALOGS")
enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")

pluginManagement {
    repositories {
        gradlePluginPortal()
        google()
        mavenCentral()
    }
}

build.gradle.kts 中声明插件开发依赖:

plugins {
    `kotlin-dsl`
}

repositories {
    gradlePluginPortal()
    google()
    mavenCentral()
}

dependencies {
    implementation(gradleApi())
    implementation(kotlin("stdlib"))
    implementation("org.jetbrains.kotlin:kotlin-gradle-plugin:1.9.24")
}

如何在子模块中应用 convention 插件

写好一个 JavaLibraryConventionPlugin 后,需要在子模块的 build.gradle.kts 中启用它。关键点有三个:

  • 必须在 plugins 块顶部用 alias 或 id 引入,不能放在 dependencies 里
  • 插件 ID 默认是 com.example.gradle.java-library(由包名 + 文件名推导),不是文件路径
  • 如果插件定义了 configureEach,它会在所有匹配模块上自动生效,无需每个模块手动 apply

示例(子模块 app/build.gradle.kts):

plugins {
    alias(libs.plugins.com.example.gradle.android.application) // 来自 version catalog
}

android {
    namespace = "com.example.app"
    compileSdk = 34
}

注意:libs.plugins.com.example.gradle.android.application 这个别名需提前在 gradle/libs.version.toml 中声明,否则会报 Unknown plugin: 'libs.plugins.com.example.gradle.android.application' 错误。

常见错误和兼容性坑点

实际落地时最容易卡住的地方集中在三类:

  • Could not resolve plugin:没在 settings.gradle.kts 的 pluginManagement.repositories 里加 gradlePluginPortal(),或插件未正确发布到本地 Maven(build-logic 本身要先 ./gradlew publishToMavenLocal)
  • Unresolved reference: android:插件代码里用了 android {} 但没声明 com.android.tools.build:gradle 依赖,或版本与主项目不匹配(比如主项目用 AGP 8.4,插件却依赖 8.2)
  • Cannot access 'xxx' which is a module-private declaration:Kotlin 插件类用了 internal 修饰符,导致外部模块不可见;一律改用 public 或删掉修饰符
  • Android 模块中 android {} 块不生效:Convention 插件必须在 plugins 块中 apply,且不能晚于 com.android.application ——顺序错了就等于没配

build-logic 的真正复杂点不在写法,而在“边界感”:它和主项目之间是松耦合的构建时依赖,不是运行时依赖。任何想从插件里读取子模块源码、调用业务类、或动态生成 Java 类的行为,都会越界失败。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系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

369

25

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

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

2026.10.22

0

11

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

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

2026.10.22

0

10

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

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

2026.10.22

0

15

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

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

2026.10.22

0

10

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

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

2026.10.22

0

25

Golangci-lint配置文件与规则设置
Golangci-lint配置文件与规则设置

本专题聚焦Golangci-lint YAML配置文件,讲清运行参数、规则启停、目录排除、问题过滤及严重级别设置,便于团队统一检查标准。

2026.10.22

0

15

Golangci-lint安装与入门教程
Golangci-lint安装与入门教程

本专题讲解Golangci-lint的安装、初始化、基础命令和首次代码检查,覆盖本地环境、Docker及多平台用法,帮助Go开发者快速上手。

2026.10.22

0

15

PHP2Shell高危漏洞修复教程
PHP2Shell高危漏洞修复教程

PHP2Shell漏洞是什么,哪些PHP版本和运行环境会受到影响,服务器应该如何检测与修复?本专题提供版本自查脚本、Linux与Docker升级命令、PHP-FPM和Apache排查步骤,以及修复验证、临时缓解和应急响应方案。

2026.10.22

40

12

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

共0课时 | 0人学习