Golang项目结构设计（双存储下）
目录
- 总要
- 结构设计
- 控制层和服务层设计
- 服务层设计
- 数据访问层设计
- 数据仓库层设计
前要
我为什么会写这篇文章?
避免调用链混乱,代码可视性差等尴尬问题
包结构解释
|
|--routers 路由层
|--controllers 控制器层,负责逻辑判断和返回结果
|--service 服务层,主要是处理控制层传入的数据并进行业务处理
|--Dao 数据访问层 是服务层获取数据的接口包
|--repository 数据仓库层,把数据库和redis和其他存储都放在这个包下
|--component 组件包,是主要四层的补充,里面一般放不确定那层需要调用的东西
|--conf 配置包
|--conn 连接包,包括redis、mysql、id生成器的初始化链接
|--constname 常量包,包括默认值,业务响应码,业务响应信息,redis的Key
|--filter 过滤器,负责非法请求的拦截、非法词汇拦截、接口基本鉴权、身份鉴权等
|--initialize 初始化包,当使用多存储的时候，需要先把数据库的基本数据初始化内存数据库中，比如redis
|--middleware 中间件包，比如jwt等
|--util 工具包,主要是一些小工具的包
组件包和工具包的区别?
有人可能会在使用中对组件包和工具包有困惑，他们好像有共同之处,其实不然,对比而言的话。
不同之处:
组件的体积更为大一些，组件有可能有自己的结构体和方法,比如你需要定义一个set数据结构,除了本身Set数据结构以外,还有关于Set的方法.
工具的体积更为小一些,他可能只是一个小方法,比较小巧,而且比较零散。
相同之处
他们的共同之处在于:为了让代码更好的复用。
路由层
路由层的作用
供外部访问,不多说
结构设计
路由最好是分组设计,这样有比较好的逻辑边界,并且同一组的路由在一起,看代码可以一目了然。一般理由的分组按照模型分组即可。
控制层
控制层的作用:
1、负责获取和反解析前端发来的数据
2、做基本的逻辑判断,传入的数据是否正确和合法
3、将获取的数据传给服务层
4、把结果返回给前端
5、可能还开始和结束还包含日志记录
结构设计:
在这一层功能相对来说比较单一,比较简单,但是两点需要注意
1、视图模型VO(ViewModel)的定义,所以在控制器下应该有一个vo包专门存储视图模型
2、控制层的通用或者基础方法,比如需要有一个通用的反解析json方法和通用返回结果方法,这个可以放在base.go里面
3、上面说到了视图模型和基础方法的设计,具体的控制器和vo、base.go平级即可.
服务层
服务层的作用:
1、接收控制层传入的数据
2、对传入的数据进行业务判断,比如能否兑换礼品等
3、把视图模型的数据赋值给数据库模型
4、把业务处理结果返回给控制层
结构设计:
相对于其他层来说，服务层的处理逻辑相对复杂，需要注意以下:
1、你可能有通用方法封装,但是在封装时，对于复杂的操作应该单独封装,然后使用组合的方式二次封装。
2、对于服务层的返回值。在服务层应该至少有两个返回值(res string,err error),为什么要这么做呢,
对于res,这是业务返回结果,也就是用户看到的,这样控制层得到后可以大胆的直接返回给前端。
对于err,这是服务为什么得到res这个结果的原因,在最后统一记录日志帮助很大,并且日志代码并不污染业务代码。
DAO层
DAO层的作用:
1、从数据仓库中获取数据库
2、将获取到的数据返回给服务层
结构设计:
DAO层比较简单,可能并没有通用方法,在这里有一个点需要注意:
应为Go是面向组合开发,所以在DAO的结构设计的时候，我觉得这样是比较合理的：
Type UserDAO struct{
userRds *cache.UserRds
user *models.User
}
因为这里是两个数据仓库,一个redis,一个mysql,所以这里有两个字段,对应了两个数据仓库的操作,扩展的时候也比较方便
repository层(数据仓库层)
数据仓库层的作用:
1、从数据库仓库获取数据,redis、mysql等
2、向DAO层提供数据
结构设计:
数据仓库层功能单一,但是有两点需要注意:
1、多数据仓库的初始化连接部分并不应该出现在这个包,这个包只获取连接,操作数据即可。
2、当使用多数据仓库时,多个数据参考并不是你想象的那么界限分明,所以不要强制让他们边界,你可能写不下去代码。
3、在这个结构下的包设计是以数据仓库为基本标准的.比如你有redis和mysql,那么你应该有两个包
多层之间如何调用
你看到主要有路由层,控制层,服务层,DAO层,数据仓库层,这里面的调用关系是：
路由调用->控制层->服务层->DAO层->数据仓库层，不可以越级调用和相互调用,因为这样调用会导致调用链混乱,最后review代码的时候,苦不堪言.
conn包
连接包的作用
主要是管理初始化链接供外部调用,比如数据库初始化链接,redis初始化链接,以及id生成器初始化链接等。
结构设计
在这个包,基本都是平级关系,所以只需要创建对应的go文件即可。
在代码方面
1、被调用方法尽量不进行错误处理和判断,你的错误判断和处理可能是多余的,因为你在调用这个方法的时候,你会再次判断,存在重复判断的可能
2、不要强行使用具名返回值,这可能会让你的代码难看,尤其是在DAO层,你会发现使用具名返回值可能会让你无所适从。
3、具名返回值有个明显的优点：调用方能清楚看到这个返回值具体是什么含义,这是一个很重要的优点,尤其对于协作开发而言。