Die Welt der Softwareentwicklung ist voller komplexer Konzepte und Algorithmen. Ein solches Konzept, das sowohl für Entwickler als auch für Tester von großer Bedeutung ist, ist die Zyklomatische Zahl. In diesem Blogbeitrag versuche ich einen detaillierten Überblick über die Zyklomatische Komplexität, ihre Geschichte, ihre Anwendung und Beispiele für ihren Einsatz zu bieten. Ich habe das Thema bereits in meinem Beitrag über SonarQube angeschnitten aber möchte es heute in einem gesonderten Beitrag festhalten.
Was ist die Zyklomatische Zahl?
Die Zyklomatische Zahl, auch als Zyklomatische Komplexität oder McCabe-Metrik bekannt, quantifiziert die Komplexität eines Programms oder einer Funktion basierend auf der Anzahl der linearen, unabhängigen Pfade durch den Code. Einfach ausgedrückt: Es handelt sich um eine Zahl, die angibt, wie viele verschiedene Wege es gibt, einen bestimmten Codeabschnitt auszuführen.
Entstehung
Thomas McCabe entwickelte die Zyklomatische Komplexität 1976. Er suchte nach einer Methode, die Komplexität von Software zu messen, um sowohl den Entwicklungsprozess zu verbessern als auch die Software-Qualität sicherzustellen. McCabes Forschung legte den Grundstein für viele der heutigen Softwaremetriken.
Vorgehensweise zur Bestimmung der Zyklomatischen Zahl
Die Bestimmung erfolgt durch die Formel:
V(G)=E−N+2P
wobei:
- V Die zyklomatische Komplexität
- G Kontrollflussgraph des Programms oder der Funktion, den man analysiert
- E Die Anzahl der Kanten im Kontrollflussgraphen
- N Die Anzahl der Knoten
- P Die Anzahl der verbundenen Komponenten (normalerweise 1 für einen zusammenhängenden Graphen) sind.
Anwendungsbeispiele
Qualitätssicherung: Ein hohes Maß an zyklomatischer Komplexität deutet auf einen Code hin, der schwer zu warten und zu testen ist. Ein niedriger Wert hingegen suggeriert einen einfacheren und wartungsfreundlicheren Code.
Software-Testing: Die Zyklomatische Zahl gibt an, wie viele Testfälle man mindestens benötigt, um jeden Pfad durch den Code einmal auszuführen. Dies erleichtert die Testplanung.
Praktische Beispiele
Bei der Betrachtung des nachfolgenden einfachen Codeausschnitts:
def beispiel_funktion(x): if x > 10: return "Groß" else: return "Klein"Man stellt fest, dass die zyklomatische Komplexität dieses Codes 2 beträgt, da es zwei Pfade durch den Code gibt: Einmal, wenn die Bedingung wahr ist, und einmal, wenn sie falsch ist.
Ein komplexerer Code mit Schleifen und mehreren Bedingungen hätte entsprechend eine höhere zyklomatische Komplexität.
Zyklomatische Komplexität – Interaktive Visualisierung
Über die Anwendung:
Wie bereits erklärt, handelt es sich bei der zyklomatischen Komplexität um ein Software-Metriken-Indikator, der die Anzahl der linearen unabhängigen Pfade durch den Quellcode eines Programms misst. Sie dient als ein Maß für die Komplexität eines Programms. Diese interaktive Anwendung visualisiert diese Komplexität durch Knoten (entsprechend den Anweisungen/Blöcken in einem möglichen Code) und Verbindungen zwischen ihnen (entsprechend den Pfaden).
So wird die Anwendung verwendet:
- Knoten hinzufügen/entfernen:
Die Schaltflächen „Knoten hinzufügen“ und „Letzten Knoten entfernen“, um Knoten zum Diagramm hinzuzufügen bzw. zu entfernen. - Verbindungen erstellen:
Klicken auf einen Knoten, um ihn auszuwählen (er wird markiert). Im Anschluss auf einen anderen Knoten klicken, um eine Verbindung zwischen den beiden Knoten herzustellen. - Knoten bewegen:
Knoten ziehen, um seine Position im Diagramm zu verändern. - Zyklomatische Komplexität ablesen:
Die zyklomatische Komplexität wird unter dem Diagramm angezeigt. Sie aktualisiert sich automatisch basierend auf der Anzahl der Knoten und Verbindungen in dem Diagramm.
Hinweis:
Die Visualisierung passt sich automatisch an, je nachdem, wie viele Knoten und Verbindungen man hinzufügt. Man kann mit verschiedenen Strukturen experimentieren, um ein besseres Verständnis für die zyklomatische Komplexität und ihre Bedeutung in der Softwareentwicklung zu erhalten.
Fazit
Die Zyklomatische Zahl bietet einen wertvollen Einblick in die Komplexität von Softwarecode. Sie ermöglicht Entwicklern und Testern, den Code besser zu verstehen, die Qualität zu bewerten und den Testaufwand einzuschätzen. Durch das Verständnis und die Anwendung dieses Konzepts können Softwareteams effizienter arbeiten und höherwertige Produkte liefern.