Goland中使用GoPlantUml生成ER关系图

7,180 阅读1分钟

前言

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

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

环境配置

基于MacOS环境

下载PlantUml插件

  打开Goland,Preference -> Plugins -> Marketplace -> 搜索plantuml -> 安装

image.png

安装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目录路径)

image.png

生成PlantUml

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

image.png

  生成文件acl.puml文件,即acl目录下ER关系图image.png

  当打开查看时,遇到问题Cannot Find Graphvizimage.png

  添加环境变量,指定Graphviz的执行路径

###添加系统变量
GRAPHVIZ_DOT=/usr/local/Cellar/graphviz/2.48.0/bin

  或者在项目中配置graphviz执行路径 image.png

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

acl.png

 🏄🏄🏄 以上便是本篇的全部内容,如果觉得有所收获,欢迎 『点赞』、『收藏』、『关注』 一键三连支持喔~