如何维护原始文件？

Question

我创建了 3 个 proto 文件并希望将其保存在 git repo 中：

与所有其他文件分开。 存储库仅包含 .proto 文件。我有 3 个微服务，每个微服务都有自己的存储库，使用这些 proto 文件相互通信：

您可以在上图中看到，proto 文件正在从不同的微服务中使用。

假设，我要更改 Protofile2 并将更改推送到 proto 存储库，记住 proto 文件存储库与微服务存储库分开：

当我在 service1 或 service2 上运行 go test 时，它应该告诉我，Protofile2 已更改或没有相同service2 文件夹中的类似于 proto 文件的哈希值：

我必须再次生成代码。

是否存在任何解决问题的工具？或者应该怎么解决？

Answer 1

这是我的建议：

• 将您的原型（及其生成的 makefile）存储在单个 git 存储库中。为简化导入，每个定义都应位于各自的目录中
• 使用版本标记 repo - 尤其是在潜在的重大更改时
• 从您的微服务中导入特定的 proto defs，例如import "github.com/me/myproto/protodef2"
• use go modules（2019年与go v1.11一起引入）确保微服务X获得兼容版本的protobuf Y

至第 2 点 - 正如@PaulHankin 所提到的 - 尽量不要破坏向后兼容性。可以删除 Protobuf 字段，但只要剩余的字段索引不变，旧的客户端调用仍将与新的 proto defs 兼容。

Answer 2

通常会尝试使协议缓冲区向后兼容，以便依赖于原始文件的服务在原始文件更改时不一定需要更改。见https://developers.google.com/protocol-buffers/docs/proto3#updating

但是，如果您想检查，可以使用proto.GetProperties(msgType) 编写测试。将预期的结构属性放入文字中，并使用reflect.DeepEqual 将其与通过在原型的动态类型上调用proto.GetProperties 获得的动态结构属性进行比较。像这样的：

func TestMyProtoStructVersion(t *testing.T) {
    gotProps := proto.GetProperties(reflect.TypeOf(&mypb.MyProtoStruct{}))
    if !reflect.DeepEqual(gotProps, wantMyProtoStructProps) {
        t.Errorf("MyProtoStruct proto has changed")
    }
}

您可以使用go generate 自动创建一个文件，该文件包含您可以包含在测试中的协议缓冲区的预期结构属性 (wantMyProtoStructProps)。