Go 语言标准目录结构(Project Layout)该怎么安排?

落雪吖_4015

落雪吖_4015

2026-05-01

228人浏览

原创

/cmd目录不是Go编译器硬性要求,而是社区标准约定,用于支持多二进制构建、强化关注点分离及保障internal包的编译器级隔离;扁平化会触发“multiple main packages”错误,且破坏模块边界与可维护性。
/cmd 目录必须存在,且每个可执行文件对应一个子目录,这是 Go 编译器识别入口的硬性约定,不是风格偏好。

为什么 /cmd 不能扁平化或合并?

go 的 go build 命令依赖 /cmd 下的独立子目录结构来区分不同二进制产物。如果你把两个 main.go 放进同一目录,go build 会报错:multiple main packages;如果直接放在根目录,又违反了标准布局的模块边界原则,导致 internal 包无法被正确隔离。

  • /cmd/myapp/main.go → 构建出 myapp 二进制
  • /cmd/myworker/main.go → 构建出 myworker 二进制
  • 每个 main.go 只 import internal/app/xxx 和 pkg/xxx,绝不写业务逻辑

/internal 不是“内部用”,而是“编译器强制禁止外部导入”

Go 从 1.4 起就通过路径规则硬编码限制:任何以 /internal/ 开头的导入路径,若调用方不在其父目录树内,编译直接失败。这不是文档建议,是语言级保护机制。

使用Go语言搭建家庭相册系统-相关课件
使用Go语言搭建家庭相册系统-相关课件

使用Go语言搭建家庭相册系统-相关课件

下载
  • 错误示例:github.com/you/project/internal/config 被 github.com/others/lib 导入 → 编译报错 use of internal package not allowed
  • 正确组织:internal/app/myapp(主应用逻辑)、internal/pkg/database(仅本项目复用的工具)
  • 别在 /internal 里放接口定义——除非你确定这些接口绝不会被外部实现或 mock

/pkg 不是“放工具函数的地方”,而是“对外提供稳定 API 的公共库”

/pkg 是唯一允许被其他项目 go get 直接引用的目录,它的内容必须满足语义化版本(SemVer)兼容性要求。随便往里扔一个 utils 包,等于主动承担长期 API 兼容责任。

  • 适合放:pkg/httpclient(带 retry、timeout、metric 的 HTTP 客户端封装)
  • 不适合放:pkg/utils(含 StrToBool、NowStr 这类泛用函数——应归入 internal/pkg/utils)
  • 一旦发布 v1.0.0,pkg/mylib 的导出函数签名就不能破坏性变更,否则下游项目会构建失败
真正容易被忽略的是 go.mod 的位置和 replace 的使用时机:它必须位于项目根目录,且仅在开发调试阶段临时指向本地 pkg 修改,上线前必须删掉 replace 行——否则 CI 构建时会因路径解析失败而中断。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3049

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2268

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1200

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1158

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1336

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2098

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3340

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

15055

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程