GO 学习笔记之零 （一）GO推荐的工程目录结构

1、工程目录结构

GOPATH/
    src/
        myproject/
            cmd/
                myapp/
                    main.go
            pkg/
                utils/
                    utils.go
            internal/
                secret/
                    secret.go
            api/
            web/
            scripts/
            configs/
            test/
            vendor/
            .gitignore
            LICENSE
            README.md
            go.mod
            go.sum

 

2、说明

• GOPATH：这是你的工作目录，所有Go项目代码都会放在这个目录下的src子目录中。
• myproject：你的项目名，这个目录会在GOPATH/src下创建。
• cmd：包含所有的命令行应用入口文件。
• myapp：你的应用名，包含了应用的入口文件main.go。
• pkg：包含可以被其他项目导入和使用的代码。
• utils：工具包名，包含了一些公共的工具函数。
• internal：包含不打算被其他项目导入和使用的内部代码。
• secret：包含秘密信息的代码，比如配置文件等。
• api：包含 API 定义文件，如 OpenAPI/Swagger 规范、gRPC 文件等。
• web或ui目录：如果项目包含前端代码，通常会有这个目录。
• configs：包含配置文件模板或默认配置。
• test：包含额外的外部测试应用程序和测试数据。这与单元测试不同，单元测试通常与它们测试的代码位于同一个目录中。
• scripts：包含用于执行各种构建、安装、分析等操作的脚本。
• vendor：用于存放依赖的第三方库。
• .gitignore：Git版本控制忽略文件列表。
• LICENSE：项目许可证。
• README.md：项目的README文件。
• go.mod：Go模块依赖定义文件。
• go.sum：Go模块依赖的校验和记录文件。