前语

  Golang语言在近些年的开发语言中异军突起,在越来越多的公司项目中频频出镜,也有越来越多的中间件选择运用Golang语言进行实现。正所谓源码之下无秘密,更友好地翻读源码对于了解功用特性以及后续运用十分有协助,观摩学习源码也是十分好的一种学习方式。

  本篇根据Golang常用开发工具Goland结合GoPlantUml进行代码ER联系图生成,便于更好阅览代码和梳理逻辑联系。

环境装备

根据MacOS环境

下载PlantUml插件

  翻开Goland,Preference -> Plugins -> Marketplace -> 搜索plantuml -> 装置

Goland中使用GoPlantUml生成ER关系图

装置GoPlantUml

goplantuml可履行文件装置到本地$GOBIN目录下:

go get github.com/jfeliu007/goplantuml/cmd/goplantuml
### 或者
go install go get github.com/jfeliu007/goplantuml/cmd/goplantuml

装置Graphviz

  下载地址:graphviz.org/download/

### macos下履行
brew install graphviz

  graphviz的下载依靠十分多,这里容易出现的问题是依靠不行用不行下载,可以经过修正brew源为阿里云镜像完成,如下:

### 翻开装备文件
vi ~/.zprofile
### 输出brew环境变量
export HOMEBREW_BOTTLE_DOMAIN=https://mirrors.aliyun.com/homebrew/homebrew-bottles
### 装备生效
source ~/.zprofile

装备External Tools

Preference -> Tools -> External Tools -> 新增/修改

  • Name:goplantuml(可自定义)
  • Program:/usr/local/go/bin/goplantuml (goplantuml的装置途径,可以经过$GOBIN获取到)
  • Arguments:-recursive –output=$FileDir$.puml $FileDir$
  • Working directory: /User/workspace/bin (Project目录途径)

Goland中使用GoPlantUml生成ER关系图

生成PlantUml

  选中项目中要生成的目录,这里是acl,鼠标右键找到External Tools -> goplantuml

Goland中使用GoPlantUml生成ER关系图

  生成文件acl.puml文件,即acl目录下ER联系图

Goland中使用GoPlantUml生成ER关系图

  当翻开查看时,遇到问题Cannot Find Graphviz

Goland中使用GoPlantUml生成ER关系图

  增加环境变量,指定Graphviz的履行途径

###增加体系变量
GRAPHVIZ_DOT=/usr/local/Cellar/graphviz/2.48.0/bin

  或者在项目中装备graphviz履行途径

Goland中使用GoPlantUml生成ER关系图

  重启后可以正常看到该目录下的ER联系图,如下:

Goland中使用GoPlantUml生成ER关系图

  以上就是本篇的全部内容,假如觉得有所收成,欢迎 『点赞』、『收藏』、『重视』 一键三连支撑喔~