Protocol Buffer子模块的Gradle统一配置方案问询

1. 根项目统一引入插件与依赖管理 #

先在根build.gradle.kts中集中声明Protobuf插件版本和公共仓库，避免子模块重复配置：

plugins {
    id("com.google.protobuf") version "0.9.4" apply false
    id("java-library") version "8.0" apply false
}

allprojects {
    repositories {
        mavenCentral()
    }
}

2. 统一子模块SourceSets配置 #

通过subprojects块为所有子模块设置默认的proto文件路径和生成代码目录，同时保留子模块按需调整的空间：

subprojects {
    apply(plugin = "java-library")
    apply(plugin = "com.google.protobuf")

    sourceSets {
        main {
            proto {
                // 按你的仓库目录结构设置默认proto源路径，可自行调整
                srcDirs("src/main/proto", "${rootDir}/shared-protos")
                // 子模块若需排除部分proto，可在自身配置中添加exclude规则
            }
            java {
                srcDir("build/generated/source/proto/main/java")
            }
        }
    }
}

3. 集中配置Protobuf编译规则 #

把重复的protoc版本、生成插件、编译输出等配置统一放到根项目：

subprojects {
    protobuf {
        protoc {
            artifact = "com.google.protobuf:protoc:3.25.3"
        }
        plugins {
            // 预定义常用的语言生成插件，按需添加
            create("java") {
                artifact = "com.google.protobuf:protoc-gen-java:3.25.3"
            }
            create("grpc-java") {
                artifact = "io.grpc:protoc-gen-grpc-java:1.59.0"
            }
        }
        generateProtoTasks {
            all().forEach { task ->
                // 默认启用Java代码生成，子模块可自行添加其他插件
                task.plugins.create("java")
                task.outputDir = file("${project.buildDir}/generated/source/proto/main")
            }
        }
    }
}

4. 子模块按需定制 #

如果部分子模块需要特殊配置（比如额外的proto路径、启用gRPC生成），只需在自身build.gradle.kts中补充即可，无需重复公共配置：

// 子模块示例配置
sourceSets.main.proto.srcDirs("src/main/custom-protos")
protobuf.generateProtoTasks.all().forEach { task ->
    task.plugins.create("grpc-java")
}

完整根build.gradle.kts示例 #

plugins {
    id("com.google.protobuf") version "0.9.4" apply false
    id("java-library") version "8.0" apply false
}

allprojects {
    repositories {
        mavenCentral()
    }
}

subprojects {
    apply(plugin = "java-library")
    apply(plugin = "com.google.protobuf")

    sourceSets {
        main {
            proto {
                srcDirs("src/main/proto", "${rootDir}/shared-protos")
            }
            java {
                srcDir("build/generated/source/proto/main/java")
            }
        }
    }

    protobuf {
        protoc {
            artifact = "com.google.protobuf:protoc:3.25.3"
        }
        plugins {
            create("java") {
                artifact = "com.google.protobuf:protoc-gen-java:3.25.3"
            }
            create("grpc-java") {
                artifact = "io.grpc:protoc-gen-grpc-java:1.59.0"
            }
        }
        generateProtoTasks {
            all().forEach { task ->
                task.plugins.create("java")
                task.outputDir = file("${project.buildDir}/generated/source/proto/main")
            }
        }
    }

    dependencies {
        implementation("com.google.protobuf:protobuf-java:3.25.3")
        // 子模块可按需添加grpc-stub等额外依赖
    }
}

核心优势 #

• 公共配置集中管理，减少子模块重复代码
• 版本统一维护，升级时仅需修改根项目的版本号
• 默认配置覆盖通用场景，子模块仅需编写个性化需求

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