时间戳

首页 > 解决方案 > protoc 命令未生成所有基类（java）

protocol-buffers - protoc 命令未生成所有基类（java）

问题描述

我一直在尝试从 grpc 官方 repo 的服务定义中生成基本的 gRPC 客户端和服务器接口.proto。该文件中定义的相关服务（来自上面的链接）如下：

service RouteGuide {
    rpc GetFeature(Point) returns (Feature) {}
    rpc ListFeatures(Rectangle) returns (stream Feature) {}
    rpc RecordRoute(stream Point) returns (RouteSummary) {}
    rpc RouteChat(stream RouteNote) returns (stream RouteNote) {}
}

我运行的命令是protoc --java_out=${OUTPUT_DIR} path/to/proto/file

根据 grpc 站点（特别是这里），aRouteGuideGrpc.java包含一个基类RouteGuideGrpc.RouteGuideImplBase，RouteGuide 服务中定义的所有方法都应该是从protoc上面的命令生成的，但该文件没有为我生成。

有没有人遇到过类似的问题？官方文档根本不正确吗？有人对我能做些什么来生成那个缺失的课程有什么建议吗？

标签： protocol-buffersgrpcgrpc-javaprotobuf-java

解决方案

这可能会在将来对其他人有所帮助，所以我会回答我自己的问题。

我相信用于 gRPC 代码生成的 java 文档并不完全是最新的，并且信息分散在不同的官方存储库中。

事实证明，为了按预期生成所有 gRPC java 服务基类，您需要protoc像这样为 cli指定一个附加标志grpc-java_out=${OUTPUT_DIR}。但是为了让那个额外的标志起作用，你需要有一些额外的东西：

  1. gRPC Java 的 protoc 插件的二进制文件：您可以从此处protoc-gen-grpc-java的maven Central 获取适用于您系统的相关文件（链接适用于 v1.17.1）。如果您的系统没有可用的预构建二进制文件，您可以从此处的 github 存储库说明中自己编译一个。

  2. 确保将二进制位置添加到您的 PATH 环境变量中，并将二进制重命名为“ protoc-gen-grpc-java”（即protoccli 期望在路径中具有的名称）。

  3. 最后，您已准备好运行正确的命令，现在应该生成以前没有protoc --java_out=${OUTPUT_DIR} --grpc-java_out=${OUTPUT_DIR} path/to/proto/file的服务基类。RouteGuideGrpc.RouteGuideImplBase

我希望这个解释可以帮助其他人在未来。

推荐阅读