You can vote to improve syntax about packages/namespaces !
Komponentendiagramm
Komponenten
Komponenten werden mittels eckiger Klammern definiert. Alternativ kann das Schlüsselwort component verwendet werden, um eine Komponente zu definieren. Mittels Schlüsselwort as lassen sich Aliase definieren. Aliase können verwendet werden, wenn Beziehungen definiert werden.
@startuml
[First component]
[Another component] as Comp2
component Comp3
component [Last\ncomponent] as Comp4
@enduml
Schnittstellen
Schnittstellen werden mit zwei Runden Klammern () definiert.
Alternativ kann das Schlüsselwort interface verwendet werden, um Schnittstellen zu definieren. Mittels Schlüsselwort as lassen sich Aliase definieren. Aliase können verwendet werden, wenn Beziehungen definiert werden.
Die Deklaration von Schnittstellen ist optional.
@startuml
() "First Interface"
() "Another interface" as Interf2
interface Interf3
interface "Last\ninterface" as Interf4
@enduml
Beispiel
Verbindungen zwischen Elementen können mit folgenden Symbolen erstellt werden: .. (gestrichelte Linie), -- (ausgezogene Linie), and --> (Pfeile).
@startuml
DataAccess - [First Component]
[First Component] ..> HTTP : use
@enduml
Notizen
Schlüsselwörter: note left of , note right of , note top of , note bottom of Diese Schlüsselwörter können eingesetzt werden, um Notizen für ein einzelnes Objekt zu erstellen.
Eine Notiz kann mit note definiert werden. Danach kann sie mittels .. mit anderen Objekten verbunden werden.
@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
Gruppierende Komponenten
Mit package lassen sich Komponenten und Schnittstellen gruppieren.
packagenodefolderframeclouddatabase
@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
Ändern der Pfeilrichtung
Verbindungen werden mit zwei Minus-Zeichen -- definiert und sind vertikal orientiert. Um eine horizontale Orientierung zu erhalten, kann die Verbindung mit nur einem Minus-Zeichen (oder Punkt) definiert werden:
@startuml
[Component] --> Interface1
[Component] -> Interface2
@enduml
Die Pfeilsymbole können umgedreht werden, um die Pfeilrichtung zu ändern:
@startuml
Interface1 <-- [Component]
Interface2 <- [Component]
@enduml
Die Pfeilrichtung lässt sich auch mit den Schlüsselwörtern left, right, up und down ändern. Diese Schlüsselwörter werden innerhalb des Pfeil-Symbols eingesetzt:
@startuml
[Component] -left-> left
[Component] -right-> right
[Component] -up-> up
[Component] -down-> down
@enduml
Die Pfeillänge kann verkürzt werden, wenn bei der Deklaration der Pfeilrichtung nur der Anfangsbuchstabe (oder ersten zwei Anfangsbuchstaben) verwendet werden: Beispielsweise -d- oder -do- statt -down-.
Diese Funktionalität ist jedoch mit Bedacht einzusetzen, da GraphViz normalerweise gute Resultate ohne manuelle Eingriffe erzielt.
UML2-Notation verwenden
Der skinparam componentStyle uml2 Befehl wird werwendet, um in die UML2 Notation umzuschalten.
@startuml
skinparam componentStyle uml2
interface "Data Access" as DA
DA - [First Component]
[First Component] ..> HTTP : use
@enduml
Mehrzeilige Beschreibung
Es ist möglich mehrzeilige Beschreibungen zu erstellen mithilfe von eckigen Klammern
@startuml
component comp1 [
This component
has a long comment
on several lines
]
@enduml
Individuelle Farben
Eine Farbe kann nach der Komponenten Definition angeben werden.
@startuml
component [Web Server] #Yellow
@enduml
Verwendung von Sprites in Stereotypen
Sie können Sprites innerhalb von stereotypen Komponenten verwenden.
@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
Der Skinparam Befehl
Mit dem skinparam Befehl kann die Farbe und die Schriftart der Zeichnung verändert werden.
Sie können den Befehl auf die folgenden Arten verwenden:
- Wie alle ander Befehle In einer Diagrammdefinition,
- in einer Include-Datei,
- In einer Konfigurationsdatei, die durch die Kommandozeile oder den ANT-Task übergeben wird.
Es können unterschiedliche Farben und Schriftarten für Komponenten und Schnittstellen verwendet werden.
@startuml
skinparam interface {
backgroundColor RosyBrown
borderColor orange
}
skinparam component {
FontSize 13
BackgroundColor<<Apache>> Red
BorderColor<<Apache>> #FF6655
FontName Courier
BorderColor black
BackgroundColor gold
ArrowFontName Impact
ArrowColor #FF6655
ArrowFontColor #777777
}
() "Data Access" as DA
DA - [First Component]
[First Component] ..> () HTTP : use
HTTP - [Web Server] << Apache >>
@enduml
@startuml
[AA] <<static lib>>
[BB] <<shared lib>>
[CC] <<static lib>>
node node1
node node2 <<shared node>>
database Production
skinparam component {
backgroundColor<<static lib>> DarkKhaki
backgroundColor<<shared lib>> Green
}
skinparam node {
borderColor Green
backgroundColor Yellow
backgroundColor<<shared node>> Magenta
}
skinparam databaseBackgroundColor Aqua
@enduml
