PlantUml-程序员的画图利器

Dear 丶 2022-12-29 06:43 226阅读 0赞

# `PlantUml`\-程序员的画图利器 #

## 1. `PlantUml`简介 ##

`PlantUML`是一个组可以用来在`markdown`文件中快速生成`UML`工程图的组件，比如：

*  [时序图][Link 1]
 *  [用例图][Link 2]
 *  [类图][Link 3]
 *  [活动图(这是传统语法)][Link 4]
 *  [组件图][Link 5]
 *  [状态图][Link 6]
 *  [对象图][Link 7]
 *  [部署图][Link 8]
 *  [计时图][Link 9]

除此之外，还支持下面这些非`UML`图的展示：

*  [JSON数据][JSON]
 *  [线框图形界面][Link 10]
 *  [Archimate图][Archimate]
 *  [规范和描述语言(SDL)][SDL]
 *  [Ditaa图][Ditaa]
 *  [甘特图][Link 11]
 *  [构思图][Link 12]
 *  [工作分解结构图][Link 13]
 *  [数学与AsciiMath或JLaTeXMath符号][AsciiMath_JLaTeXMath]
 *  [实体关系图][Link 14]

## 2. 案例图 ##

下面给出几个常用的图形为例，至于语法和剩余图形画法可详见[官方文档][Link 15]说明。

### 2.1 时序图 ###

@startuml
    actor user
    participant client
    participant server
    database database as db #gray
    
    user -> client :
    client -> server : request
    alt validate fail case
        client <-- server : validate fail !
    else
        server -[#blue]> db : crud
        server <-[#blue]- db
            note right
            notes 
            end note
        server -> server : deal data
        client <-- server :response
        client --> user : tips
    end
    @enduml

### 2.2 用例图 ###

@startuml
    actor user as user
    rectangle usecase { 
        usecase login as uc1
        usecase logout as uc2
        usecase "query user info" as uc3
        usecase "view info" as uc3
        usecase (guest view) as uc4
        uc3 <|-- uc4
    }
    package guest { 
        actor guest1 as guest1
        actor guest2 as guest2
    }
    user <|-- guest1
    user <|-- guest2
    
    left to right direction
    user --> uc1: operate
    user --> uc2
    user --> uc3
    guest1 --> uc4
    guest2 --> uc4
    @enduml

@startuml
    actor user as user
    rectangle usecase {
        usecase login as uc1
        usecase logout as uc2
        usecase "query user info" as uc3
        usecase "view info" as uc3
        usecase (guest view) as uc4
        uc3 <|-- uc4
    }
    package guest {
        actor guest1 as guest1
        actor guest2 as guest2
    }
    user <|-- guest1
    user <|-- guest2
    
    left to right direction
    user --> uc1: operate
    user --> uc2
    user --> uc3
    guest1 --> uc4
    guest2 --> uc4
    @enduml

### 2.3 类图 ###

@startuml
    abstract Abstract
    annotation Annotation
    class ClassB
    enum enum
    interface interface
    class ClassA { 
        { static} String id
        --
        - List<ClassB> classBList
        ==
        # enum enum
        ~ interface interface
        .. method ..
        + void init()
        + { abstract} void method()
        .. setter ..
        + void set()
    }
    note right of ClassA::method
      This member is notes for method or field
    end note
    
    Abstract <|-- ClassA
    ClassA o--ClassB
    ClassA *-- enum
    @enduml

@startuml
    abstract Abstract
    annotation Annotation
    class ClassB
    enum enum
    interface interface
    class ClassA {
        {static} String id
        --
        - List<ClassB> classBList
        ==
        # enum enum
        ~ interface interface
        .. method ..
        + void init()
        + {abstract} void method()
        .. setter ..
        + void set()
    }
    note right of ClassA::method
      This member is notes for method or field
    end note
    
    Abstract <|-- ClassA
    ClassA o--ClassB
    ClassA *-- enum
    @enduml

### 2.4 活动图 ###

@startuml
    start
    partition patition { 
        :this node1;
        :this node2;
    }
    if(condition) then (yes)
        #white: yes node;
    else (no)
        #gray: no node;
    endif
    repeat: description
        : process;
        : process..;
    repeat while(more?) is (yes)
    ->no;
    while (while description)
        : ...;
    endwhile
    stop
    @enduml

@startuml
    start
    partition patition {
        :this node1;
        :this node2;
    }
    if(condition) then (yes)
        #white: yes node;
    else (no)
        #gray: no node;
    endif
    repeat: description
        : process;
        : process..;
    repeat while(more?) is (yes)
    ->no;
    while (while description)
        : ...;
    endwhile
    stop
    @enduml

[Link 1]: https://plantuml.com/sequence-diagram
[Link 2]: https://plantuml.com/use-case-diagram
[Link 3]: https://plantuml.com/class-diagram
[Link 4]: https://plantuml.com/activity-diagram-beta
[Link 5]: https://plantuml.com/component-diagram
[Link 6]: https://plantuml.com/state-diagram
[Link 7]: https://plantuml.com/object-diagram
[Link 8]: https://plantuml.com/deployment-diagram
[Link 9]: https://plantuml.com/timing-diagram
[JSON]: https://plantuml.com/json
[Link 10]: https://plantuml.com/salt
[Archimate]: https://plantuml.com/archimate-diagram
[SDL]: https://plantuml.com/activity-diagram-beta#sdl
[Ditaa]: https://plantuml.com/ditaa
[Link 11]: https://plantuml.com/gantt-diagram
[Link 12]: https://plantuml.com/mindmap-diagram
[Link 13]: https://plantuml.com/wbs-diagram
[AsciiMath_JLaTeXMath]: https://plantuml.com/ascii-math
[Link 14]: https://plantuml.com/ie-diagram
[Link 15]: https://plantuml.com/