Introduction and use of plantuml

Introduce

Easy to use free drawing plug-ins , compatible vscode、IDEA Wait for big names IDE, Automatically generate by writing code UML graphics . Official Chinese documents ：https://plantuml.com/zh/

Installation mode

With IDEA For example , Directly in Plugin -> Marketplace Just install it in ,vscode Empathy .

introduction

Create a new file in the file directory , You can see PlantUML File, Create a new file , Choose what you need UML graphics .

UML Drawing syntax rules

Global rules

Scope

puml You need to write the code in @startuml And @enduml It can only take effect between .

Sequence diagram

arrow

@startuml
Client -> Server:  Establishing a connection 
'       ↓ Here, for readability, it can also be written in reverse : <--
Server --> Client:  Data interaction 
Client --> Server:  Data interaction 
Server -> Client:  disconnect 
@enduml

Arrow pattern ：

No	Field	Express
1	x	Lost information , At the end of the arrow is x
2	>	Solid arrows
3	>>	Modest arrow
4	-	Solid line
5	–	Dotted line
6	<->	Double arrow

Declare participants

You can declare participants , Change properties for participants 、 Give alias as（ Once the alias is given, the original name cannot be used later ）、 Set weight order（ The smaller the number, the higher ）.

@startuml
participant Client as c order 1
participant Server as s order 2
c -> s:  Establishing a connection 
s --> c:  Data interaction 
c --> s:  Data interaction 
s -> c:  disconnect 
@enduml

Participant attributes that can be used ：

No	Field	Express
1	participant	participants
2	actor	role
3	control	control
4	entity	Entity
5	database	database
6	collections	aggregate
7	queue	queue
8	boundary	The border

Text alignment

skinparam sequenceMessageAlign center

Message number

autonumber 1.1, Specify a self incrementing number , Add the last number by default , Self incrementing digits can be specified .

@startuml
'https://plantuml.com/sequence-diagram
participant Client as c order 1
participant Server as s order 2
autonumber 1.1
c -[#red]> s:  Establishing a connection 
autonumber inc A
s --> c:  Data interaction 
c --> s:  Data interaction 
autonumber inc A
s -> c:  disconnect 
@enduml

notes

note left:、 note right: Single line comments or use note left ... endnote Multiline comment .

Separator

== repeat == or ... repeat ...

spacing

||| Set the spacing , Or specify spacing ||45||

Lifeline

activate c Initialize life ,deactivate c End the lifeline , You can nest .

return

Lifeline can return content , Use return return , At the same time, it can cooperate with autoactivate Realize automatic lifeline declaration and destruction .

Create quickly 、 The destruction 、 Lifeline / example

@startuml
alice -> bob ++ : hello
bob -> bob ++ : self call
bob -> bib ++  #005500 : hello
bob -> george ** : create
return done
return rc
bob -> george !! : delete
return success
@enduml

It can also be done at the same time ：

@startuml
alice   ->  bob     ++   : hello1
bob     ->  charlie --++ : hello2
charlie --> alice   --   : ok
@enduml

Activity diagrams

arrow

• --> Represents ordinary arrow
• -[labels]-> Represents the arrow with label
• -left-> Arrow that specifies the direction (down, up, left, right)

Start and end

• (*) Start / end
• start/stop Start / end