PlantUML簡單介紹
PlantUML是一個用文本描述畫出UML圖的工具。很早之前在CSDN一篇博客中看到別人家的UML又簡潔又大方,當時就想知道是用什麼軟件畫的。現在知道了,就是用PlantUML畫的。PlantUML支持畫一下這些UML圖:
- 時序圖(Sequence diagram)
- 用例圖(Usecase diagram)
- 類圖(Class diagram)
- 流程圖(Activity diagram)
- 組件圖(Compont diagram)
- 狀態圖(State diagram)
- 對象圖(Object diagram)
以下是我最近用PlantUML畫的一個考勤系統的系統架構圖,大家感受一下:
PlantUML畫類圖也是非常簡潔大方清晰明瞭的,我網上找個例子:
環境配置
搗鼓玩意兒首先就得安裝好對應的運行環境。對於配置環境,這裏只是簡單的介紹一下,大家也可以參考下其他更詳細的文章。
首先我使用的環境是Sublime Text + PlantUML,其中PlantUML不是插件,是官網上下載的jar包。另外還需要一個graphviz的程序安裝,它能將UML轉成圖片輸出。
除此以外,java環境和Sublime編輯器自然是必不可少的。安裝好這些環境之後,需要手動地進行一下配置。這裏我利用的是Sublime的編譯文件配置:
1、增加編譯項:
在Tools->Build System->New Build System打開的文件中,下加入代碼:
{
"cmd": "java.exe -jar C:/Progra~2/plantuml/plantuml.jar -charset UTF-8 $file",
"path":"D:/Program Files/Java/jre/bin/",
"env": {"GRAPHVIZ_DOT":"D:/install/graphviz/bin/dot.exe"}
}
說明:
C:/Progra~2/plantuml/plantuml.jar
應該替換爲你自己下載PlantUML jar包的路徑。- 如果環境變量中設置了JAVA_HOME,則可以不設置path。
2、保存編譯項:
保存文件PlantUML[Windows].sublime-build
(文件名稱可自定義)
3、啓用此編譯項:
在Tools->Build System中,選擇PlantUML[Windows],啓用編譯配置。
4、個性化配置,讓它更好用:
經過上面3步配置,已經可以編寫文本,然後通過Ctrl+B將文本編譯爲png的圖片。(保存在文本文件所在的同一文件下)
但是每次編譯之後,都要到文件夾中手動打開圖片查看效果,實在是有點繁瑣。所以我在前三步弄明白原理之後,進行了一點個性化配置:
① 修改編譯cmd項,讓它執行我們自定義的腳本:
"cmd": "C:/Progra~2/plantuml/SublimeTextPlugin.bat $file",
② 編寫編譯腳本SublimeTextPlugin.bat
:
java.exe -jar C:/Progra~2/plantuml/plantuml.jar -charset UTF-8 %1
set filename=%1
set filepath=%filename:~0,-3%png
Start "" %filepath%
這裏需要注意的是,編譯的源文件路徑是通過參數傳進來的,即$file。編譯後生成的文件是以源文件名爲名,後綴爲png。所以這裏我們打開了將源文件名後三個字符替換爲png的文件。因此,需要注意,源文件的後綴名必須剛好三個字符,這裏我使用的是.uml作爲文件名。
③ 經過上面兩步之後,通過Ctrl+B編譯出圖片之後,系統就會自動調用默認png打開軟件來打開圖片了~
寫個例子看效果
在sublime text中新建一個try.uml
的文件。然後編輯以下內容:
@startuml
[hello] --> [world]
[world] --> [!]
@enduml
編輯完成之後保存,然後Ctrl+B進行編譯。如果環境配置正常的話,就會打開圖片如下:
好,到此PlantUML就能正常運行了!