PlantUML Language specification Component Diagram

       

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Komponentendiagramm

• Einfachheit: Mit PlantUML können Sie Komponentendiagramme mit einfachen und intuitiven textbasierten Beschreibungen erstellen, wodurch komplexe Zeichenwerkzeuge überflüssig werden.
• Integration: PlantUML lässt sich nahtlos in verschiedene Werkzeuge und Plattformen integrieren, was es zu einer vielseitigen Wahl für Entwickler und Architekten macht.
• Kollaboration: Das PlantUML-Forum bietet eine Plattform für Benutzer, um ihre Diagramme zu diskutieren, auszutauschen und um Unterstützung zu bitten, wodurch eine kollaborative Gemeinschaft gefördert wird.

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Komponenten

@startuml [First component] [Another component] as Comp2 component Comp3 component [Last\ncomponent] as Comp4 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Schnittstellen

@startuml () "First Interface" () "Another interface" as Interf2 interface Interf3 interface "Last\ninterface" as Interf4 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Grundlegendes Beispiel

@startuml DataAccess - [First Component] [First Component] ..> HTTP : use @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Notizen

@startuml interface "Data Access" as DA DA - [First Component] [First Component] ..> HTTP : use note left of HTTP : Web Service only note right of [First Component] A note can also be on several lines end note @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Gruppierende Komponenten

• package
• node
• folder
• frame
• cloud
• database

@startuml package "Some Group" { HTTP - [First Component] [Another Component] } node "Other Groups" { FTP - [Second Component] [First Component] --> FTP } cloud { [Example 1] } database "MySql" { folder "This is my folder" { [Folder 3] } frame "Foo" { [Frame 4] } } [Another Component] --> [Example 1] [Example 1] --> [Folder 3] [Folder 3] --> [Frame 4] @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Ändern der Pfeilrichtung

@startuml [Component] --> Interface1 [Component] -> Interface2 @enduml

@startuml Interface1 <-- [Component] Interface2 <- [Component] @enduml

@startuml [Component] -left-> left [Component] -right-> right [Component] -up-> up [Component] -down-> down @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Use UML2 notation

@startuml interface "Data Access" as DA DA - [First Component] [First Component] ..> HTTP : use @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

UML1-Notation verwenden

@startuml skinparam componentStyle uml1 interface "Data Access" as DA DA - [First Component] [First Component] ..> HTTP : use @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Use rectangle notation (remove UML notation)

@startuml skinparam componentStyle rectangle interface "Data Access" as DA DA - [First Component] [First Component] ..> HTTP : use @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Mehrzeilige Beschreibung

@startuml component comp1 [ This component has a long comment on several lines ] @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Individuelle Farben

@startuml component [Web Server] #Yellow @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Verwendung von Sprites in Stereotypen

@startuml sprite $businessProcess [16x16/16] { FFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFF FFFFFFFFFF0FFFFF FFFFFFFFFF00FFFF FF00000000000FFF FF000000000000FF FF00000000000FFF FFFFFFFFFF00FFFF FFFFFFFFFF0FFFFF FFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFF FFFFFFFFFFFFFFFF } rectangle " End to End\nbusiness process" <<$businessProcess>> { rectangle "inner process 1" <<$businessProcess>> as src rectangle "inner process 2" <<$businessProcess>> as tgt src -> tgt } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Der Skinparam Befehl

• Wie alle anderen Befehle in einer Diagrammdefinition,
• In einer Include-Datei,
• In einer Konfigurationsdatei, die durch die Kommandozeile oder den ANT-Task übergeben wird.

@startuml skinparam interface { backgroundColor RosyBrown borderColor orange } skinparam component { FontSize 13 BackgroundColor<<Apache>> Pink BorderColor<<Apache>> #FF6655 FontName Courier BorderColor black BackgroundColor gold ArrowFontName Impact ArrowColor #FF6655 ArrowFontColor #777777 } () "Data Access" as DA Component "Web Server" as WS << Apache >> DA - [First Component] [First Component] ..> () HTTP : use HTTP - WS @enduml

@startuml skinparam component { backgroundColor<<static lib>> DarkKhaki backgroundColor<<shared lib>> Green } skinparam node { borderColor Green backgroundColor Yellow backgroundColor<<shared_node>> Magenta } skinparam databaseBackgroundColor Aqua [AA] <<static lib>> [BB] <<shared lib>> [CC] <<static lib>> node node1 node node2 <<shared_node>> database Production @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Specific SkinParameter

componentStyle

• By default (or with skinparam componentStyle uml2), you have an icon for component

@startuml skinparam BackgroundColor transparent skinparam componentStyle uml2 component A { component "A.1" { } component A.44 { [A4.1] } component "A.2" [A.3] component A.5 [ A.5] component A.6 [ ] } [a]->[b] @enduml

• If you want to suppress it, and to have only the rectangle, you can use skinparam componentStyle rectangle

@startuml skinparam BackgroundColor transparent skinparam componentStyle rectangle component A { component "A.1" { } component A.44 { [A4.1] } component "A.2" [A.3] component A.5 [ A.5] component A.6 [ ] } [a]->[b] @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Hide or Remove unlinked component

@startuml component C1 component C2 component C3 C1 -- C2 @enduml

• hide @unlinked components:

@startuml component C1 component C2 component C3 C1 -- C2 hide @unlinked @enduml

• or remove @unlinked components:

@startuml component C1 component C2 component C3 C1 -- C2 remove @unlinked @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Hide, Remove or Restore tagged component or wildcard

@startuml component C1 $tag13 component C2 component C3 $tag13 C1 -- C2 @enduml

• hide $tag13 components:

@startuml component C1 $tag13 component C2 component C3 $tag13 C1 -- C2 hide $tag13 @enduml

• or remove $tag13 components:

@startuml component C1 $tag13 component C2 component C3 $tag13 C1 -- C2 remove $tag13 @enduml

• or remove $tag13 and restore $tag1 components:

@startuml component C1 $tag13 $tag1 component C2 component C3 $tag13 C1 -- C2 remove $tag13 restore $tag1 @enduml

• or remove * and restore $tag1 components:

@startuml component C1 $tag13 $tag1 component C2 component C3 $tag13 C1 -- C2 remove * restore $tag1 @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Display JSON Data on Component diagram

Simple example

@startuml allowmixing component Component () Interface json JSON { "fruit":"Apple", "size":"Large", "color": ["Red", "Green"] } @enduml

Edit in DokuwikiEdit in AsciidocEdit in Markdown

Port [port, portIn, portOut]

Port

@startuml [c] component C { port p1 port p2 port p3 component c1 } c --> p1 c --> p2 c --> p3 p1 --> c1 p2 --> c1 @enduml

PortIn

@startuml [c] component C { portin p1 portin p2 portin p3 component c1 } c --> p1 c --> p2 c --> p3 p1 --> c1 p2 --> c1 @enduml

PortOut

@startuml component C { portout p1 portout p2 portout p3 component c1 } [o] p1 --> o p2 --> o p3 --> o c1 --> p1 @enduml

Mixing PortIn & PortOut

@startuml [i] component C { portin p1 portin p2 portin p3 portout po1 portout po2 portout po3 component c1 } [o] i --> p1 i --> p2 i --> p3 p1 --> c1 p2 --> c1 po1 --> o po2 --> o po3 --> o c1 --> po1 @enduml