Gradle搭建SpringBoot微服务独立公共父模块的方案咨询

1. 通用能力抽离到独立仓库的合理性 #

这个做法完全合理，是微服务架构下的主流最佳实践，核心价值如下：

• 统一管控全量微服务的依赖版本，彻底避免不同业务服务引入同一依赖的版本差异导致的兼容性故障
• 抽象实体、公共配置、工具类等通用逻辑一处维护全量生效，大幅降低重复开发、重复修改的维护成本
• 统一技术栈规范，避免不同业务团队随意引入非合规依赖导致的架构混乱
• 父模块支持独立版本迭代，升级不需要侵入业务服务代码，仅需调整依赖版本号即可完成全量升级

2. Gradle 等价于 Maven pom 父项目的实现方案 #

Gradle 没有 Maven 中<packaging>pom</packaging>的显式配置，你可以通过「平台模块 + 通用代码模块」的组合方案实现完全等价的效果，是当前最适配你需求的最优解，具体实现步骤如下：

步骤1：搭建独立父仓库的项目结构 #

your-common-parent/
├── build.gradle          # 根项目全局配置
├── settings.gradle
├── common-core           # 存放抽象实体、公共配置、工具类等通用业务代码
│   └── build.gradle
└── dependency-platform   # 统一依赖版本管控，等价于Maven的dependencyManagement标签
    └── build.gradle

步骤2：配置依赖版本管控模块 #

在dependency-platform/build.gradle中引入Java平台插件，专门做统一版本管理：

plugins {
    id 'java-platform'
    id 'maven-publish' // 配置发布能力，可推送至私有Maven仓库供业务服务引用
}

group = 'com.yourcompany'
version = '1.0.0'

javaPlatform {
    allowDependencies() // 允许继承第三方官方BOM，比如Spring Boot官方BOM
}

dependencies {
    // 继承Spring Boot官方的依赖版本定义
    platform(org.springframework.boot:spring-boot-dependencies:2.7.14)
    
    // 自定义所有微服务通用的依赖版本
    constraints {
        api 'com.alibaba:fastjson:2.0.32'
        api 'org.apache.commons:commons-lang3:3.12.0'
        // 其余需要统一管控版本的依赖均可在此处添加
    }
}

// 配置发布到私有Maven仓库（本地测试可先使用publishToMavenLocal命令发布到本地）
publishing {
    publications {
        maven(MavenPublication) {
            from components.javaPlatform
        }
    }
    repositories {
        maven {
            url = "你的私有Maven仓库地址"
            credentials {
                username = "仓库访问用户名"
                password = "仓库访问密码"
            }
        }
    }
}

步骤3：配置通用代码模块 #

在common-core/build.gradle中配置通用代码的依赖和发布规则：

plugins {
    id 'java'
    id 'maven-publish'
}

group = 'com.yourcompany'
version = '1.0.0'

dependencies {
    // 继承同仓库下的版本管控规则，所有依赖无需写版本号
    implementation platform(project(':dependency-platform'))
    
    // 通用代码所需的依赖
    implementation 'org.springframework.boot:spring-boot-starter-web'
    implementation 'org.apache.commons:commons-lang3'
}

// 发布规则和版本管控模块保持一致
publishing {
    publications {
        maven(MavenPublication) {
            from components.java
        }
    }
    // 私有仓库配置同上
}

步骤4：业务微服务引入公共能力 #

在业务微服务的build.gradle中直接引入你发布的公共模块即可：

plugins {
    id 'org.springframework.boot' version '2.7.14'
    id 'io.spring.dependency-management' version '1.0.15.RELEASE'
    id 'java'
}

group = 'com.yourcompany'
version = '1.0.0'

dependencies {
    // 引入统一版本管控平台，后续所有依赖无需指定版本号
    implementation platform('com.yourcompany:dependency-platform:1.0.0')
    // 引入通用代码模块
    implementation 'com.yourcompany:common-core:1.0.0'
    
    // 业务依赖，无需指定版本
    implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
    implementation 'com.alibaba:fastjson'
}

如果需要统一管控所有业务微服务的Gradle插件版本，可以额外开发一个轻量的自定义Gradle插件发布到私有仓库，在业务服务中引入即可，可100%覆盖Maven父pom的所有能力。

内容的提问来源于stack exchange，提问作者ouadin