Einführung

PlantUML-Klassendiagramme beschreiben die statische Struktur eines Systems: seine Klassen, Attribute, Operationen und Beziehungen. Sie schreiben eine Textspezifikation und rendern diese als Diagramm, wodurch die Quelle einfach zu bearbeiten und unter Versionskontrolle zu halten ist.
1. Ein minimales Diagramm
Ein Klassendiagramm beginnt mit @startuml und endet mit @enduml:

@startuml
class User
class Order
User --> Order : places
@enduml
PlantUML kann Klassen aus Beziehungsdeklarationen ableiten, aber eine explizite Deklaration macht größere Diagramme übersichtlicher und leichter zu warten.
2. Klassen, Attribute und Methoden
Setzen Sie Attribute und Operationen in geschweifte Klammern. Ein Doppelpunkt trennt einen Member-Namen von seinem Typ; Klammern kennzeichnen eine Operation.

@startuml
class User {
-id: int
-email: String
+login(password: String): boolean
+logout(): void
}
@enduml
Sichtbarkeitsmarker sind:
-
+public -
-private -
#protected -
~paketprivat
Sie können den Typ auch vor dem Member-Namen schreiben – zum Beispiel, +String email oder +void logout(). PlantUML unterstützt sowohl die vertraute, codeähnliche Member-Notation als auch diese Sichtbarkeitsmarker.
Statische und abstrakte Member
Verwenden Sie {static} oder {classifier} für statische Member und {abstract} für abstrakte Member:

@startuml
abstract class PaymentMethod {
{abstract} +authorize(amount: Decimal): boolean
{static} +supportedCurrencies: String[]
}
class CardPayment {
+authorize(amount: Decimal): boolean
}
PaymentMethod <|-- CardPayment
@enduml
Eine abstrakte Klasse kann auch mit abstrakte Klasse.
3. Beziehungen
Die Pfeilform vermittelt den Beziehungstyp. Die Richtung der Linie wird durch die Reihenfolge der Namen bestimmt; verwenden Sie Beschriftungen, um die Bedeutung zu verdeutlichen.
| Beziehung | PlantUML-Notation | Typische Bedeutung |
|---|---|---|
| Vererbung / Verallgemeinerung | `Parent < | — Child` |
| Interface-Realisierung | `Interface < | .. Class` |
| Komposition | Ganzes *-- Teil |
Der Lebenszyklus des Teils wird vom Ganzen besessen |
| Aggregation | Ganzes o-- Teil |
Das Ganze gruppiert Teile oder verweist auf Teile, die unabhängig existieren können |
| Gerichtete Assoziation | A --> B |
A hat eine navigierbare Beziehung zu B |
| Abhängigkeit | A ..> B |
A verwendet oder hängt von B ab |
Dies sind die Standard-Beziehungsnotationen von PlantUML.

@startuml
interface Repository
class SqlRepository
class OrderService
class Order
class OrderLine
Repository <|.. SqlRepository
OrderService ..> Repository : verwendet
Order *-- "1..*" OrderLine : enthält
@enduml
Wählen Sie sorgfältig:Komposition und Aggregation drücken unterschiedliche Lebenszyklus-Semantiken aus. Verwenden Sie Komposition nur, wenn das Teil sinnvoll vom Ganzen besessen wird; verwenden Sie eine einfache Assoziation, wenn keine der Besitzinterpretationen passt.
4. Multiplizität, Rollennamen und Beschriftungen
Multiplizität legt fest, wie viele Objekte an jedem Ende einer Assoziation teilnehmen können. Häufige Formen umfassen "1", "0..1", "*", und "1..*".

@startuml
class Kunde
class Bestellung
Kunde "1" --> "0..*" Bestellung : tätigt
@enduml
Hier ist jede Bestellung mit einem Kunden steht, während ein Kunden kann null oder mehr Bestellungen aufgeben. Lesen Sie die Multiplizitäten vom gegenüberliegenden Ende: die Zahl in der Nähe von “Bestellung beschreibt, wie viele Bestellungen einem Kunden zugeordnet werden können.
Für zusätzliche Präzision fügen Sie Rollennamen oder Einschränkungen hinzu:

@startuml
class Team
class Spieler
Team "1" o-- "0..*" Spieler : Mitglieder
Hinweis auf Verbindung
Ein Spieler kann zwischen Teams wechseln.
end note
@enduml
5. Schnittstellen, Enums, Stereotype und Pakete
PlantUML unterstützt Deklarationen wie Schnittstelle, Enum, abstrakte Klasse, und Stereotype, die zwischen << und >>.

@startuml
package "Bestellung" {
interface PaymentGateway {
+charge(amount: Decimal): PaymentResult
}
enum OrderStatus {
NEU
BEZAHLT
STORNIERT
}
class Order <<Entity>> {
+id: UUID
+status: OrderStatus
}
class CheckoutService <<Service>> {
+checkout(order: Order): PaymentResult
}
CheckoutService ..> PaymentGateway : ruft auf
Order --> OrderStatus
}
@enduml
Pakete gruppieren verwandte Typen visuell. Verwenden Sie Stereotype wie “<<Entity>> oder “<<Service>> wenn sie einen nützlichen Kontext hinzufügen; vermeiden Sie das Hinzufügen von Beschriftungen, die lediglich wiederholen, was der Klassenname bereits aussagt.
6. Notizen, Aliasnamen und Layout
Notizen können Designentscheidungen erklären oder eine Einschränkung verdeutlichen, ohne Klassennamen zu überladen. Aliasnamen helfen, wenn ein angezeigter Name Leerzeichen oder Satzzeichen enthält.

@startuml
class "Externe Zahlungs-API" as PaymentApi
class CheckoutService
CheckoutService ..> PaymentApi : übermittelt Zahlung
note right of CheckoutService
Wiederholt vorübergehende Fehler.
Wiederholt abgelehnte Zahlungen nicht.
end note
left to right direction
@enduml
Richtung von links nach rechts ändert die allgemeine Layout-Richtung; die Standardrichtung ist von oben nach unten. Sie können auch Beziehungsrichtungen wie “-left-> oder “-up-|> verwenden, um die lokale Platzierung zu steuern.
7. Ein vollständigeres Beispiel
Dieses Beispiel kombiniert Sichtbarkeit, Typen, Methoden, Enums, Multiplizitäten, Komposition und Abhängigkeit:

@startuml
left to right direction
package "Vertrieb" {
class Kunde {
-id: UUID
+name: String
+placeOrder(): Order
}
class Order {
-id: UUID
-status: OrderStatus
+addLine(product: Product, quantity: int): void
+total(): Decimal
}
class OrderLine {
-quantity: int
+lineTotal(): Decimal
}
class Product {
+sku: String
+price: Decimal
}
enum OrderStatus {
NEW
PAID
CANCELLED
}
interface PaymentGateway {
+charge(amount: Decimal): PaymentResult
}
class CheckoutService {
+checkout(order: Order): PaymentResult
}
Kunde "1" --> "0..*" Order : legt fest
Order *-- "1..*" OrderLine : enthält
OrderLine "*" --> "1" Product : verweist auf
Order --> OrderStatus
CheckoutService ..> PaymentGateway : verwendet
}
@enduml
8. Werkzeug: Visual Paradigm VPasCode
VPasCode ist ein browserbasierter Text-zu-Diagramm-Editor von Visual Paradigm. Er unterstützt PlantUML-Klassendiagramme und bietet einen Code-Editor mit Live-Vorschau, sodass Sie PlantUML schreiben oder einfügen und das gerenderte Ergebnis während der Arbeit überprüfen können.

Ein typischer Arbeitsablauf:
-
Öffnen Sie VPasCode und wählen Sie den PlantUML-Editor oder ein PlantUML-Beispiel aus.
-
Ersetzen Sie den Starttext durch Ihr Diagramm, einschließlich
@startumlund@enduml. -
Überprüfen Sie die Live-Vorschau; falls die Rendierung fehlschlägt, untersuchen Sie den hervorgehobenen Syntaxfehler und die entsprechende Zeile.
-
Verfeinern Sie das Diagramm und exportieren oder teilen Sie es nach Bedarf. VPasCode beschreibt Exportoptionen für SVG, PNG und PDF.
VPasCode bietet zudem eine Themenauswahl-Oberfläche für PlantUML, einschließlich der Themes Visual Paradigm und Rose. Für konsistente Ergebnisse im Team sollten Sie die PlantUML-Quelle zusammen mit Ihrer Dokumentation oder Ihrem Code aufbewahren, anstatt sich ausschließlich auf ein exportiertes Bild zu verlassen.
9. Häufige Fallstricke und bewährte Praktiken

-
Verwechseln Sie eine Assoziation nicht mit einer Abhängigkeit.Eine Abhängigkeit bedeutet im Allgemeinen „verwendet“; eine Assoziation stellt oft eine dauerhaftere strukturelle Beziehung dar.
-
Vermeiden Sie eine übermäßige Verwendung von Komposition.Sie impliziert eine stärkere Lebenszyklusabhängigkeit als eine einfache Verbindung.
-
Beschriften Sie die Multiplizitäten vom gegenüberliegenden Ende aus.Die Zahl neben einer Klasse gibt an, wie viele Instanzen dieser Klasse mit einer Instanz am anderen Ende in Beziehung stehen können.
-
Halten Sie Diagramme fokussiert.Teilen Sie ein sehr großes Modell in Pakete oder separate Diagramme für unterschiedliche Belange auf.
-
Zeigen Sie die Details, die für das Zielpublikum relevant sind.Eine konzeptionelle Übersicht benötigt möglicherweise nur Klassennamen und Beziehungen; ein Diagramm auf Design-Ebene kann Typen, Sichtbarkeit und Operationen erfordern.
-
Betrachten Sie die Quelle als das zu pflegende Artefakt.Überprüfen Sie Änderungen am Text, rendern Sie nach Bearbeitungen und regenerieren Sie Exporte, wenn sich die Quelle ändert.
Schnellreferenz

@startuml
class A {
+publicField: String
-privateField: int
#protectedMethod(): void
~packageMember(): boolean
}
interface I
abstract class Base
enum State { READY; DONE }
Base <|-- A
I <|.. A
A *-- B : Komposition
A o-- C : Aggregation
A --> D : Assoziation
A ..> I : Abhängigkeit
@enduml
PlantUML unterstützt zusätzliche Klassen-Diagramm-Funktionen – einschließlich Member-Gruppierung, Notizen, Farben und mehr –, wenn ein Diagramm weiter verfeinert werden muss.










