PlantUML für die Visualisierung von Software Projekten verwenden

by Oliver-Zoufahl on Dez 25, 2024 in Software Engineering

PlantUML ist ein Open-Source-Werkzeug zur Erstellung von UML-Diagrammen. Es verwendet eine einfache und intuitive textuelle Notation, um Diagramme zu beschreiben, was es besonders einfach macht, Diagramme in Textdateien zu erstellen und zu verwalten. Die Diagramme können dann mithilfe von Grafikwerkzeugen wie Graphviz visualisiert werden.

Verwendung von PlantUML

PlantUML wird hauptsächlich verwendet, um UML-Diagramme zu erstellen, die in der Softwareentwicklung und Systemmodellierung verwendet werden. Einige der Hauptvorteile sind:

  • Versionierbarkeit: Da die Diagramme als Textdateien gespeichert werden, können sie einfach in Versionskontrollsystemen wie Git integriert und versioniert werden.

  • Integration: PlantUML kann in verschiedene Editoren und IDEs integriert werden, wie zum Beispiel als Extension in und Visual Studio Code.

  • Einfache Syntax: Die textuelle Syntax von PlantUML ist einfach zu erlernen und zu verwenden, was die Erstellung von Diagrammen erleichtert.

Unterstützte Diagrammtypen

PlantUML unterstützt eine Vielzahl von UML-Diagrammen, darunter:

  • Klassendiagramme: Zur Darstellung der Struktur von Klassen und deren Beziehungen.
  • Anwendungsfalldiagramme: Zur Modellierung der Interaktionen zwischen Benutzern und dem System.
  • Aktivitätsdiagramme: Zur Darstellung von Prozessen und Abläufen.
  • Sequenzdiagramme: Zur Modellierung der Interaktionen zwischen Objekten in einer zeitlichen Abfolge.
  • Komponentendiagramme: Zur Darstellung der Komponenten und deren Beziehungen in einem System.
  • Zustandsdiagramme: Zur Modellierung der Zustände und Übergänge eines Objekts.
  • Objektdiagramme: zur grafischen Darstellung von Objekten und ihren Beziehungen zur Laufzeit
  • Deployment Diagramme: Zur Visualisierung von Komponenten, die in einer Systemarchitektur verteilt zum Einsatz kommen
  • Timing Diagramme: Zur Visualisierung von zeitlichen Abläufen und Ereignissen und der zeitlichen Interaktion von Objekten
  • WBS-Diagramme: Zur Visualisierung von Projektstrukturplänen
  • ArchiMate Diagramme: Zur Modellierung von Unternehmensarchitekturen und Prozessen

Voraussetzungen für den Einsatz von PlantUML

Installation der aktuellen Java Runtime

Was ist die Java Runtime?

Die Java Runtime Environment (JRE) ist eine Software-Plattform, die die Ausführung von Java-Anwendungen ermöglicht. Sie enthält die Java Virtual Machine (JVM), die Java-Klassenbibliotheken und andere Komponenten, die für die Ausführung von Java-Programmen erforderlich sind.

Download der Java Runtime

Um die aktuelle Version der Java Runtime herunterzuladen, besuche die offizielle Java-Download-Seite.

Stelle sicher, dass nach der Installation der JAVA Runtime die PATH-Umgebungsvariable für Java verfügbar ist, damit du Java von der Konsole aus ausführen kannst.

Überprüfung der Java-Installation

Um zu überprüfen, ob Java installiert ist und welche Version du hast, öffne die Konsole und gib folgenden Befehl ein:

java -version

Folgende Informationen sollten in der Konsolenausgabe zu sehen sein:

java version "1.8.0_281"
Java(TM) SE Runtime Environment (build 1.8.0_281-b09)
Java HotSpot(TM) 64-Bit Server VM (build 25.281-b09, mixed mode)

PlantUML Extension für Visual Studio Code

Der einfachste Weg um Diagramme in PlantUML zu schreiben und zu visualisieren ist die Nutzung der PlantUML Extensin für Visual Studio Code.

Die PlantUML Extension kann entweder über den Visual Studio Marketplace manuell heruntergeladen und installiert werden, oder aber Du installierst die PlantUML Extension direkt über den Extension Manager in Visual Studio Code.

Ein Diagramm in Visual Studio Code erstellen

Wenn die PlantUML Extension in Visual Studio Code intalliert ist, erzeugt man am Besten ein Arbeitsverzeichnis, in dem die Diagramme erstellt werden.

In diesem Arbeitsverzeichnis wird eine einfach Textdatei mit der Dateiendung .puml erstellt.

Beispielsweise: klassendiagram.puml

Um ein Klassendiagramm in PlantUML zu erstellen, gibst Du folgenden Text ein:

@startuml

class Person
{
    +Name: string
    +Age: int
}

@enduml

Die PlantUML Extension versucht den Text zu interpretieren und rendert das Diagramm in der Vorschau. Das Ergebnis sollte folgendes Diagramm sein:

Klassendiagramm in PlantUML

PlantUML Export Dateiformate

PlantUML kann Diagramme in in einer Vielzahl von Dateiformaten exportieren. Aber die wichtigsten Dateiformate sind PNG und SVG.

Das Dateiformat PNG eignet sich gut, um Diagramme als Vektorgrafiken zu speichern und in Dokumentationen einzubinden.

Das Dateiformat SVG (Scalable Vector Graphics) eignet sich besondert gut, um verlustfreie und skalierbare Diagramme zu erstellen, in denen Links zu anderen Diagrammen eingefügt werden können. SVG Diagramme werden dadurch interaktiv.

Dokumentation und Beispiele

Auf der Website plantuml.com wird umfangreich und sehr detailliert erklärt, wie die Diagramme zu beschreiben sind. Zu allen Diagrammtypen gibt es eine Vielzahl an Beispielen, wodurch eine schnelle und unkomplizierte Erstellung von Diagrammen ermöglicht wird.

Kommentare sind geschlossen