Golang对象复用静态代码检查工具

一、对象复用

在高并发的场景下使用golang,优化GC都会无法回避的问题。搜索「golang 垃圾回收优化」出来的结果基本上都会提及对象复用的方式,在实践中也确实很多高性能的开源库大量使用对象复用来优化程序,比如fasthttp。

简单的例子

使用对象复用分为三个环节,1.初始化pool;2.获取对象;3.清空对象+归还对象。

package main
import (
    "fmt"
    "sync"
)

var pool *sync.Pool

type Person struct {
    Name string
}

func (p *Person)Reset() {
  p.Name = ""
}

func initPool() {
    pool = &sync.Pool {
        New: func()interface{} {
            fmt.Println("Creating a new Person")
            return new(Person)
        },
    }
}

func main() {
    // 1. 初始化池
    initPool()
    // 2. 获取对象
    p := pool.Get().(*Person)

    p.Name = "first"

    // 3. 清空对象 + 归还对象
    p.Reset()
    pool.Put(p)

}

二、对象复用的坑

在上面的例子中,如果我们把Reset函数注释了,那么放回池子里的Person对象的Name是不干净的,很有可能会影响下一个使用的地方。不过实际使用中忘记调用Reset方法的比较少,这是对象复用的基本意识,真正容易遗漏的是Reset方法中的实现。

在项目实践中,某些结构体定义的字段会比较多,而项目又一直在迭代,结构体的字段会发生新增、修改或删除,如果新增了字段,但Reset方法漏了新增对应的Reset语句,那么程序就很可能会出现数据篡乱的问题,而且这种问题不是稳定必现的,如果未意识到是字段漏了重置的问题,定位起来让人很头疼。

三、工具比人靠谱

想要避免出现这种问题,完全依赖个人注意肯定是不靠谱的,一个项目可能有多个人维护,团队也可能会有新人,难以确保每个人都能顾及到所有的对象复用。于是我开发了一个静态代码检查的工具 structreset用于检查对象复用的结构体的Reset方法,是否包含所有结构体字段的重置。当然这里的方法名Reset是我这里定义的,也可以叫别的名字:free/release等等。

代码仓库里的实现是:识别带有refcount字段的结构体,然后遍历其Reset方法体语句。这个可以根据项目需求进行修改。

var refCountTypeName = map[string]uint8 {"refcount": 1}

安装

按照文档操作即可。

git clone git@git.xxx.cn:beckjiang/structreset.git

cd structreset

./install.sh

使用

检查项目testdata

structresetx -d ./analysis/passes/structreset/testdata
image.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容