RPC 应用中 Protobuf 文件合理目录规划

在 Go RPC 应用程序开发中，处理 Protobuf (.pb.go) 文件的存储位置和目录结构至关重要。这些文件在服务端和客户端之间共享，因此需要精心安排以确保代码的可维护性。

目录结构参考

一个合理的目录结构可以如下：

• github.com/example/myapp

  • protos

    

    fastgithub

    提供本地代理服务器以加速 GitHub 访问，显著提升 Linux、macOS、Windows 下克隆、推送和下载的速度。

    下载
    • common (存放通用的 Protobuf 文件，如数据类型、枚举和错误消息)

    • services

      • user (针对特定服务的 Protobuf 文件)
      • product (针对特定服务的 Protobuf 文件)

  • server (存放服务端代码)

    • protos (Protobuf 文件的本地副本)

  • client (存放客户端代码)

    • protos (Protobuf 文件的本地副本)

Protobuf 文件位置的考量因素

• 重用性：Protobuf 文件经常在多个服务或模块中重用。将其集中存储在单独的仓库或模块中便于重用，并有助于保持文件的版本控制。
• 可访问性：客户端和服务端都需要访问 Protobuf 文件。将它们放在一个中央位置可确保双方都可以轻松找到和更新它们。
• 可维护性：代码维护和重构应该尽可能简单。将 Protobuf 文件组织到一个逻辑结构中有助于轻松管理和更新更改。

建议的解决方案

如问题答案所述，一个好的做法是创建一个专门的 Git 仓库来存储 Protobuf 文件。这提供了以下好处：

• 中央存储：所有项目都可以通过引用此存储库来访问 Protobuf 文件。
• 版本控制：Git 提供了对文件更改的版本控制，简化了更新和回滚。
• 独立性：Protobuf 文件与其他代码基分离，使其更加模块化和可扩展。