本文为社区首发签约文章,14天内禁止转载,14天后未获授权禁止转载,侵权必究!
让开发者更好的做到“模块内部高内聚,模块之间松耦合”,是我以为GoFrame V2规划的精华。
前言
用GoFrame开发商业项目现已很长时间,发现GoFrame的版别更新比较快,社区也十分的活泼。
由于前史原因,我之前一直用V1.16版别做商业项意图开发,虽然个人有比较强的志愿晋级到V2。
可是考虑到项目安稳性及开发本钱等等原因,商业项目并未晋级。这或许也是许多小同伴面临的问题。
受到鼓励
正好前段时间,共享了自己的开源项目【Go WEB进阶实战】根据GoFrame搭建的电商前后台API体系 受到了咱们的重视和支撑,也得到了GoFrame作者的点赞转发。
更重要的是:收到了社区里许多小同伴的优化主张,其间最好的就是主张我运用V2版别,由于供给了许多新特性,能够更好的完成需求,安稳且高效。
决定晋级
所以,我决定把我开源的项目从V1.16.x版别,晋级到最新的V2.2.0版别,踩一下晋级的坑,享受一下晋级后的高兴。欢迎小同伴们参加到我的开源项目中:电商前后台体系API,现已开发了100多个接口,包含电商项意图常用功能。
由于内容比较长且硬核,所以我决定分两篇文章共享:
-
这篇文章重点:介绍GoFrame V2的新特性,和V1比较有哪些优势?最大的改变是什么?
-
第二篇文章会共享一下:我从V1晋级到V2的踩坑之旅,信任对许多小同伴都有帮助。
这个阅历实属不易,希望小同伴们能够点赞、重视、转发一波。
适合看的人群
- 把握Go根底后,想用老练框架开发项意图同伴,主张读完我的文章之后,直接运用GoFrame最新的V2版别实战开发
- 目前在用V1版别,有志愿可是没有很多精力学习V2新特性的同伴,忧虑晋级问题太高不敢轻率晋级的同伴们。
- 想进步自己学习新知识功率的小同伴,欢迎复刻我的这种实践办法。
站在开发者的角度
不论你是哪种人群,都主张花时间仔细阅读官方文档,尤其是 框架介绍这部分。
差异于官方文档,这篇文章会结合我自己的阅历,站在框架运用者的角度,帮咱们更快更好的了解Goframe V2版的规划思路,根据V2版别怎么更好的进行商业项意图开发。
踩的坑
在我晋级版别的过程中发现:一定要先了解清楚V2的新特性,然后再从V1晋级到V2,不然晋级到一半会出现无从下手的问题:
-
由于经过V2版别的CLI东西生成的dao、model,和V1版别是不一致的:抛弃了gmvc模块等,也引入了新的模块。
-
V2版别支撑
gf gen service
的办法生成service层,一致咱们接口逻辑的完成办法,引入了logic层和service层的概念
下面我就结合自己的晋级阅历,共享给咱们学习GoFrame V2必知必会的知识点:
必知必会
-
项目工程结构发生了改变,且需求依照V2的规范来,由于gf东西生成代码的目录结构发生了改变,更重要的:V2官方主张的目录结构也是咱们践行”高内聚低耦合”比较好的工程目录结构。
-
gf gen dao
除了会像V1相同生成dao层和model层,还会另外生成do层和entity层 -
V2版别的目录结构实践了事务模型和数据模型解耦的思维(也是我以为十分赞的地方)
-
V2比较于V1会出现办法或许模块的情况,比方抛弃了gmvc耦合模块,未来不再进一步支撑。可是也为咱们供给了更好的完成办法。
5.V2有点编写“微服务”的意思了,需求服务注册:controller调用一个或多个service完成详细的事务逻辑;可是杂乱的事务逻辑又不是在service中完成的,为了解耦,V2版别引入了logic目录,用于编写和复用杂乱的事务逻辑。在logic中注册服务,在service中经过接口办法规范logic层要完成的办法。
重中之重
下面再介绍一下我花了很长时间才消化的知识点:
dao代码生成(很重要)
gf gen dao
在事务项目中,官方引荐运用dao/do/entity的办法操作数据库,这些文件都是经过开发东西主动生成的,由开发东西一致保护。
差异于V1版别,V2版别引入了do的概念,为什么这么规划?
在这儿我只说定论,文章最后会附上官方链接:
-
dao层用于数据拜访,这是一层笼统目标,用于和底层数据库交互,仅包含最根底的 CURD 办法
-
model层是结构模型,是数据结构办理模块,办理数据实体目标,以及输入与输出数据结构界说。
2.1 model中的do是范畴目标,用于dao数据操作中事务模型与实例模型转化,由东西保护,用户不能修正。
2.2 model中的entity是数据模型,数据模型是模型与数据调集的1对1联系,由东西保护,用户不能修正。
后边我会带着咱们用实例讲解
服务接口生成(更重要)
gf gen service
服务接口是十分重要的知识点,也是我以为在cli东西支撑方面和V1版别最大的差异:
为了降低事务项目内部模块间的耦合,框架将模块间的依靠笼统为了接口,由internal/service包保护。internal/service能够由开发者自界说保护接口,也能够经过internal/logic事务封装的代码依照一定规则主动生成接口代码文件。
实践出真知
看10遍文档,都不如一次着手实践。主张咱们和我一同练习起来,欢迎复刻:
我的思路是这样:
-
下载官方的示例项目,学习一下官方是怎样写的。
-
给自己提需求,参阅官方的完成办法,完成自己的事务场景。
-
我会带着咱们完成经典的电商场景:增加和查询产品信息。
1. 下载运转官方示例的GitHub
官方示例GitHub
1.1 下载部署好项目之后,发动:十分顺滑的就发动成功了:
1.2 恳求接口,验证试一下DB是否连接正常。
1.3 查询数据库,也是有值的。
验证环境无误,下面开端带着咱们参阅官方示例完成自己的需求,进而更好的了解V2版别新特性和工程实践。
2. 根据V2编写产品办理
咱们依照官方主张的工程办法去实践,看看会不会踩坑:
2.1 创建goods表如下:
2.2 经过gf gen dao生成dao和model
初度测验,失败,原因是没有修正hack目录下的config.yaml装备文件。
** 留意:和V1不同,官方说hack目录的作用是东西脚本,存放项目开发东西、脚本等内容。例如,CLI东西的装备,各种shell/bat脚本等文件。所以咱们就不要像V1相同把cli东西的装备文件也写到manifest/config目录中了。**
2.3 搞定,成功生成。
小技巧,假如咱们不指定tables,则生成一切表对应的数据。我是比较喜欢这么操作:由于能避免自己改了多个tables,可是在装备文件中漏写了某个tables导致意料之外的问题。
下面开端正式撸代码了:
我会先依照咱们简单了解的办法进行编写,文章最后我会共享实践阅历:依照什么顺序编写各个模块的代码是比较科学的。
2.4 首先咱们完成api层,界说恳求和响应的结构体
2.5 咱们在cmd中注册Goods相关的路由
2.6 咱们发现注册路由时,controller.Goods飘红,原因是咱们还没有编写这个办法。
咱们参阅示例代码去编写controller层:
咱们发现右侧的示例项目,办法内部调用了service中的办法,可是咱们目前还没有界说service,怎样办?
咱们先点击示例项目中的user.go,检查一下service中都界说了什么:
经过查阅文档得知:
咱们需求经过编写logic层完成事务逻辑,经过装备goland插件,主动生成service代码。
这要是官方主张咱们的最佳实践:
2.7 导入官方供给的xml文件(只需求装备一次)
xml文件地址
强烈主张咱们这么操作,经过这个装备在咱们编写logic层代码的时分,service能主动生成接口界说文件。
当然也能够不装备,仅仅每一次在开发/更新完成logic事务模块后,都需求手动履行一下 gf gen service 指令。太麻烦了!!!
2.8 咱们参阅右侧的示例 编写产品goods的logic代码,处理事务逻辑:
2.9 经测试我发现:在编写logic逻辑后,就主动在service层生成了对应的goods文件和办法,十分方便。
2.10 咱们再持续写增加产品逻辑和检查产品逻辑
咱们发现:在logic层编写完增加产品逻辑后,在右侧的service层主动生成了代码。
2.11 仔细的同学或许发现了service层的RegisterGoods办法,这是干嘛用的呢?
答案是:咱们要在service层生成RegisterXX()办法后,在对应的事务模块中加上接口的完成注入。
小提示:该办法每个事务模块加一次即可。
主张咱们在编写完第一个logic办法后(或许说service层生成了RegisterXX办法后):
-
就在logic层的init函数中完成服务的注册;
-
然后去检查logic.go文件是否增加了相关的依靠,没有的话也能够手动增加一下;
要成杰出的编码习气,少出bug。
2.12 咱们检查logic目录下的logic.go文件,发现现已主动增加了咱们本次编写的goods相关的import:
这个文件的作用是:将接口的详细完成,在程序发动时履行注册。
好了,logic和service到此结束,咱们现已完成了事务逻辑的编写。
内容不少,咱们能够上划再看一遍这部分内容,消化吸收一下。
2.13 咱们回过头来,持续编写controller层的代码:
咱们参阅官方供给的controller/user.go 完成了咱们自己的 controller/goods.go的增加产品办法:
2.14 到这儿,咱们现已完成了新需求的编写,发动服务检查一下效果:
很OK,现已看到了对应的接口。
编码结束,测试一下:
咱们恳求接口,增加数据看一下:
在数据库中也检查到数据:插入成功,流程走通!
反思回忆
依照上面这个流程走下来,虽然全体跑通了。我个人感觉仍是比较混乱的。
我又花了比较长的时间消化吸收了官方文档的工程实践,结合我自己的阅历。
咱们再来整理一下V2项意图编写流程,我的主张是这样的:
-
规划表结构
-
运用gf gen dao 生成对应的 dao/do/model
-
编写api层:界说事务侧数据结构,供给对外接口的输入/输出数据结构
-
编写model层:界说数据侧数据结构,供给对内的数据处理的输入/输出数据结构
-
编写logic层,主动生成service层代码。(经过装备goland File Watcher主动生成,也能够经过gf gen service手动履行脚本生成,主张前者)
-
在service层代码生成RegisterXX()办法后,在对应的logic模块注册服务(每个模块只需求写一次)
-
编写controller层,接收/解析用户输入的参数,调用service层的服务。
-
注册路由,对外露出接口,比方这个项目是编写cmd.go文件。
-
在main.go中 参加一行_ “project-name/internal/logic” (只需写一次)
-
在main.go中参加一行 _ “github.com/gogf/gf/contrib/drivers/mysql/v2” (假如你运用的是mysql;只需写一次)
我依照上面这个过程,编写了查询产品逻辑,全体仍是十分顺滑的:
小同伴们也着手实践吧:
GitHub地址:github.com/wangzhongya…
带着问题学习
我在编写产品办理需求的时分有些疑惑:
为什么要界说两遍数据结构呢?在api层界说了一遍,在model层又界说了一遍,我写了两遍重复的结构体,意义何在呀?
我静下心来想想,这个规划还真的深得我心,我结合之前的项目阅历一下就get到了GoFrame团队的点:
之前遇到的问题
咱们之前在在开发产品中心一致入库是就遇到了难以保护的问题,原因就是事务逻辑和数据处理逻辑耦合在一同。
随着事务的杂乱度越来越高,项目保护本钱越来越高,甚至达到了难以保护的程度。
咱们是怎么处理的呢?
答案和GoFrame的数据模型和事务模型解耦,底层思维是相同的:
咱们把杂乱的逻辑进行了拆分:界说了事务模块和数据处理模块。
事务模块:只处理接收的参数,并不需求关怀怎么入库和取值,依照数据模块的要求,处理好前端传入的数据,一致结构体传递给数据模块。
数据模块:不需求关怀事务模块的详细完成,界说了一致的入参规范,要求事务模块依照自己的要求,一致传入数据;数据模块考虑的重点是怎么高效的批量插入数据,怎么高效的按需取值,并不需求关怀多变的事务侧需求。
提高一下
经过对冗余模块的拆解,整理清楚了数据模型和事务模型的边界,咱们不仅处理了之前项目难以保护的问题,还进步了灵敏对接客户需求的能力。
结合自己的项目阅历和这次实践V2版别的阅历,所以我说:让开发者更好的做到“模块内部高内聚,模块之间松耦合”,是我以为GoFrame V2规划的精华。
好了,这篇文章就到这儿,晋级之旅实属不易,欢迎咱们点赞、谈论、转发。
第二篇《根据GoFrame的商业项目从V1.16晋级到V2.2.0的踩坑之旅》在编写中,欢迎咱们在谈论区共享自己的晋级阅历。
一同学习
欢迎点击这儿,拜访我的主页,重视&私信我。