Golang 函数执行时间统计装饰器的一个实现详解
作者:coordinate35 发布时间:2024-05-09 09:46:22
背景
最近在搭一个新项目的架子,在生产环境中,为了能实时的监控程序的运行状态,少不了逻辑执行时间长度的统计。时间统计这个功能实现的期望有下面几点:
实现细节要剥离:时间统计实现的细节不期望在显式的写在主逻辑中。因为主逻辑中的其他逻辑和时间统计的抽象层次不在同一个层级
用于时间统计的代码可复用
统计出来的时间结果是可被处理的。
对并发编程友好
实现思路
统计细节的剥离
最朴素的时间统计的实现,可能是下面这个样子:
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,
}
})
}
}
测试通过,验证了时间统计是没问题的。至此,这个时间统计装饰器就介绍完了。如果这个实现有什么问题,或者大家有更好的实现方式,欢迎大家批评指正与提出~
来源:https://segmentfault.com/a/1190000018538275
猜你喜欢
- 本文实例讲述了mysql存储过程原理与用法。分享给大家供大家参考,具体如下:本文内容:什么是存储过程存储过程的创建存储过程的使用查看存储过程
- python3.6.4安装opencv3.4.2使用pip安装OpenCV直接安装最新版:pip3 install opencv_pytho
- 大致思路:1.利用tornado提供的websocket功能与浏览器建立长连接,读取实时日志并输出到浏览器2.写一个实时读取日志的脚本,利用
- 本篇我们将以分析历史股价为例,介绍怎样从文件中载入数据,以及怎样使用NumPy的基本数学和统计分析函数、学习读写文件的方法,并尝试函数式编程
- ……最近在学习yolo1、yolo2和yolo3,事实上它们和SSD网络有一定的相似性,我准备汇
- 1.前言 &n
- quicktool/view.py文件修改视图函数index(),渲染一个home.html模板from django.shortcuts
- 原文地址:30 Days of Mootools 1.2 Tutorials - Day 12 - Drag and Drop using
- 日前,Mozilla 的 Arun Ranganathan 向 W3C 提交了一个草案,旨在推出一个 JavaScript API,让 Ja
- 如下所示:>>> import numpy as np>>> a = np.arange(12).res
- 给定一篇英语文章,要求统计出所有单词的个数,并按一定次序输出。思路是利用go语言的map类型,以每个单词作为关键字存储数量信息,代码实现如下
- 学习笔记,写到哪是哪。接着上一篇对纯文本文件读写操作,主要去实现一些文件夹操作。创建文件夹创建文件夹的时候往往要先判断文件夹是否存在。样例代
- 上一篇中的方法在 webpack 更新后,uglify 缓存地址也发生了变化,需要重新找地址。后来测试发现不论是 uglify-js2 ug
- Python 代码库之Tuple如何append元素tuple不像array给我们提供了append函数,我们可以通过下面的方式添加t=[1
- 自从web2.0之后,网页设计开始走向实用设计的阶段,越来越多的设计师注意到“为表达信息而设计”。着迷于前段时间黑白灰老师给大家介绍的“in
- 今天,使用各种所见即所得工具制作主页已经是一件非常容易的事情了。但是了解HTML源代码和语法,无疑对我们制作主页有更大的帮助,也可以使用户能
- 使用Python方法比用各种命令方便,可以设置超时时间,到底通不通,端口是否开放一眼能看出来。命令和返回完整权限,可以ping通,端口开放,
- 前言1.工作中,经常需要合并多个Excel文件。如果文件数量比较多,则工作量大,易出错,此时,可以使用Python来快速的完成合并。2.使用
- 本文实例讲述了Python zip()函数用法。分享给大家供大家参考,具体如下:这里介绍python中zip()函数的使用:>>
- PHP的类是单一继承模式,也就是每个类只能继承一个父类(基类)。但有时需要引入更多通用(共用)的方法,同时这些方法又不适合集成到基类。那么这