如何在服务之间共享gRPC协议定义

Question

我指定了许多独立的gRPC服务，这些服务将全部托管在同一个服务器进程之外。每个服务都在其自己的protobuf文件中定义。然后通过gRPC工具运行这些工具，为我提供目标语言（在我的情况下是c语言），然后我可以在其中实现我的服务器和客户端。

这些单独的API中的每一个都使用了许多公共元素，如错误响应枚举、空消息类型（这似乎在gRPC WellKnownTypes中可用；但我也看不到如何包含这些元素，所以我定义了自己的）。

目前，我的每个原型都将重复的枚举和类构建到自己的命名空间中。虽然我知道我可以在一个通用的proto文件中共享这些定义，并将其包括在内；我不知道如何将这些代码中的一个代码生成到公共名称空间中。虽然这样做有效，但将其保持在一组会更整洁；如果执行诸如跨服务聚合错误之类的操作，它在以后的转换和等价性方面也可能会有问题。

我假设我错过了一些东西，因为我对WellNotnTypes命名空间等事物的阅读表明这应该是可能的，但如前所述，我也不明白我如何在Proto中引用它。

所以目前在gRPC上看起来很轻，所以我的搜索没有出现太多，我是新手，所以有什么建议吗？

Answer 1

协议缓冲区通过使用不同的包标识符来解决这个问题。每条消息都将放置在不同的协议缓冲区特定包中，该包独立于C#命名空间。例如：

// common.proto
syntax "proto3";
package my.api.common;

option csharp_namespace = "My.Api.Common";

message Shared {
  // ...
}

然后在服务特定文件中：

// service1.proto
syntax "proto3";
package my.api.service1;

import "common.proto";

option csharp_namespace = "My.Api.Service1";

message Special {
    my.api.common.Shared shared = 1;
}

您需要确保公共proto只有一个副本，否则它们可能会失去同步。您可以将常见消息放在公共消息中。proto文件，并从每个特定的其他proto文件中引用它们。