Maven项目编译Protobuf后缺失HelloServiceImplBase类求助

核心原因 #

你直接使用protoc --java_out命令只会生成消息结构相关的Java类，而HelloServiceImplBase是gRPC框架提供的服务抽象基类，需要通过gRPC专属的protoc插件才能生成，原生protoc不处理gRPC服务的代码生成逻辑。

解决方法 #

方法1：手动使用gRPC插件编译

确保你已经安装了protoc-gen-grpc-java插件（可从gRPC官方仓库下载对应系统版本，或通过Maven获取），然后执行带--grpc-java_out参数的编译命令：

protoc --java_out=DataLink_Parser/backend/src/main/java/com/backend \
       --grpc-java_out=DataLink_Parser/backend/src/main/java/com/backend \
       DataLink_Parser/backend/src/main/java/com/backend/HelloService.proto

如果插件不在系统PATH中，需通过--plugin参数指定插件路径，例如：

protoc --java_out=xxx \
       --grpc-java_out=xxx \
       --plugin=protoc-gen-grpc-java=/path/to/protoc-gen-grpc-java \
       your-proto-file.proto

方法2：用Maven插件管理编译（推荐，适配你的Maven项目）

手动命令容易出错，Maven插件能自动处理依赖和编译流程，在pom.xml中添加以下配置：

1. 配置protobuf-maven插件：

<build>
  <extensions>
    <extension>
      <groupId>kr.motd.maven</groupId>
      <artifactId>os-maven-plugin</artifactId>
      <version>1.7.0</version>
    </extension>
  </extensions>
  <plugins>
    <plugin>
      <groupId>org.xolstice.maven.plugins</groupId>
      <artifactId>protobuf-maven-plugin</artifactId>
      <version>0.6.1</version>
      <configuration>
        <protocArtifact>com.google.protobuf:protoc:3.24.4:exe:${os.detected.classifier}</protocArtifact>
        <pluginId>grpc-java</pluginId>
        <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.59.0:exe:${os.detected.classifier}</pluginArtifact>
        <!-- 建议把proto文件移到src/main/proto目录下，符合Maven规范 -->
        <protoSourceRoot>${project.basedir}/src/main/proto</protoSourceRoot>
      </configuration>
      <executions>
        <execution>
          <goals>
            <goal>compile</goal>
            <goal>compile-custom</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

2. 添加gRPC依赖：

<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>

配置完成后，执行mvn clean compile，插件会自动生成消息类和HelloServiceImplBase等gRPC服务相关类。

额外检查

确认你的proto文件服务定义正确，示例如下：

syntax = "proto3";

package com.backend;

message HelloRequest {
  string name = 1;
}

message HelloResponse {
  string message = 1;
}

service Hello {
  rpc SayHello(HelloRequest) returns (HelloResponse);
}

内容的提问来源于stack exchange，提问作者Hüsnü Ayaz