如何配置protoc-jar-maven-plugin指定protoc导入路径至仓库根目录？

核心问题分析 #

你的.proto文件导入路径基于共享仓库根目录定义（如import "service-a/v1/a.proto"），但当前插件配置的includeDirectories未正确让protoc识别仓库根作为导入搜索路径，再加上使用的插件版本较旧存在路径解析bug，最终导致导入失败。

解决方案步骤 #

1. 升级插件版本 #

旧版本（3.11.4）存在路径解析的已知问题，建议升级到稳定新版本，比如3.25.1，能更可靠地处理相对路径。

2. 修正导入搜索目录配置 #

用Maven的${project.basedir}属性明确指向仓库根，避免相对路径歧义。由于你的pom位于service-x/v1目录，仓库根相对于该pom的路径为${project.basedir}/../../，将其配置到includeDirectories中，确保protoc从仓库根开始搜索导入文件。

3. 补充gRPC代码生成配置（必要操作） #

因为你需要生成gRPC服务的stub类，当前配置缺少grpc-java插件的调用参数，需在插件配置中添加protoc的额外参数指定grpc插件。

完整插件配置示例 #

<plugin>
    <groupId>com.github.os72</groupId>
    <artifactId>protoc-jar-maven-plugin</artifactId>
    <!-- 使用新版本 -->
    <version>3.25.1</version>
    <executions>
        <execution>
            <phase>generate-sources</phase>
            <goals>
                <goal>run</goal>
            </goals>
            <configuration>
                <includeMavenTypes>direct</includeMavenTypes>
                <!-- 明确指定仓库根为导入搜索目录 -->
                <includeDirectories>
                    <include>${project.basedir}/../../</include>
                </includeDirectories>
                <!-- 仅处理当前目录下的.proto文件 -->
                <inputDirectories>
                    <include>${project.basedir}</include>
                </inputDirectories>
                <!-- 添加gRPC代码生成参数 -->
                <protocArgs>
                    <arg>--java_out=${project.build.directory}/generated-sources/protobuf/java</arg>
                    <arg>--grpc-java_out=${project.build.directory}/generated-sources/protobuf/grpc-java</arg>
                    <!-- 指定grpc-java插件路径，插件会自动依赖对应版本 -->
                    <arg>--plugin=protoc-gen-grpc-java=io.grpc:protoc-gen-grpc-java:1.59.0:exe:${os.detected.classifier}</arg>
                </protocArgs>
                <!-- 让Maven识别生成的源码目录 -->
                <addSources>main</addSources>
                <addOutputDirectory>true</addOutputDirectory>
            </configuration>
        </execution>
    </executions>
    <!-- 添加grpc-java插件依赖 -->
    <dependencies>
        <dependency>
            <groupId>io.grpc</groupId>
            <artifactId>protoc-gen-grpc-java</artifactId>
            <version>1.59.0</version>
            <type>exe</type>
            <classifier>${os.detected.classifier}</classifier>
        </dependency>
    </dependencies>
</plugin>

额外注意事项 #

• 执行Maven命令时，确保工作目录为service-x/v1（或用mvn -f service-x/v1/pom.xml clean install指定pom路径），保证${project.basedir}能正确指向当前pom所在目录。
• 若要将生成的JAR发布到仓库，需在pom中配置正确的groupId、artifactId和version，方便其他服务依赖。

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