Golang怎么设计项目目录规范_Golang如何按功能划分cmd internal pkg目录【指南】

轻敏酱_3246

轻敏酱_3246

2026-03-20

510人浏览

原创

cmd 目录仅存放 main 函数,负责解析配置、构建依赖、调用 app.Run();业务逻辑应置于 internal 或 pkg,其中 internal 为私有模块,pkg 为可复用的公共工具。

golang怎么设计项目目录规范_golang如何按功能划分cmd internal pkg目录【指南】

cmd 目录只放 main 函数,别塞业务逻辑

Go 项目里 cmd 是入口的“门面”,不是业务代码仓库。它的唯一职责就是初始化配置、启动服务、调用 internal 或 pkg 提供的接口。一旦你在 cmd/main.go 里写数据库查询、HTTP 路由注册、中间件组装——说明目录结构已经失控了。

常见错误现象:cmd/myapp/main.go 超过 200 行,里面有 sql.Open、http.HandleFunc、甚至硬编码的 JWT 密钥。

  • 每个可执行命令对应一个子目录(如 cmd/api、cmd/worker),避免混在一起
  • main() 函数里只做三件事:解析 flag / env、构造顶层依赖(如 logger、DB)、调用 app.Run() 这类封装好的启动函数
  • 不 import internal 以外的业务包(比如别直接 import models 或 handlers)

internal 和 pkg 的边界:能被外部复用才进 pkg

internal 是你的项目私有领地,Go 编译器会阻止其他模块 import 它;pkg 是你愿意对外暴露的“工具箱”。别因为“看着顺眼”就把通用函数扔进 pkg——得真有人在别的项目里想用它。

使用场景举例:你写了带重试的 HTTP client 封装,如果未来可能被公司其他 Go 服务复用,就放 pkg/httpclient;但如果只给本项目里的 worker 调用,就该在 internal/worker/httpclient 里。

  • pkg 下的代码必须有完整测试、明确文档注释(// Package httpclient provides...)
  • internal 可以用短命名(如 store、svc),pkg 命名要更稳定(如 httpx、uuidx)
  • 如果某个 pkg 模块只被本项目 import,且半年没被外部引用过,考虑迁回 internal

不要为了“规范”而建空目录或过度分层

刚起步的项目,internal/handler、internal/service、internal/repository 全都建好,但每个目录下只有 1 个文件、总共不到 50 行代码——这是在给自己加心智负担,不是工程化。

Golang Uber Dig
Golang Uber Dig

使用 uber-go/dig 在 Golang 中实现依赖注入——基于反射容器,提供 Provide/Invoke、dig.In/dig.Out 参数与结果对象,支持命名依赖等

下载

参数差异体现在演化节奏上:小项目从 internal/app 开始就够了;等 handler 超过 3 个、service 逻辑开始交叉、SQL 查询分散在多个地方时,再按关注点拆。

  • 先有 internal/app,里面放 App 结构体和 Run() 方法
  • 当路由逻辑膨胀,再拆出 internal/handler;当 DB 操作重复出现,再拉出 internal/repo
  • 避免出现 internal/core/domain/entity 这种四层嵌套——Go 不需要 DDD 的仪式感

go mod tidy 会暴露目录设计缺陷

运行 go mod tidy 后,如果提示 found packages xxx and yyy in ...,大概率是目录结构破坏了 Go 的包隔离规则:比如在 internal/api 和 internal/api/v2 里用了同名包名 api;或者把两个不同用途的模块放在同一目录却没拆包。

性能影响不大,但会让依赖图混乱,CI 里 go list -deps 输出难以解读,重构时不敢删目录。

  • 每个目录必须对应唯一包名,且包名应反映其角色(如 repo、cache、grpcsrv),不用跟目录名完全一致
  • internal 下禁止出现 main 包(除了 cmd)
  • 如果某目录下同时存在 .go 和 .proto 文件,确保 protoc 生成的代码不在同一包内,否则 go build 会报错

最常被忽略的是:目录名本身不是 API,真正影响协作的是包名 + import 路径 + 接口定义。别花一整天纠结 “该叫 dal 还是 data”,先让 internal/repo 能被 internal/handler 干净地依赖住再说。

golang免费学习笔记(深入):立即使用
在学习笔记中,你将探索golang的核心概念和高级技巧!

相关文章

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

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

下载

相关标签:

golang

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

相关专题

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

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

2023.06.20

3509

3

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

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

2023.07.25

2408

9

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

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

2023.08.02

1340

5

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

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

2023.08.09

1298

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

1396

5

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

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

2023.09.20

2298

7

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

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

2023.09.20

3780

8

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

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

2023.09.22

17635

6

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

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

2023.09.22

549

3

热门下载

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

精品课程

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