讲师中心 微信公众号

工具推荐

视频效率加速
Laper
Laper

剧本策划到成片协作

AniShort
AniShort

AI短剧协同制作平台

剧云
剧云

中文短剧剧本制作平台

updream

一键生成高质量推广成片

如何为Golang项目设计基础模块_Golang项目模块化架构方案

落枫酱_5824

落枫酱_5824

发布时间:2026-01-13 09:55:02

|

540人浏览过

|

来源于php中文网

原创

Go项目模块化需遵循职责收敛与依赖可控,严格划分domain(纯业务结构)、internal(实现层,禁止跨包直接调用)、pkg(通用工具),service返回domain对象而非DTO或DB实体,错误统一用errno管理,main.go仅负责依赖组装。

如何为golang项目设计基础模块_golang项目模块化架构方案

Go 项目模块化不是靠盲目拆包,而是围绕「职责收敛」和「依赖可控」来设计。没有统一模板,但有几条硬约束必须遵守:不允许循环导入、main 包不放业务逻辑、领域模型不能跨 domain 泄露。

如何划分 domain / internal / pkg 目录边界

这是最容易混乱的起点。三个目录不是按“大小”或“热度”分的,而是按「抽象层级」和「可见性」:

  • domain/:只放纯结构体、接口、核心业务规则(如 User、OrderStatusTransition),不依赖任何外部库,也不含数据库字段标签或 HTTP 注解
  • internal/:实现层,包括 internal/user(用户服务)、internal/order(订单服务)等子包,可依赖 domain 和 pkg,但彼此之间禁止直接 import(用 interface 隔离)
  • pkg/:工具性、可复用、无业务语义的代码,比如 pkg/validator、pkg/httpx、pkg/trace;它可被 internal 和 cmd 引用,但不能引用 internal 或 domain

常见错误是把数据库 model 放进 domain,或让 internal/user 直接调用 internal/order 的函数——这会立刻导致循环依赖或测试无法隔离。

为什么 service 层必须返回 domain 对象而非 DTO 或 db 实体

service 是业务逻辑的守门人,它的返回值决定了上层(API 或 job)能“看到什么”。如果 service 返回 *sqlc.UserRow 或 map[string]interface{},就等于把数据层细节和序列化逻辑泄露出去,后续加缓存、换 ORM、改 API 字段时全得跟着动。

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

JSON Toolkit
JSON Toolkit

JSON文件多功能工具。支持格式化、验证、压缩、键排序及点记法路径查询。零依赖。

下载
  • 正确做法:service 方法签名始终返回 domain.User、[]domain.Order 等类型
  • 转换动作收口在 handler 或 adapter 层(如 http/handler/user.go 调用 userSvc.GetByID() 后,再映射到 http.UserResponse)
  • 好处:单元测试只 mock service 接口,不关心 JSON tag、gRPC proto 或 GORM struct tag 怎么写

如何安全地共享 error 类型和错误码

Go 的 error 是值,不是类,所以不能靠类型断言跨包识别业务错误(比如 errors.Is(err, user.ErrNotFound) 在别处不可靠)。必须统一管理:

  • 定义全局错误码枚举:在 pkg/errno 下用 const 声明 ErrUserNotFound = 40401、ErrOrderInvalid = 40002
  • 所有 error 构造使用 errno.New(ErrUserNotFound, "user not found"),该函数返回实现了 errno.Coder 接口的 error
  • handler 中统一用 err.(errno.Coder).Code() 提取码,不依赖字符串匹配或包路径

否则你会在日志里看到一堆 "user not found",却无法区分是 auth 模块还是 user 模块抛的,也无法做精细化监控告警。

main.go 只负责组装,不写任何逻辑

cmd/yourapp/main.go 应该薄得像张纸:初始化 config → 构建依赖树(DB、cache、logger)→ 注册 service 实例 → 启动 HTTP/gRPC server。里面不能出现 if/else、SQL 查询、HTTP 请求、甚至 fmt.Println。

func main() {
	cfg := config.Load()
	db := postgres.New(cfg.DB)
	userRepo := postgres.NewUserRepo(db)
	userSvc := user.NewService(userRepo) // 依赖注入完成
	srv := http.NewServer(cfg.HTTP, userSvc)
	srv.Run()
}

一旦 main.go 开始处理业务分支或调用第三方 API,模块边界就塌了——你将失去独立启动某个子服务的能力,也很难对单个 domain 做集成测试。

真正难的不是目录怎么起名,而是每次新增一个函数前,问自己:它属于哪一层?它暴露了什么细节?它会让谁因此无法被替换?

热门AI工具

更多
立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

讯飞智文

一款面向学习和办公场景的AI文档创作工具,可辅助生成PPT与Word文档,提高资料整理和内容制作效率。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

相关专题

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

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

539

2024.02.23

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

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

616

2024.02.23

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

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

1316

2024.02.23

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

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

811

2024.03.05

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

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

1926

2024.05.21

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

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

5514

2025.06.09

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

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

2554

2025.06.10

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

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

4406

2025.06.17

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

120

2026.11.12

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.4万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn