0

0

Golang Web项目常见目录结构如何设计_Golang项目结构规范说明

P粉602998670

P粉602998670

发布时间:2026-01-30 15:48:55

|

543人浏览过

|

来源于php中文网

原创

main.go 应放在 cmd/ 目录下按服务拆分,如 cmd/api/main.go;internal/ 用于模块内复用且对外隔离的代码;config/ 存项目级配置逻辑,pkg/ 存可跨项目复用的组件;HTTP 处理层推荐用 http/ 或 api/,避免 routes/、web/ 等模糊命名。

golang web项目常见目录结构如何设计_golang项目结构规范说明

main.go 放哪?别塞进根目录

Go 项目启动入口 main.go 必须放在可执行包(package main)里,但不建议直接丢在项目根目录。根目录塞太多东西会干扰 go mod init 和 IDE 识别——比如 go list ./... 可能意外包含测试工具或配置脚本。

推荐做法是建一个 cmd/ 目录,按服务拆分子命令:

  • cmd/api/main.go —— HTTP 服务主入口
  • cmd/migrate/main.go —— 数据库迁移工具
  • cmd/admin/main.go —— 后台管理 CLI

这样 go build -o bin/api cmd/api 路径清晰,也方便 CI 分别构建不同二进制。

internal/ 不是摆设,它管的是“不能被外部 import”的代码

internal/ 是 Go 官方约定的私有包路径,任何在 internal/ 下的包,只有其父目录或同级目录的模块才能导入。比如 github.com/user/project/internal/handler 只能被 github.com/user/project/cmd/apigithub.com/user/project/internal/service 导入,第三方无法 import 它。

立即学习go语言免费学习笔记(深入)”;

常见误用:

  • 把通用工具函数(如 utils.StringToTime)放 internal/utils → 应该挪到 pkg/utils 或直接开独立小模块
  • internal/ 里写数据库模型(model.User),结果 cmd/apicmd/migrate 都要重复定义 → 模型应统一放在 internal/model,由各 cmd 显式引用

记住:internal/ 的边界是「模块内复用 + 对外隔离」,不是「随便藏代码的地方」。

Cutout.Pro
Cutout.Pro

AI驱动的视觉设计平台

下载

config/ 和 pkg/ 怎么分?看是否跨项目复用

config/ 存当前项目的加载逻辑:解析 config.yaml、绑定环境变量、校验必填字段。它的结构通常紧贴运行时需求,比如:

config/
├── config.go          // Load() + Validate()
├── config_test.go
└── sample.yaml

pkg/ 则是真正可剥离的、带明确接口契约的组件。例如:

  • pkg/logger —— 封装 zerolog,暴露 Logger 接口和 NewLogger()
  • pkg/db —— 封装 sqlx 初始化、连接池配置,不暴露具体 driver
  • pkg/httpclient —— 带默认超时、重试、metrics 上报的 client 工厂

如果某段代码只在这个项目里用,且不打算抽成独立 GitHub repo,就别硬塞 pkg/;反过来,如果已经写了 pkg/cache 但发现其他项目也要用,那就该单独 go mod init github.com/user/cache 拆出去。

handlers/ 和 api/ 目录名之争:优先选语义明确的

HTTP 路由处理层命名混乱很常见:handlers/controllers/api/http/……实际没标准,但要注意两点:

  • 名字得让新成员一眼看出「这里只做请求接收、参数解析、响应包装,不写业务逻辑」
  • 避免和已有 Go 生态术语冲突,比如 controllers/ 容易让人联想到 Gin 的 gin.HandlerFunc,但如果你用的是 net/http 原生路由,反而造成认知偏差

更稳妥的选择是:

  • http/ —— 表明技术,适合强调协议层职责(如中间件、路由注册、错误转 HTTP 状态码
  • api/ —— 表明领域,适合已划分清楚「API 层 vs Service 层」的团队,且 API 版本管理(v1/v2)会自然落到这个目录下

别用 routes/ —— 它只是个注册动作,不是职责主体;也别用 web/ —— 太宽泛,CLI 或 gRPC 服务也可能跑在 web server 上。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

182

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

229

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

343

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

210

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

396

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

240

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

194

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

458

2025.06.17

C++ 设计模式与软件架构
C++ 设计模式与软件架构

本专题深入讲解 C++ 中的常见设计模式与架构优化,包括单例模式、工厂模式、观察者模式、策略模式、命令模式等,结合实际案例展示如何在 C++ 项目中应用这些模式提升代码可维护性与扩展性。通过案例分析,帮助开发者掌握 如何运用设计模式构建高质量的软件架构,提升系统的灵活性与可扩展性。

9

2026.01.30

热门下载

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

精品课程

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

共21课时 | 3.1万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.5万人学习

Git中文开发手册
Git中文开发手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号