protocol-buffers - 我可以将 gRPC 原型(prototype)定义组合成多个原型(prototype)文件吗？

Question

我有一个像这样的 gRPC API 定义(来自 Akka 文档示例)，但要长得多(4000 行只是 service 部分)。

service GreeterService {
    rpc SayHello (HelloRequest) returns (HelloReply) {}

    rpc ItKeepsTalking (stream HelloRequest) returns (HelloReply) {}

    rpc ItKeepsReplying (HelloRequest) returns (stream HelloReply) {}

    rpc StreamHellos (stream HelloRequest) returns (stream HelloReply) {}
}

但是，RPC 列表现在变得太长了，我想以某种方式将其“分解”为多个文件，以便文件更具可读性。像这样

// file 1:
service GreeterServicePartA {
    rpc SayHello (HelloRequest) returns (HelloReply) {}

    rpc ItKeepsTalking (stream HelloRequest) returns (HelloReply) {}
}

// file 2:
service GreeterServicePartB {
    rpc ItKeepsReplying (HelloRequest) returns (stream HelloReply) {}

    rpc StreamHellos (stream HelloRequest) returns (stream HelloReply) {}
}

// main proto file:
import "file1"
import "file2"
service GreeterService = GreeterServicePartA + GreeterServicePartB

即使只是在不同的文件中分别定义 RPC，然后编写类似这样的内容也会对我有所帮助:

service GreeterService {
    rpc SayHello = importedSayHello

    rpc ItKeepsTalking = importedKeepsTalking

    rpc ItKeepsReplying = importedKeepsReplying

    rpc StreamHellos = importedStreamHellos
}

是否有可能以某种方式在 gRPC 原型(prototype)定义中像那样“组合”服务？

Answer 1

你不应该有那么大的服务。如果它已经增长到 4000 行，这听起来像是所有方法的垃圾场。我希望其中大部分是文档……通常我会期望更多的服务基于更大的 API 的子集。例如，假设我有 MyAndroidAppService，它可以成为垃圾场。但我可以将其设计为 MyAndroidAppConfigService、MyAndroidAppNotificationService、MyAndroidAppChatService(假设是一个非常复杂的应用程序，具有很多方法)。

但是既然您已经拥有这样的服务，您能做些什么呢？您不能将 service 定义拆分为多个文件。如果您将服务定义拆分为多个新服务，将会破坏 gRPC 的线路兼容性。

您最多可以将message 定义移动到一个单独的文件中，然后使用正常的import mechanism。 .由于将消息移动到不同的文件会导致生成的代码中的 API 不兼容，因此您可以改用 import public "path/to/messages.proto"。