Go语言工程实践之测试与Gin项目实践

这篇具有很好参考价值的文章主要介绍了Go语言工程实践之测试与Gin项目实践。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

Go 语言并发编程 及 进阶与依赖管理_软工菜鸡的博客-CSDN博客

Go语言工程实践之测试与Gin项目实践,log4j

03 测试

回归测试一般是QA(质量保证)同学手动通过终端回归一些固定的主流程场景

集成测试是对系统功能维度做测试验证,通过服务暴露的某个接口,进行自动化测试

单元测试开发阶段,开发者对单独的函数、模块做功能验证

层级从上至下,测试成本逐渐减低,而测试覆盖率确逐步上升,所以单元测试的覆盖率一定程度上决定着代码的质量

Go语言工程实践之测试与Gin项目实践,log4j

3.1.0 单元测试

单元测试主要包括:输入,测试单元,输出,以及校对

单元的概念比较广:包括接口,函数,模块等;用最后的校对来保证代码的功能与我们的预期相符;

单侧一方面可以保证质量,在整体覆盖率足够的情况下,一定程度上既保证了新功能本身的正确性,又未破坏原有代码的正确性。 另一方面可以提升效率,在代码有bug的情况下,通过编写单测,可以在一个较短周期内定位和修复问题

Go语言工程实践之测试与Gin项目实践,log4j

3.1.1 单元测试-规则

基本规范,以 _test.go结尾这样从文件上就很好了区分源码和测试代码

以Test开头,且连接的第一个字母大写

TestMain的m.run()会跑这个package下的所有单测

Go语言工程实践之测试与Gin项目实践,log4j

3.1.2 单元测试-例子

HelloTom() 由于代码逻辑的错误没有输出Tom

接下来进行测试:TestHelloTom()

Go语言工程实践之测试与Gin项目实践,log4j

3.1.3 单元测试-运行

输出结果错误

Go语言工程实践之测试与Gin项目实践,log4j

3.1.4 单元测试-assert

import 了testify/assert 的Equal函数

Go语言工程实践之测试与Gin项目实践,log4j

3.1.5 单元测试-覆盖率

Go语言工程实践之测试与Gin项目实践,log4j

这是一个判断是否及格的函数,超过60分,返回true,否则返回false

右边是对输入为70 的单元测试,我们执行右边的单侧

通过指定go test [] --cover参数,我们看输出了 覆盖率为66.7。

一共三行,我们的单测试执行了2行,所以为66.7

Go语言工程实践之测试与Gin项目实践,log4j

下一步就是提升覆盖率,我们可以增加一个不及格的测试case,重新执行所有单侧,最终覆盖率为100%。

也就是说,我们通过不断对各个分支的测试,保证了覆盖率和完备性。

Go语言工程实践之测试与Gin项目实践,log4j

3.1.6 单元测试-Tips

实际项目中,一般的要求是50%~60% 覆盖率,而对于资金型服务,覆盖率可能要求达到80%;

我们做单元测试,测试分支相互独立,全面覆盖,则要求函数体足够小,这样就比较简单的提升覆盖率,也符合函数设计的单一职责。

Go语言工程实践之测试与Gin项目实践,log4j

3.2 单元测试-依赖

工程中复杂的项目,一般会依赖数据库、缓存等,而我们的单测需要保证稳定性和幂等性

稳定是指相互隔离,能在任何时间,任何环境,运行测试

幂等是指每一次测试运行都应该产生与之前一样的结果。而要实现这一目的就要用到mock机制

Go语言工程实践之测试与Gin项目实践,log4j

3.3 单元测试-文件处理

下面举个例子,打开文件读入 将文件中的第一行字符串中的11替换成00,执行单测,测试通过,而我们的单测需要依赖本地的文件,如果文件被修改或者删除测试就会fail

为了保证测试case的稳定性,我们对读取文件函数进行mock,屏蔽对于文件的依赖

Go语言工程实践之测试与Gin项目实践,log4j

3.4 单元测试-Mock

monkey是一个开源的mock测试库,可以对method,或者实例方法的方法进行mock(打桩)

打桩指的是:用一个函数A 替换函数B,B作为原函数;A作为打桩函数

Mock Patch(原函数,需要打桩的函数) 的作用域在 Runtime;

Unpatch(打桩函数):打桩结束后把原函数卸载掉

monkey主要是在运行时通过 Go 的 unsafe 包,能够将内存中函数的地址替换为运行时函数的地址,在测试中调用的就是运行时的打桩函数B地址。

Go语言工程实践之测试与Gin项目实践,log4j

下面是一个mock的使用样例,通过patch对Readfineline进行打桩mock,默认返回line110,这里通defer卸载mock,这样整个测试函数就摆脱了本地文件的束缚和依赖

Go语言工程实践之测试与Gin项目实践,log4j

3.5 基准测试

Go 语言还提供了基准测试框架,基准测试是指测试一段程序的运行性能及耗费 CPU 的程度

而我们在实际项目开发中,经常会遇到代码性能瓶颈,为了定位问题经常要对代码做性能分析,这就用到了基准测试。使用方法类似于单元测试,

Go语言工程实践之测试与Gin项目实践,log4j

3.5.1 基准测试-例子

这里举一个服务器负载均衡的例子,首先我们有10个服务器列表,每次随机(rand包)执行select函数随机选择一个执行。

Go语言工程实践之测试与Gin项目实践,log4j

3.5.2 基准测试-运行

基准测试以Benchmark开头,入参是testing.B, 用b中的N值反复递增循环测试(对一个测试用例的默认测试时间是 1 秒,当测试用例函数返回时还不到 1 秒,那么 testing.B 中的 N 值将按 1、2、5、10、20、50……递增,并以递增后的值重新进行用例函数测试

Resttimer重置计时器,我们在reset之前做了init或其他的准备操作,这些操作不应该作为基准测试的范围

runparallel()函数是多协程并发测试;执行 2个基准测试,发现代码在并发情况下存在劣化,主要原因是rand为了保证全局的随机性和并发安全,持有了一把全局锁

Go语言工程实践之测试与Gin项目实践,log4j

3.5.3 基准测试-优化

GitHub - bytedance/gopkg: Universal Utilities for Go

而为了解决这一随机函数性能问题,开源了一个高性能随机数方法fastrand,上面有开源地址;我们这边再做一下基准测试,性能提升百倍。主要的思路是牺牲了一定的数列的一致性,在大多数场景是适用的,同学在后面遇到随机的场景可以尝试用一下。

Go语言工程实践之测试与Gin项目实践,log4j

4 项目实践

4.0需求背景

大家应该都是从掘金的 社区话题入口报名的,都看到过这个页面,页面的功能包括话题详情,回帖列表,支持回帖,点赞,和回帖回复

我们今天就以此为需求模型,开发一个该页面交涉及的服务端小功能。

Go语言工程实践之测试与Gin项目实践,log4j

4.1 需求描述

                下面是需求的详细描述;Ok,如果该功能由同学自己实现,如何去做模型设计,可以拿笔和纸简单画一下,然后打开ide,争取我们一起完成这个实现,后面跟不上也不要着急,代码已经托管到github,大家可以自行下载查看GitHub - Moonlight-Zhao/go-project-example

Go语言工程实践之测试与Gin项目实践,log4j

4.2 需求用例

我们从用例分析一步步拆解实现,主要涉及的功能点,用户浏览消费,涉及页面的展示,包括话题内容和回帖的列表,其实从图中我们应该会抽出2个实体的,而实体的属性有哪些,他们之间的联系又如何? 大家想一下,可以先定义一下结构体

Go语言工程实践之测试与Gin项目实践,log4j

4.3 ER 图

Go语言工程实践之测试与Gin项目实践,log4j

4.4 分层结构

Go语言工程实践之测试与Gin项目实践,log4j

整体分为三层

repository数据层,service逻辑层,controoler视图层

数据层关联底层数据模,也就是这里的model,封装外部数据的增删改查,我们的数据存储在本地文件,通过文件操作拉取话题,帖子数据

数据层面向逻辑层,对service层透明,数据层屏蔽下游数据差异,也就是不管下游是文件,还是数据库,还是微服务等,对service层的接口模型是不变的。

Servcie逻辑层处理核心业务逻辑接收数据层数据 计算打包业务实体entiy,对应我们的需求,就是话题页面,包括话题和回帖列表,并上送给视图层;

Controller视图层负责处理和外部的交互逻辑,以view视图的形式返回给客户端,对于我们需求,封装json格式化的请求结果,api形式访问就好

4.5 组件工具

下面介绍下开发涉及的基础组件和工具

首先是gin,高性能开源的go web框架,我们基于gin 搭建web服务器,在课程手册应该提到了,这里我们只是简单的使用,主要涉及路由分发,不会涉及其他复杂的概念。

因为我们引入了web框架,所以就涉及go module依赖管理,如前面依赖管理课程内容讲解,我们首先通过go mod是初始化go mod管理配置文件,然后go get下载gin依赖,这里显示用了V1.3.0版本。

有了框架依赖,我们只需要关注业务本身的实现,

从下至上:reposity-->service-->controller,我们一步步实现。希望大家能跟上我的节奏,从0~1 实现这个项目,如果时间问题,大家可以一步步copy一下,主要是走一下开发思路。

Go语言工程实践之测试与Gin项目实践,log4j

4.6 Repository数据层

首先是reposity,我们可以根据之前的er图先定义struct文件中每行的格式如图所示

那如何实现QueryTopicById(话题),QueryPostsByParentId(帖子)

Go语言工程实践之测试与Gin项目实践,log4j

4.6 Repository-index

一方面查询我们可以全扫描遍历的方式,但是这虽然能达到我们的目的,但是并非高效的方式;

所以这里引出索引的概念,索引就像书的目录,可以引导我们快速查找定位我们需要的结果;

这里我们map实现内存索引,在服务对外暴露前,利用文件元数据初始化全局内存索引,这样就可以实现0(1)的时间复杂度查找操作。

Go语言工程实践之测试与Gin项目实践,log4j

下面是具体的实现,首先是os.Open打开文件,基于file 初始化scanner,通过迭代器方式遍历scanner数据行,转化为结构体Topic存储至内存map,这就是初始化话题内存索引

Go语言工程实践之测试与Gin项目实践,log4j

4.6 Repository-查询

Go语言工程实践之测试与Gin项目实践,log4j

有了内存索引,下一步就是实现查询操作就比较简单了

直接根据查询key获得map中的value就好了,这里用到了sync.once,主要适用高并发的场景下只执行一次的场景,这里的基于once的实现模式就是我们平常说的单例模式,减少存储的浪费。

有了topic的查询代码,大家可以照猫画虎 自行实现一下根据话题id查询回帖列表的查询方法

func (*PostDao) QueryPostByParentId(parentId int64) ([]*Post, error) {
    var posts []*Post
    err := db.Where("parent_id = ?", parentId).Find(&posts).Error
    if err != nil {
        util.Logger.Error("find posts by parent_id err:" + err.Error())
	return nil, err
    }
    return posts, nil
}

4.7 Service逻辑层

有了reposity层以后,下面我们开始实现service层,首先我们定义servcie层实体PageInfo,包括:Topic和PostList

Go语言工程实践之测试与Gin项目实践,log4j

下面是具体的servcie流程编排 通过err控制流程退出,正常会返回页面信息,err为nil

func (f *QueryPageInfoFlow) Do() (*PageInfo, error) {
	if err := f.checkParam(); err != nil {//简单的id校验
		return nil, err
	}
	if err := f.prepareInfo(); err != nil {
		return nil, err
	}
	if err := f.packPageInfo(); err != nil {
		return nil, err
	}
	return f.pageInfo, nil
}

关于prepareInfo方法,话题和回帖信息的获取都依赖topicid,这样2个流程没有相互依赖;

这就可以并行执行,提高执行效率。

WaitGroup Add(2);(2个并行的协程);wait等待两个协程的信息从数据层返回

大家在后期做项目开发中,一定要思考流程是否可以并行,通过压榨CPU,降低接口耗时,不要一味的串行实现,浪费多核cpu的资源

Paramcheck 和pack这里就不讲了,给大家一点时间 编码 ,copy代码

Go语言工程实践之测试与Gin项目实践,log4j

4.8 Controller视图层

这里我们定义一个view对象,通过code msg打包业务状态信息,用data承载业务实体信息,输入

Go语言工程实践之测试与Gin项目实践,log4j

4.9 Router

最后是web服务的引擎配置,path映射到具体的controller。通过path变量传递话题id

Go语言工程实践之测试与Gin项目实践,log4j

4.10 运行

Go语言工程实践之测试与Gin项目实践,log4j

最后执行go run 本地启动web服务,通过curl命令请求服务暴露的接,当然平时写代码不可能像我讲的这么顺畅,难免有bug,大家要做好完备的单元测试,快速定位问题,解决问题。

鼠鼠出bug了捏!

Go语言工程实践之测试与Gin项目实践,log4j

好的,以上就是对社区话题页面需求的整个实现流程,这样我们从项目拆解,代码设计落地,最后测试运行就跑通了整个的项目流程,为大家后期实现项目提供了一定的开发思路。当然实际项目较我们实现的需求会复杂很多,不过大家也不必担心,可以通过大拆小的思路,将大需求拆解为小需求的思路来分析解决,遇到问题,各个击破,同时做好充分的测试。 课后作业

Go语言工程实践之测试与Gin项目实践,log4j

非常感谢您阅读到这里,如果这篇文章对您有帮助,希望能留下您的点赞👍 关注💖 收藏 💕评论💬感谢支持!!!

Go语言工程实践之测试与Gin项目实践,log4j文章来源地址https://www.toymoban.com/news/detail-648081.html

到了这里,关于Go语言工程实践之测试与Gin项目实践的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

原文地址:https://blog.csdn.net/m0_67184231/article/details/132239200

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包