如何在Gradle中抽象通用构建逻辑？适配Maven项目迁移场景

针对你要把多个独立Git仓库的单/多模块Maven项目迁移到Gradle，同时复用原Master POM中通用配置的需求，推荐两种落地方案，都支持将通用配置存放在独立Git仓库中：

方案一：预编译脚本插件（轻量快速） #

预编译脚本插件是Gradle自带的轻量方案，不需要编写完整的插件代码，直接把通用配置写成可复用的脚本，适合简单的配置共享场景。

步骤1：在独立Git仓库中创建预编译脚本 #

在单独的Git仓库里，创建规范的buildSrc目录结构（也可直接用单脚本文件）：

shared-gradle-config/
├── buildSrc/
│   ├── src/
│   │   └── main/
│   │       └── groovy/
│   │           └── com/example/base-config.gradle
│   └── build.gradle

在base-config.gradle中编写对应原Master POM的配置：

// 对应organization配置
group = "com.example"
description = "Base organization config"

// 对应properties配置
ext {
    javaVersion = 17
    nexusRepoUrl = "http://your-nexus-url/repository/maven-public/"
}

// 对应repositories配置
repositories {
    maven {
        url = uri(nexusRepoUrl)
    }
    mavenCentral()
}

// 对应build/plugins配置
plugins.withType(JavaPlugin) {
    configure<JavaPluginExtension> {
        sourceCompatibility = JavaVersion.toVersion(javaVersion)
        targetCompatibility = JavaVersion.toVersion(javaVersion)
    }
}

// 对应distributionManagement（发布配置）
publishing {
    repositories {
        maven {
            url = uri("http://your-nexus-url/repository/maven-releases/")
            credentials {
                username = System.getenv("NEXUS_USER")
                password = System.getenv("NEXUS_PWD")
            }
        }
    }
}

// 对应reporting配置
reporting {
    baseDir = file("$buildDir/custom-reports")
}

步骤2：在业务项目中引用该配置 #

有两种灵活的引用方式：

1. Git子模块方式：将共享配置仓库作为业务项目的Git子模块引入

   git submodule add git@your-git-url/shared-gradle-config.git
   

   然后在业务项目的settings.gradle中添加：

   includeBuild("shared-gradle-config/buildSrc")
   

   最后在项目的build.gradle中应用：

   apply plugin: 'com.example.base-config'
   

2. 直接远程引用脚本：不想用子模块的话，可直接通过Git URI引用脚本（需Gradle版本支持）

   apply from: "git://your-git-url/shared-gradle-config/buildSrc/src/main/groovy/com/example/base-config.gradle?ref=main"
   

方案二：自定义Gradle插件（可扩展、适合复杂场景） #

如果通用配置包含复杂逻辑（比如条件判断、动态配置），推荐编写自定义Gradle插件，将所有通用逻辑封装成插件，发布到你的Nexus仓库，业务项目直接依赖插件即可，插件本身存放在独立Git仓库。

步骤1：创建插件项目（独立Git仓库） #

创建标准的Gradle插件项目结构：

gradle-base-plugin/
├── src/
│   ├── main/
│   │   ├── groovy/
│   │   │   └── com/example/BaseConfigPlugin.groovy
│   │   └── resources/
│   │       └── META-INF/gradle-plugins/
│   │           └── com.example.base-config.properties
│   └── test/
└── build.gradle

在BaseConfigPlugin.groovy中编写插件逻辑，覆盖原Master POM的所有配置：

package com.example

import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.plugins.JavaPluginExtension
import org.gradle.api.publish.PublishingExtension
import org.gradle.api.reporting.ReportingExtension
import org.gradle.jvm.toolchain.JavaLanguageVersion

class BaseConfigPlugin implements Plugin<Project> {
    void apply(Project project) {
        // 对应organization
        project.group = "com.example"
        project.description = "Base organization config"

        // 对应properties
        project.ext.set("javaVersion", 17)
        project.ext.set("nexusRepoUrl", "http://your-nexus-url/repository/maven-public/")

        // 对应repositories
        project.repositories {
            maven {
                url = project.uri(project.ext.get("nexusRepoUrl"))
            }
            mavenCentral()
        }

        // 对应build/plugins
        project.plugins.withType(JavaPlugin) {
            JavaPluginExtension javaExt = project.extensions.getByType(JavaPluginExtension)
            javaExt.toolchain.languageVersion = JavaLanguageVersion.of(17)
        }

        // 对应distributionManagement
        project.plugins.apply("maven-publish")
        PublishingExtension publishingExt = project.extensions.getByType(PublishingExtension)
        publishingExt.repositories {
            maven {
                url = project.uri("http://your-nexus-url/repository/maven-releases/")
                credentials {
                    username = System.getenv("NEXUS_USER")
                    password = System.getenv("NEXUS_PWD")
                }
            }
        }

        // 对应reporting
        ReportingExtension reportingExt = project.extensions.getByType(ReportingExtension)
        reportingExt.baseDir = project.file("${project.buildDir}/custom-reports")
    }
}

在com.example.base-config.properties中指定插件入口类：

implementation-class=com.example.BaseConfigPlugin

步骤2：发布插件到Nexus #

在插件项目的build.gradle中配置发布规则：

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

group = 'com.example'
version = '1.0.0'

gradlePlugin {
    plugins {
        baseConfig {
            id = 'com.example.base-config'
            implementationClass = 'com.example.BaseConfigPlugin'
        }
    }
}

publishing {
    repositories {
        maven {
            url = uri("http://your-nexus-url/repository/maven-releases/")
            credentials {
                username = System.getenv("NEXUS_USER")
                password = System.getenv("NEXUS_PWD")
            }
        }
    }
}

执行./gradlew publish将插件发布到Nexus仓库。

步骤3：业务项目中引用插件 #

在业务项目的settings.gradle中配置插件仓库：

pluginManagement {
    repositories {
        maven {
            url = uri("http://your-nexus-url/repository/maven-public/")
        }
        gradlePluginPortal()
    }
}

然后在项目的build.gradle中应用插件：

plugins {
    id 'java'
    id 'com.example.base-config' version '1.0.0'
}

方案对比 #

• 预编译脚本插件：上手快，无需插件开发经验，适合简单配置共享；缺点是逻辑能力有限，难处理复杂场景。
• 自定义插件：可扩展性强，能封装复杂逻辑，版本管理更规范；缺点是需要掌握Gradle插件开发知识，初期成本稍高。

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