新手入门:如何看懂一个典型的Go项目标准目录结构

46 阅读1分钟

核心目录

  • /cmd: 程序入口目录
    • 每个应用独立子目录,包含main.go文件
  • /internal: 私有代码目录
    • 仅供内部使用,不可被外部导入
  • /pkg: 公共代码目录
    • 可被其他项目引用的代码库

接口与前端

  • /api: API相关文件
    • 包含API定义、Swagger文档等
  • /web: Web应用资源
    • 存放静态文件、模板等

配置与脚本

  • /configs: 配置文件目录
  • /scripts: 项目脚本目录
  • /build: 编译打包相关
  • /deployments: 部署配置文件

文档与测试

  • /docs: 项目文档
  • /test: 测试相关
  • /examples: 使用示例

依赖与资源

  • /third_party: 第三方工具
  • /vendor: 项目依赖
  • /assets: 资源文件
  • /website: 项目官网

根目录文件

常见文件:

  • README.md
  • Makefile
  • go.mod
  • .gitignore

注意:可根据实际需求适当调整目录结构,保持结构清晰和易维护为原则。