分析go项目源码,采用plantuml自动生成uml类图

使用工具go-package-plantuml分析go项目源码,自动生成uml类图

plantuml工具介绍

plantuml支持将"文本描述的UML类图"转换成图片形式的类图等。

类图使用例子如下,参考 http://plantuml.com/class-diagram

@startuml
Class11 <|.. Class12
Class13 --> Class14
@enduml

安装go-package-plantuml

go-package-plantuml项目代码地址 https://git.oschina.net/jscode/go-package-plantuml

下载和编译项目:(系统需要先安装好go编译环境)

go get git.oschina.net/jscode/go-package-plantuml
go build git.oschina.net/jscode/go-package-plantuml

使用go-package-plantuml分析go项目,生成uml类图描述文件

./go-package-plantuml --codedir /appdev/gopath/src/github.com/contiv/netplugin \
--gopath /appdev/gopath \
--outputfile /tmp/result \
--ignoredir /appdev/gopath/src/github.com/contiv/netplugin/vendor
参数说明
--codedir 要分析的代码目录
--gopath GOPATH环境变量目录
--outputfile 分析结果保存到该文件
--ignoredir 不需要进行代码分析的目录(可以不用设置)

使用plantuml生成类图

下载plantuml https://nchc.dl.sourceforge.net/project/plantuml/plantuml.jar

提示:如果系统没有安装jdk,需要先安装jdk;yum install -y java

执行下面命令生成图片形式的类图/tmp/uml.png

java -jar plantuml.jar /tmp/text.uml

如果想生成svg格式的文件,使用-tsvg参数。svg格式的文件,使用浏览器打开,可以搜索类名。

java -jar plantuml.jar /tmp/text.uml -tsvg

本文来自:开源中国博客

感谢作者:qquunn

查看原文:分析go项目源码,采用plantuml自动生成uml类图

• 编辑
• 预览