Golang 函数执行时间统计装饰器的一个实现详解
来源:脚本之家
时间:2023-01-07 11:58:51 335浏览 收藏
本篇文章主要是结合我之前面试的各种经历和实战开发中遇到的问题解决经验整理的,希望这篇《Golang 函数执行时间统计装饰器的一个实现详解》对你有很大帮助!欢迎收藏,分享给更多的需要的朋友学习~
背景
最近在搭一个新项目的架子,在生产环境中,为了能实时的监控程序的运行状态,少不了逻辑执行时间长度的统计。时间统计这个功能实现的期望有下面几点:
- 实现细节要剥离:时间统计实现的细节不期望在显式的写在主逻辑中。因为主逻辑中的其他逻辑和时间统计的抽象层次不在同一个层级
- 用于时间统计的代码可复用
- 统计出来的时间结果是可被处理的。
- 对并发编程友好
实现思路
统计细节的剥离
最朴素的时间统计的实现,可能是下面这个样子:
func f() { startTime := time.Now() logicStepOne() logicStepTwo() endTime := time.Now() timeDiff := timeDiff(startTime, endTime) log.Info("time diff: %s", timeDiff) }
《代码整洁之道》告诉我们:一个函数里面的所有函数调用都应该处于同一个抽象层级。
在这里时间开始、结束的获取,使用时间的求差,属于时间统计的细节,首先他不属于主流程必要的一步,其次他们使用的函数 time.Now() 和 logicStepOne, logicStepTwo 并不在同一个抽象层级。
因此比较好的做法应该是把时间统计放在函数 f 的上层,比如:
func doFWithTimeRecord() { startTime: = time.Now() f() endTime := Time.Now() timeDiff := timeDIff(startTime, endTime) log.Info("time diff: %s", timeDiff) }
时间统计代码可复用&统计结果可被处理&不影响原函数的使用方式
我们虽然达成了函数内抽象层级相同的目标,但是大家肯定也能感受到:这个函数并不好用。
原因在于,我们把要调用的函数 f 写死在了 doFWithTimeRecord 函数中。这意味着,每一个要统计时间的函数,我都需要实现一个 doXXWithTimeRecord, 而这些函数里面的逻辑是相同的,这就违反了我们 DRY(Don't Repeat Yourself)原则。因此为了实现逻辑的复用,我认为装饰器是比较好的实现方式:将要执行的函数作为参数传入到时间统计函数中。
举个网上看到的例子
实现一个功能,第一反应肯定是查找同行有没有现成的轮子。不过看了下,没有达到自己的期望,举个例子:
type SumFunc func(int64, int64) int64 func timedSumFunc(f SumFunc) SumFunc { return func(start, end int64) int64 { defer func(t time.Time) { fmt.Printf("--- Time Elapsed: %v ---\n", time.Since(t)) }(time.Now()) return f(start, end) } }
说说这段代码不好的地方:
这个装饰器入参写死了函数的类型:
type SumFunc func(int64, int64) int64
也就是说,只要换一个函数,这个装饰器就不能用了,这不符合我们的第2点要求
这里时间统计结果直接打印到了标准输出,也就是说这个结果是不能被原函数的调用方去使用的:因为只有掉用方,才知道这个结果符不符合预期,是花太多时间了,还是正常现象。这不符合我们的第3点要求。
怎么解决这两个问题呢?
这个时候,《重构,改善既有代码的设计》告诉我们:Replace Method with Method Obejct——以函数对象取代函数。他的意思是当一个函数有比较复杂的临时变量时,我们可以考虑将函数封装成一个类。这样我们的函数就统一成了 0 个参数。(当然,原本就是作为一个 struct 里面的方法的话就适当做调整就好了)
现在,我们的代码变成了这样:
type TimeRecorder interface { SetCost(time.Duration) TimeCost() time.Duration } func TimeCostDecorator(rec TimeRecorder, f func()) func() { return func() { startTime := time.Now() f() endTime := time.Now() timeCost := endTime.Sub(startTime) rec.SetCost(timeCost) } }
这里入参写成是一个 interface ,目的是允许各种函数对象入参,只需要实现了 SetCost 和 TimeCost 方法即可
对并发编程友好
最后需要考虑的一个问题,很多时候,一个类在整个程序的生命周期是一个单例,这样在 SetCost 的时候,就需要考虑并发写的问题。这里考虑一下几种解决方案:
使用装饰器配套的时间统计存储对象,实现如下:
func NewTimeRecorder() TimeRecorder { return &timeRecorder{} } type timeRecorder struct { cost time.Duration } func (tr *timeRecorder) SetCost(cost time.Duration) { tr.cost = cost } func (tr *timeRecorder) Cost() time.Duration { return tr.cost }
抽离出存粹的执行完就可以销毁的函数对象,每次要操作的时候都 new 一下
函数对象内部对 SetCost 函数实现锁机制
这三个方案是按推荐指数从高到低排序的,因为我个人认为:资源允许的情况下,尽量保持对象不可变;同时怎么统计、存储使用时长其实是统计时间模块自己的事情。
单元测试
最后补上单元测试:
func TestTimeCostDecorator(t *testing.T) { testFunc := func() { time.Sleep(time.Duration(1) * time.Second) } type args struct { rec TimeRecorder f func() } tests := []struct { name string args args }{ { "test time cost decorator", args{ NewTimeRecorder(), testFunc, }, }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { got := TimeCostDecorator(tt.args.rec, tt.args.f) got() if tt.args.rec.Cost().Round(time.Second) != time.Duration(1) * time.Second.Round(time.Second) { "Record time cost abnormal, recorded cost: %s, real cost: %s", tt.args.rec.Cost().String(), tt.Duration(1) * time.Second, } }) } }
测试通过,验证了时间统计是没问题的。至此,这个时间统计装饰器就介绍完了。如果这个实现有什么问题,或者大家有更好的实现方式,欢迎大家批评指正与提出~
本篇关于《Golang 函数执行时间统计装饰器的一个实现详解》的介绍就到此结束啦,但是学无止境,想要了解学习更多关于Golang的相关知识,请关注golang学习网公众号!
-
366 收藏
-
272 收藏
-
312 收藏
-
297 收藏
-
451 收藏
-
444 收藏
-
311 收藏
-
266 收藏
-
188 收藏
-
317 收藏
-
430 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 542次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 507次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 497次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 484次学习
-
- 哭泣的小蚂蚁
- 很详细,码住,感谢up主的这篇技术文章,我会继续支持!
- 2023-06-05 05:57:44
-
- 壮观的战斗机
- 这篇文章太及时了,很详细,很好,码起来,关注作者大大了!希望作者大大能多写Golang相关的文章。
- 2023-05-06 10:47:53
-
- 聪慧的金毛
- 赞 👍👍,一直没懂这个问题,但其实工作中常常有遇到...不过今天到这,帮助很大,总算是懂了,感谢up主分享博文!
- 2023-05-03 07:08:58
-
- 朴实的小丸子
- 细节满满,码起来,感谢大佬的这篇文章内容,我会继续支持!
- 2023-04-11 16:02:18
-
- 孝顺的红牛
- 这篇博文真是及时雨啊,太详细了,感谢大佬分享,收藏了,关注老哥了!希望老哥能多写Golang相关的文章。
- 2023-03-23 02:46:30
-
- 鲤鱼花生
- 这篇文章出现的刚刚好,楼主加油!
- 2023-03-12 12:42:00
-
- 朴素的蜡烛
- 很棒,一直没懂这个问题,但其实工作中常常有遇到...不过今天到这,看完之后很有帮助,总算是懂了,感谢作者分享技术文章!
- 2023-02-12 01:31:30
-
- 风中的苗条
- 这篇博文出现的刚刚好,细节满满,受益颇多,已加入收藏夹了,关注作者了!希望作者能多写Golang相关的文章。
- 2023-01-08 13:26:28
-
- 花痴的烤鸡
- 很棒,一直没懂这个问题,但其实工作中常常有遇到...不过今天到这,帮助很大,总算是懂了,感谢大佬分享文章内容!
- 2023-01-08 03:53:20
-
- 阳光的康乃馨
- 这篇技术文章真及时,太细致了,很棒,mark,关注作者了!希望作者能多写Golang相关的文章。
- 2023-01-07 22:15:10