Übung 1.2: Eine Code-Überprüfung des Typs "Structural Analysis" ausführen
Für diese Übung wird vorausgesetzt, dass Sie Übung 1.1: Erforderliche Ressourcen importieren abgeschlossen haben. In Übung 1.2 lesen Sie zuerst ein Benutzerszenario. Dann übernehmen Sie die Rolle des im Benutzerszenario beschriebenen Softwarearchitekts und verwenden das Projekt, das Sie in Übung 1.1 importiert haben, um die Übung abzuschließen.
Benutzerszenario
Der Architekt möchte neu geschriebenen Code im Hinblick auf dessen Qualität bewerten und sucht daher nach allgemeinen Antimustern. Antimuster sind bekannte Probleme, die in Code auftreten und nicht die bewährten Verfahren ("Best Practices") einhalten. Im Gegensatz zu Designmustern, die als gute Modelle zur Einhaltung empfohlen werden, handelt es sich bei Antimustern um fehlerhafte Modelle, die Sie vermeiden sollten. Bestimmte Antimustertypen sind u.a. die Folgenden:
- "Breakable": Das Objekt hat im Code so viele Abhängigkeiten, dass es wahrscheinlich zerstört wird, wenn ein anderes Objekt geändert wird.
- "Cyclic dependency": Eine Objektgruppe ist auf eine oftmals rückwirkende Weise verbunden, so dass eine Änderung an einem beliebigen der Objekte sich auf alle anderen auswirken könnte. Wird auch als "Tangle" bezeichnet.
- "Hub": Das Objekt hat viele Abhängigkeiten, und es gibt gleichzeitig viele Abhängigkeiten von dem Objekt. Wenn ein anderes Objekt geändert wird, ist das Objekt davon betroffen. Ebenso sind andere Objekte betroffen, wenn das Objekt geändert wird.
In der ersten Übung führt der Architekt eine Code-Überprüfung aus, um nach den oben beschriebenen Antimustern zu suchen.
Übung
In dieser Übung werden Sie die folgenden Aufgaben ausführen:
- Eine auszuführende Code-Überprüfung auswählen
- Die Regeln anzeigen, die in der Code-Überprüfung Anwendung finden
- Den Code auswählen, der überprüft werden soll
- Die Code-Überprüfung ausführen
- Die Ergebnisse der Code-Überprüfung anzeigen
- Ein Überprüfungsergebnis auswählen, um folgenden Informationen dafür anzuzeigen:
- Quellcode
- Beschreibung, Beispiele und Lösungen
Eine Code-Überprüfung auswählen
So wählen sie die Code-Überprüfung "Structural Analysis" aus:
- Klicken Sie in der Funktionsleiste der Code-Überprüfungssicht auf das Symbol Regeln verwalten
.

- Klicken Sie in der Liste Select Code Review auf Structural Analysis Code Review.
- Erweitern Sie den Ordner Structural Analysis und die Unterordner, um die in der Code-Überprüfung angewendeten Regeln zu sehen, wie unten dargestellt. Klicken Sie auf OK.

Eine zu überprüfende Codebasis auswählen
So wählen Sie einen bestimmten Arbeitsbereich als zu überprüfende Codebasis aus:
- Klicken Sie in der Funktionsleiste der Code-Überprüfungssicht auf das Symbol Review (
) > Review Workspace.
Die Code-Überprüfung ausführen
Sobald Sie die zu überprüfende Codebasis ausgewählt haben, wird die Code-Überprüfung ausgeführt. Über den Fortschrittsanzeiger in der unteren rechten Ecke der Sicht können Sie ihren Status verfolgen.
Die Ergebnisse der Code-Überprüfung anzeigen
Wenn die Code-Überprüfung fertig gestellt ist, werden die Ergebnisse in der Code-Überprüfungssicht angezeigt, wie in der folgenden Anzeigenerfassung dargestellt:

In der Code-Überprüfungssicht werden die folgenden Informationen bereit gestellt.
- Statistische Daten zur Code-Überprüfung: In der Zeile über den Überprüfungsergebnissen werden Informationen zu den letzten Code-Überprüfungen angezeigt, wie Name, Inhalt und Umfang, Anzahl der enthaltenen Regeln und Dateien, sowie Anzahl und Wertigkeit der Ergebnisse.
- Ergebnisse der Code-Überprüfung: Die Ergebnisse der Code-Überprüfung werden in der Code-Überprüfungssicht in Ordnern aufgelistet. Die Ordnernamen geben Auskunft über den Namen der Code-Überprüfung, sowie über die Kategorie und die Anzahl der Überprüfungsergebnisse.
Weitere Informationen zu einem bestimmten Ergebnis der Code-Überprüfung abrufen
So rufen Sie weitere Informationen zu einem Ergebnis der Code-Überprüfung ab:
- Erweitern Sie den Ordner Structural Analysis: Cyclic Dependency. Er enthält vier Überprüfungsergebnisse, wie in der folgenden Anzeigenerfassung dargestellt:

Vor jedem Überprüfungsergebnis steht ein Symbol, das die Wertigkeit des Ergebnisses darstellt.

Wenn neben einem Ergebnis eine Glühbirne steht (
), bedeutet dies, dass für das Ergebnis eine Schnellkorrektur verfügbar ist. Eine Schnellkorrektur ist eine automatisierte, vorgegebene Lösung für ein bestimmtes Überprüfungsergebnis. Die Schnellkorrektursymbole werden in der folgenden Abbildung angezeigt:

- Klicken Sie doppelt auf das Ergebnis, das mit "Event.java" beginnt. Die zugehörigen Details werden an zwei Stellen angezeigt, wie in den folgenden Punkten und der Anzeigenerfassung dargestellt:
- Quellcode: Zeigt den Teil des Codes an, in dem das Ergebnis aufgetreten ist und hebt die exakte Position hervor.
- Sicht 'Code Review Details': Beschreibt das Überprüfungsergebnis noch detaillierter und bietet Beispiele und Lösungen, um es zu korrigieren. Wenn das Überprüfungsergebnis eine zyklische Abhängigkeit darstellt ("cyclic dependency"), gibt es außerdem einen Abschnitt zu den Schleifendetails.

Sie haben Übung 1.2: Eine Code-Überprüfung des Typs "Structural Analysis" ausführen - erfolgreich abgeschlossen.
Nutzung des Potenzials einer Code-Überprüfung
Wenn Sie eine Code-Überprüfung proaktiv ausführen, können Sie Probleme oder Fehler in einem frühen Stadium aufdecken, so dass Sie sie auch frühzeitig korrigieren können, bevor sie die folgenden Probleme verursachen:
- Die Leistung, Instandhaltung oder Skalierbarkeit Ihrer Anwendung beeinträchtigen
- Ihr Unternehmen Geld, Zeit und Ressourcen kosten
In Übung 1.4 bauen Sie auf den Ergebnissen aus Übung 1.2 auf und reparieren ein Code-Überprüfungsergebnis.
Zusammenfassung der Übung 1.2
Sie haben Übung 1.2: Eine Code-Überprüfung des Typs "Structural Analysis" ausführen - erfolgreich abgeschlossen. Darin haben Sie die folgenden Tasks ausgeführt:
- Eine auszuführende Code-Überprüfung ausgewählt
- Die Regeln angezeigt, die in der Code-Überprüfung Anwendung finden
- Ein Stück Code ausgewählt, das überprüft werden sollte
- Die Code-Überprüfung ausgeführt
- Die Ergebnisse der Code-Überprüfung angezeigt
- Ein Überprüfungsergebnis ausgewählt, um folgende Informationen dafür anzuzeigen:
- Quellcode
- Beschreibung, Beispiele und Lösungen
Jetzt können Sie mit Übung 1.3: Architektursteuerregel definieren beginnen.