Java GRPC中如何配置.proto文件路径？适配特殊项目结构

我之前在多模块Java GRPC项目里遇到过一模一样的场景，把proto放在独立的协议模块确实更清晰，只要调整构建插件的配置就能让GRPC找到你的proto文件，分Maven和Gradle两种常用构建工具给你说明：

Maven项目配置（使用grpc-maven-plugin） #

首先得确保主模块能访问到协议模块的内容，然后指定proto文件的路径：

• 第一步：在stub-service模块的pom.xml中添加对stub-protocol的依赖，确保构建时能读取到该模块的文件：

<dependencies>
    <dependency>
        <groupId>你的项目groupId</groupId>
        <artifactId>stub-protocol</artifactId>
        <version>项目版本号</version>
    </dependency>
</dependencies>

• 第二步：配置grpc-maven-plugin，通过<protoRoots>指定外部模块的proto目录。这里用${project.basedir}定位当前模块根目录，再通过相对路径指向stub-protocol：

<build>
    <plugins>
        <plugin>
            <groupId>io.grpc</groupId>
            <artifactId>grpc-maven-plugin</artifactId>
            <version>你使用的GRPC版本</version>
            <executions>
                <execution>
                    <goals>
                        <goal>compile</goal>
                        <goal>compile-java</goal>
                    </goals>
                    <configuration>
                        <!-- 添加stub-protocol模块的proto路径 -->
                        <protoRoots>
                            <protoRoot>${project.basedir}/../stub-protocol</protoRoot>
                        </protoRoots>
                        <!-- 保留默认的src/main/proto路径（如果需要的话） -->
                        <protoRoots>
                            <protoRoot>${project.basedir}/src/main/proto</protoRoot>
                        </protoRoots>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

Gradle项目配置（使用grpc-gradle-plugin） #

Gradle的配置思路和Maven一致，先处理模块依赖，再扩展proto源目录：

• 第一步：在stub-service的build.gradle中引入stub-protocol模块：

dependencies {
    implementation project(':stub-protocol')
}

• 第二步：配置protobuf插件的sourceSets，把stub-protocol的目录添加到proto扫描路径中：

plugins {
    id 'java'
    id 'com.google.protobuf' version '你使用的protobuf插件版本'
}

protobuf {
    protoc {
        artifact = "com.google.protobuf:protoc:对应版本"
    }
    plugins {
        grpc {
            artifact = 'io.grpc:protoc-gen-grpc-java:你使用的GRPC版本'
        }
    }
    generateProtoTasks {
        all()*.plugins {
            grpc {}
        }
        // 添加stub-protocol模块作为proto源目录
        sourceSets.main.proto.srcDirs += ['../stub-protocol']
        // 保留默认的src/main/proto路径（可选）
        sourceSets.main.proto.srcDirs += ['src/main/proto']
    }
}

额外建议 #

如果你的stub-protocol模块本身需要生成基础的Proto Java类（比如消息体类），可以在该模块自己的构建配置中单独配置protobuf插件，让它负责生成基础类；然后stub-service依赖这个模块，再专注生成GRPC的Stub代码，这样模块分工更清晰，也避免重复生成代码。

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