PlantUML安裝與使用

感謝

使用 Sublime + PlantUML 高效地畫圖
一分鍾Sublime Text搭建PlantUML生成環境

安裝工具

最省力的方式

使用chrome插件plantuml viewer，然后直接用chrome打開該文件即可。注意要在插件管理中勾選：允許訪問文件網址。

本地生成方式

對於一些特別大的文件，直接用chrome打開可能會很卡。這時候可以本地將puml文件轉化為png或svg圖，安裝步驟如下：

安裝java運行時環境

官網地址

注意，應安裝javaSE版本，然后同時在系統設置那里添加“JAVA_HOME”：“XXX/java/jdk”。

安裝plantuml.jar

官網地址

如果你安裝好了java環境，理論上在命令行中輸入java -jar plantuml.jar 'sample'.uml就可以了。
新版本的plantuml.jar可以有不需要graphviz的語法，不過如果你使用的仍是舊版本的語法，那就需要進行下一步的安裝了。

// 舊版本語法，需安裝graphviz
@startuml
(*)-->"HelloWorld"
"HelloWorld"-->(*)
@enduml
// 新版本語法，
@startuml
start
:HelloWorld;
stop
@enduml

安裝graphviz

官網地址

graphviz是一個開源圖形庫。安裝后最好在系統設置那里添加"GRAPHVIZ_DOT":"XXX/bin/dot.exe"，XXX表示你安裝的本地路徑。

配置sublime環境

在Tools->Build System->New Build System打開的文件中，加入以下代碼:

{
    "cmd": "java.exe -jar XXX/plantuml.jar -charset UTF-8 $file",
    "path":"XXX/Java/jre/bin/",
    "env": {"GRAPHVIZ_DOT":"XXX/graphviz/bin/dot.exe"}
}

說明：

• 如果JAVA_HOME已經加到了環境變量PATH中，可以省略上面的path
• 如果GRAPHVIZ_DOT已經加到了環境變量中，可以省略上面的env
• 保存文件即可，文件名任取，建議為Puml.sublime-build

測試

在sublime中任選一個puml文件，crtl+B運行該文件，就會生成該文件的png圖片，和直接用chrome插件打開的效果一樣。

uml簡易使用教程

官方文檔（中英混雜）

流程圖

文檔

Tips：

• 使用 start 來表示流程開始，使用 stop 來表示流程結束
• 順序流程使用冒號和分號 :xxx;
• 條件語句使用 if ("condition 1") then (true/yes/false/no) + else (false/no) + endif
• 循環語句使用 while('condition') is ('stop condition') + endwhile
• 注釋使用 note left/right + end note

例子1：

@startuml
start
if (condition A) then (yes)
  :Text 1;
elseif (condition B) then (yes)
  :Text 2;
  stop
elseif (condition C) then (yes)
  :Text 3;
elseif (condition D) then (yes)
  :Text 4;
else (nothing)
  :Text else;
endif
stop
@enduml

例子2：

@startuml
while (check filesize ?) is (not empty)
  :read file;
endwhile (empty)
:close file;
@enduml

時序圖

文檔

時序圖（Sequence Diagram），又名序列圖、循序圖，是一種UML交互圖。它通過描述對象之間發送消息的時間順序顯示多個對象之間的動態協作。

用例圖

文檔

類圖或對象圖

文檔