如何避免在 buf generate 上复制供应商 proto 依赖项答案

【问题标题】：How to avoid copying vendor proto dependencies on buf generate如何避免在 buf generate 上复制供应商 proto 依赖项
【发布时间】：2020-11-18 10:40:17
【问题描述】：

我正在测试 grpc-gateway 并试图找出在我的 grpc 服务中导入依赖项的最佳方法。我有以下目录结构：

proto/
  api.proto
  api2.proto
third_party/
  googleapis/
    google/
      api/
        http.proto
        annotations.proto
buf.yaml
buf.gen.yaml

buf.yaml 配置

version: v1beta1
build:
  roots:
    - third_party/googleapis
    - third_party/grpc-gateway
    - proto

两件事

您注意到我正在使用buf.build 来生成原始文件（如果您知道更好的方法，可以忽略这个事实）；
我不是故意将googleapi 复制到原始文件下，而是希望将它们分开存放在某个地方。我知道 google 建议将所有内容保存在 proto 文件夹下并仅复制依赖文件（如 google/api/annotations.proto），但如果我能以某种方式避免这种情况，我不喜欢将数十个依赖项复制到我的源代码中。

我的问题是，每当我运行buf generate --path=./proto（请注意路径设置为目录）时，我都会在proto/googleapis/ 文件夹下复制googleapis pb.go 文件。我觉得这很烦人，无法弄清楚我的设置有什么问题。如果我直接指定每个文件，一切都很好（例如buf generate --path=./proto/api.proto），不会复制任何第三方内容。

有没有办法忽略buf generate 上的third_party 文件夹，如果没有，是否有更好的方法来管理grpc 依赖项。直接将文件复制到每个 grpc 项目对我来说确实有意义。

【问题讨论】：

标签： go protocol-buffers grpc grpc-gateway

【解决方案1】：

好的，想通了。通常，您要么重用 go/src 文件夹中的 protos（由于 repo 更新而存在缺点），要么将它们复制到 proto/dependency-x 文件夹中。

我发现 buf 在这里采取了更好的方法，但是您必须遵循 proto 结构化指南，简而言之：structure proto files under same root, in different packets。因此，为了避免复制，我必须具有以下结构：

proto/
  api/ <- add one more level
    api.proto
    api2.proto
third_party/
  googleapis/
    google/
      api/
        http.proto
        annotations.proto
buf.yaml
buf.gen.yaml

并将缓冲区指向api 文件夹，如下所示：buf generate --path=./proto/api

【讨论】：