Go protobuf 中单独消息和服务定义的最佳实践?

问题描述

在(Go 特定的)Protocol Buffers 中分离服务中使用的消息声明的最佳实践是什么?上下文是具有多个 gRPC 服务的大型应用程序。一些消息用于多个服务。想法是将消息和服务的定义分开,像这样(简化一点):

airline/pb/airline_messages.proto

Syntax = "proto3";
option go_package = "github.com/example.com/example-repo/airline/pb";

message Airline {
    string code = 1;
    string name = 2;
    string country = 3;
}

airline/pb/airline_services.proto

Syntax = "proto3";
option go_package = "github.com/example.com/example-repo/airline/pb";
import "airline/pb/airline_messages.proto"

service Airlineservice {
    rpc GetAirline(string) returns (Airline) {}
    rpc GetAirlines(GetAirlinesRequest) returns (repeated Airline) {}
}

message GetAirlinesRequest {
    int max = 1;
    string country = 2;
    string pattern = 3;
    string sortby = 4;
}

我这样称呼protoc

protoc --go_out=. \
   --go_opt=paths=source_relative \
   --go-grpc_out=. \
   --go-grpc_opt=paths=source_relative \
   --proto_path=. \
   --proto_path=../../ airline_services.proto

这不起作用,因为 Airline 未定义。像这样调用它:

protoc ... airline_services.proto airline_messages.proto

生成一条错误消息,航空公司是多重定义的。这样做:

protoc ... airline_messages.proto
protoc ... airline_services.proto

只是覆盖 Go 文件,相当于只编译 airline_services.proto

能够在多个服务中重用消息定义的最佳做法是什么?

解决方法

不确定它是否有帮助,或者您是否使用了不同版本的 Go 生成器。

我在一个目录中有多个 *.proto 文件。其中一些导入其他:

device.proto 导入 status.proto 的一部分:

syntax = "proto3";

package somePackage;

import "status.proto";

option go_package = "goPackageName";

service Device {
    rpc GetStatus (GetStatusRequest) returns (Status) {}
}

message GetStatusRequest {
    // ...
}

status.proto 包含 Status 消息:

syntax = "proto3";

package somePackage;

option go_package = "goPackageName";

message Status {
    int32 customer = 1;
    string device_id = 2;
    // ...
}

我使用以下代码生成 Go 代码:

protoc --go_out=plugins=grpc:. --go_opt=paths=source_relative *.proto

注意:我仍在使用旧的 Go protobuf github.com/golang/protobuf