标签:callvis 代码 golang md52id idg go gin 工具
「工具推荐」go-callvis
go-callvis是相对 以图片的形式展示了go程序的调用关系,这个工具在看复杂项目时尤其有用。
亲测,借助它看祖传golang代码,头痛好多了。
安装
go get -u github.com/TrueFurby/go-callvis
# or
git clone https://github.com/TrueFurby/go-callvis.git
cd go-callvis && make install
复制代码
运行依赖
- Go 1.12+
- Graphviz:http://www.graphviz.org/download/ Mac 可以直接 brew install graphviz
项目地址:https://github.com/TrueFurby/go-callvis
使用命令
命令特别简单,只需要简单的输入:
go-callvis [OPTIONS] <main package>
复制代码
这里 main package 是包含代码的main函数所在的包,比如项目 github.com/gusibi/onep…
目录结构为:
.
├── README.md
└── src
├── dbs
├── go.mod
├── go.sum
├── idg
│ ├── area_code.go
│ ├── idg.go
│ ├── idg_test.go
│ ├── index.go
│ ├── index_test.go
│ ├── sort.go
│ ├── sort_test.go
│ ├── wr.go
│ └── wr_test.go
├── main.go
└── sorteDB
复制代码
其中src目录是一个go package,运行go-callvis 时就需要先cd src/,然后再执行命令:
go-callvis -group pkg,type md52id
复制代码
md52id 是package name,已在go.mod中声明,pakage name是一个必须要带的参数。
运行命令,默认会打开浏览器加载地址http://localhost:7878
图片格式为 svg,也可以添加 -format=png,指定以png形式展示
推荐使用svg,svg格式的内容是可交互的,比如这里想查看gin包的内容就可以点击 对应的模块来看详情。
结果如果所示,图像展示的结果就是这个包所有的调用关系,按包的调用层级由左向右排列。第二列上边是 gin 框架的代码,如果看代码时不想看这部分,可以使用 ignore 参数排除掉。
命令为:
go-callvis -group pkg,type -ignore github.com/gin-gonic/gin md52id
复制代码
这里 gin 包的名字是 github.com/gin-gonic/gin而不是 gin
如果要再排出idg 包,可以直接加在gin 包后边,用,(英文逗号)隔开。
使用limit 命令可以得到相同的结果
go-callvis -group pkg,type -limit md52id md52id
得到的结果为:
如果想看idg包内部的调用关系,可以使用 focus 命令,指定idg 包,命令如下:
go-callvis -focus=md52id/idg -group pkg,type -limit md52id md52id
复制代码
结果如图:
详细命令可以参考:github.com/TrueFurby/g…
使用go-callvis ,直观的展示代码的调用关系,对于大项目的源码尤其有用,比如下图是gin stagic 包的调用关系:
通过图可以直观的看到,
- static 调用了 staticFS,而staticFS 只使用了 HEAD和GET 方法。
- 所有的http method 最终都是通过调用handler来处理响应的。
### go-callvis 的另类用法
go-callvis 也可以用来评估系统设计是否合理,代码是否清晰,下图是docker 的调用图:
作者:goodspeed
链接:https://juejin.cn/post/6844904051327369229
来源:稀土掘金
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。
标签:callvis,代码,golang,md52id,idg,go,gin,工具 来源: https://www.cnblogs.com/gongxianjin/p/16333407.html
本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享; 2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关; 3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关; 4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除; 5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。