Spring Boot集成Go编写的gRPC接口：Stub类缺失问题排查

可能的原因 #

• .proto文件缺少服务定义：如果你的.proto里只定义了message结构，没有声明service块，protoc只会生成消息对应的Java类，不会生成MyServiceGrpc这类包含存根的服务类。必须有明确的gRPC服务接口定义才会触发存根生成。
• protoc命令未指定gRPC Java插件：生成普通Java消息类只需要--java_out参数，但生成gRPC服务存根必须指定grpc-java插件的输出参数--grpc-java_out，没加这个参数的话，自然不会生成存根类。
• 版本不兼容：protoc版本和grpc-java插件版本不匹配，比如用了过旧的protoc搭配较新的插件，可能导致存根生成失败且无明显报错。
• 文件路径或复制遗漏：protoc生成的存根文件可能在你没注意到的目录里，或者复制文件时只拷贝了消息类，漏掉了带Grpc后缀的服务存根文件。

解决建议 #

1. 检查并补全.proto的服务定义
   确保.proto文件包含完整的服务声明，示例格式：

   syntax = "proto3";
   package com.example.grpc;
   
   // 请求消息
   message MyRequest {
       string data = 1;
   }
   
   // 响应消息
   message MyResponse {
       string result = 1;
   }
   
   // gRPC服务定义
   service MyService {
       rpc myMethod(MyRequest) returns (MyResponse);
   }
   

2. 重新执行带gRPC插件的生成命令
   执行protoc时必须包含--grpc-java_out参数，同时指定插件路径（如果插件不在系统PATH里），示例命令：

   protoc --java_out=./src/main/java \
          --grpc-java_out=./src/main/java \
          --plugin=protoc-gen-grpc-java=/usr/local/bin/protoc-gen-grpc-java \
          ./src/main/proto/my_service.proto
   

   如果你用Maven/Gradle插件管理生成，要确保插件配置开启了gRPC存根生成：

   • Maven：在protobuf-maven-plugin里添加grpc-java目标
   • Gradle：确保引入了io.grpc:grpc-gradle-plugin，并让generateProto任务包含gRPC生成逻辑

3. 核对版本兼容性
   确保protoc版本和grpc-java插件版本匹配，建议参考grpc-java官方版本对应关系，比如protoc 3.20+搭配grpc-java 1.40+版本，避免因版本差异导致生成失败。

4. 检查生成文件并完整复制
   执行生成命令后，去指定的输出目录（比如com/example/grpc）下查找MyServiceGrpc.java文件，确认存在后，将其和消息类一起复制到Spring Boot项目的对应包路径下。

5. 验证依赖配置
   确保Spring Boot项目的Maven/Gradle依赖包含gRPC核心组件，版本保持一致：

   • Maven依赖示例：

     <dependencies>
         <dependency>
             <groupId>io.grpc</groupId>
             <artifactId>grpc-netty-shaded</artifactId>
             <version>1.59.0</version>
         </dependency>
         <dependency>
             <groupId>io.grpc</groupId>
             <artifactId>grpc-protobuf</artifactId>
             <version>1.59.0</version>
         </dependency>
         <dependency>
             <groupId>io.grpc</groupId>
             <artifactId>grpc-stub</artifactId>
             <version>1.59.0</version>
         </dependency>
         <!-- Java 9+ 需添加 -->
         <dependency>
             <groupId>org.apache.tomcat</groupId>
             <artifactId>annotations-api</artifactId>
             <version>6.0.53</version>
             <scope>provided</scope>
         </dependency>
     </dependencies>
     

   • Gradle依赖示例：

     dependencies {
         implementation 'io.grpc:grpc-netty-shaded:1.59.0'
         implementation 'io.grpc:grpc-protobuf:1.59.0'
         implementation 'io.grpc:grpc-stub:1.59.0'
         compileOnly 'org.apache.tomcat:annotations-api:6.0.53'
     }
     

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