如何为不同的gRPCendpoint重用proto-buffer消息？

Question

我有一个Go应用程序，它使用原始缓冲区（准确地说是原型3）。

此应用程序有两个endpoint，A和B定义如下：

rpc A(ARequest) returns (AResponse) {
  option (google.api.http) = {
    post: "/someURLA"
    body: "*"
  };
}
rpc B(BRequest) returns (BResponse) {
  option (google.api.http) = {
    put: "/someURLB"
    body: "*"
  };
}

以下是他们使用的消息：

message ARequest {
    // Blah Blah Blah
}

message BRequest {
    // Blah Blah Blah   
}

message AResponse {
    // Blah Blah Blah
}

message BResponse {
    // Blah Blah Blah   
}

endpointA和B实际上需要相同的输入格式和输出格式。因此，ARequest与BRequest相同，而AResponse与BResponse相同。但是，原始文件中这些重复的定义是非常浪费的，可能会产生分歧。所以我改成这样：

rpc A(AOrBRequest) returns (AOrBResponse) {
  option (google.api.http) = {
    post: "/someURLA"
    body: "*"
  };
}
rpc B(AOrBRequest) returns (AOrBResponse) {
  option (google.api.http) = {
    put: "/someURLB"
    body: "*"
  };
}

message AOrBRequest {
    // Blah Blah Blah
}

message AOrBResponse {
    // Blah Blah Blah
}

但是当我这样做的时候，我在编译过程中遇到了这些错误：

Name of request type "AOrBRequest" should be "ARequest".
Name of response type "AOrBResponse" should be "AResponse"
Name of request type "AOrBRequest" should be "BRequest".
Name of response type "AOrBResponse" should be "BResponse"

那么如何让这两个endpoint对请求和响应重用相同的消息呢？




Answer 1

可以使用import语句重用消息定义。

您可以通过导入其他. proto文件来使用它们中的定义。要导入另一个. proto的定义，您可以在文件顶部添加一个导入语句：

import "myproject/other_protos.proto";

例如，如果您下载了协议缓冲区二进制包，存档中的readme.txt会显示：

如果要使用包含的已知类型，请不要忘记将include目录的内容也复制到某处，例如复制到usr/local/include/code中。

如果您已经这样做了，您现在可以导入（或重复使用，如您所说）Google定义的消息。

syntax = "proto3";

package mypackage;

import "google/protobuf/empty.proto";
import "google/protobuf/timestamp.proto";

service Bla {
    rpc ResetUserPW(UserEmail) returns (google.protobuf.Empty) {}
    rpc ServerTime(google.protobuf.Empty) returns (google.protobuf.Timestamp) {}
}

message UserEmail {
    string email = 1;
    CallBackUrl url = 2;
}