Übung 1.2: Code-Überprüfung ausführen und Schnellkorrektur anwenden
Für diese Übung wird vorausgesetzt, dass Sie Übung 1.1: Erforderliche Ressourcen importieren abgeschlossen haben. Zuerst lesen Sie in dieser Übung ein Benutzerszenario. Dann übernehmen Sie die Rolle des im Benutzerszenario beschriebenen Softwareentwicklers.
Benutzerszenario
Eine große Gruppe geografisch verteilter Entwickler schreibt den Code für eine neue Softwareanwendung. Es ist wichtig, dass die Entwickler regelmäßig Code-Überprüfungen im Hinblick auf mögliche Fehler oder Probleme ausführen.
Einer der Entwickler möchte eine Code-Überprüfung ausführen, um festzustellen, wie der Code sich im Allgemeinen verhält. Der Entwickler führt eine automatisierte Schnellprüfung des Codes aus, um neu geschriebenen Code im Hinblick auf die Einhaltung von Best Practices in mehreren Bereichen zu bewerten. In dieser Überprüfung werden mehrere Kategorien der vorgegebenen Regeln auf den Code angewendet. Die einzelnen Regelkategorien überprüfen die Qualität des Codes in bestimmten Bereichen, wie z. B. der Leistung.
Wenn die Code-Überprüfung fertig gestellt ist, wird eine Liste mit den Überprüfungsergebnissen angezeigt. Jedes Ergebnis steht für eine Codezeichenfolge, die die angewendeten Regeln nicht korrekt einhält. Für eines der Ergebnisse ist eine Schnellkorrektur verfügbar, so dass der Entwickler die automatisierte Lösung anwenden und den Fehler direkt beheben kann.
Im ersten Teil der Übung führen Sie die folgenden Tasks aus, um eine Code-Überprüfung auszufü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
Anschließend führen Sie die folgenden Tasks aus, um eine Schnellkorrektur auf ein Ergebnis Ihrer Code-Überprüfung anzuwenden:
- Feststellen, ob eine Schnellkorrektur für ein Überprüfungsergebnis verfügbar ist
- Eine Liste von Änderungen anzeigen, welche die Schnellkorrektur an dem Code durchführen wird
- Den ursprünglichen und den refaktorierten Code voranzeigen, bevor Sie die Schnellkorrektur anwenden
- Die Schnellkorrektur anwenden, um den Code zu refaktorieren
- Eine Bestätigung erhalten, nachdem die Schnellkorrektur angewendet wurde
Übung
Eine Code-Überprüfung auswählen
So wählen Sie eine Schnellprüfung des Codes aus:
- Klicken Sie in der Funktionsleiste der Code-Überprüfungssicht auf das Symbol Regeln verwalten
.

- Klicken Sie in der Liste Select Code Review auf Quick Code Review. Wie in der folgenden Anzeigenerfassung dargestellt, werden die Ordner mit den Regeln für die von Ihnen ausgewählte Code-Überprüfung angezeigt:

- Wenn Sie eine der Regeln anzeigen möchten, die in der Code-Überprüfung angewendet wird, erweitern Sie den Ordner J2SE Best Practices und anschließend den Unterordner Null. Der Ordner Null zeigt eine Regel mit der Fehlerbewertungsstufe an, wie in der folgenden Anzeigenerfassung dargestellt:

Zur besseren Übersicht werden die Symbole der Fehlerbewertungsstufe in der folgenden Abbildung dargestellt:

- Klicken Sie auf OK, um die Schnellprüfung des Codes ('Quick Code Review') auszuwählen.
Eine zu überprüfende Codebasis auswählen
So wählen Sie das Projekt als zu überprüfende Codebasis aus:
- Klicken Sie in der Funktionsleiste der Code-Überprüfungssicht auf das Symbol Review (
) > Projects > Review CodeReview_Examples.
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 finden Sie die folgenden Informationen:
- Statistische Daten zur Code-Überprüfung: In der Zeile über den Überprüfungsergebnissen werden Informationen zu den letzten Code-Überprüfungen angezeigt, wie Typ, 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 die angewendete Regelkategorie 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:
- Blättern Sie in der Code-Überprüfungssicht zum Ordner J2SE Best Practices: Comparison. Erweitern Sie den Ordner, um in ihm die Überprüfungsergebnisse anzuzeigen, wie in der folgenden Anzeigenerfassung dargestellt:

- Das erste Ergebnis beginnt mit "EqualsHashCode_Example.java". Die Regel, die angewendet wurde, ist danach vermerkt:
Always override both java.lang.Object.equals() and java.lang.Object.hashCode()
- Klicken Sie doppelt auf das erste Ergebnis. 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.

Ein Überprüfungsergebnis auswählen, für das eine Schnellkorrektur verfügbar ist
Sie können anhand der jeweiligen Symbole erkennen, dass für beide Ergebnisse im Vergleichsordner 'Best Practices' eine Schnellkorrektur verfügbar ist. Zur besseren Übersicht werden die Schnellkorrektursymbole in der folgenden Abbildung angezeigt:

- Klicken Sie mit der rechten Maustaste auf das erste Ergebnis in der Liste, wie in der nächsten Anzeigenerfassung dargestellt.
- Im Popup-Menü variiert die Auswahl Quick Fix je nach der möglichen Lösung. Für das von Ihnen ausgewählte Überprüfungsergebnis besteht die Korrektur darin, Hash-Code und gleiche Werte zu implementieren.

- Klicken Sie auf Quick Fix: Implement hashCode and equals.
Die Schnellkorrektur anwenden
Die Schnellkorrektur für das von Ihnen ausgewählte Ergebnis besteht darin, Hash-Code und gleiche Werte zu implementieren.
So überprüfen Sie das Ergebnis und wenden die Schnellkorrektur auf das Ergebnis an:
- Sie sehen eine nebeneinander dargestellte vergleichende Sicht des Codes, wie in der folgenden Anzeigenerfassung dargestellt. Der ursprüngliche Quellcode steht auf der linken Seite, der refaktorierte Quellcode, der durch die Schnellkorrektur erstellt würde, steht auf der rechten Seite. Wenn Sie sich entscheiden, die Schnellkorrektur anzuwenden, werden die fehlenden hervorgehobenen Codezeilen angehängt.

- Erweitern Sie wie in der untenstehenden Anzeigenerfassung dargestellt im Abschnitt Durchzuführende Änderungen die Liste, um genau sehen zu können, was durch die Schnellkorrektur geändert wird, und in welcher Form:

- Prüfen Sie die Änderungen in der Liste. Klicken Sie dann auf OK, um die Schnellkorrektur auf alle ausgewählten Änderungen in der Liste anzuwenden.
- Nachdem die Schnellkorrektur angewendet wurde sehen Sie einen Haken neben dem Überprüfungsergebnis, das Sie erfolgreich bearbeitet haben.

Neben dem Haken finden Sie die folgenden Informationen:
- Die Schnellkorrektur, die Sie angewendet haben
- Die Zeilennummer des Quellcodes, in dem das Überprüfungsergebnis gefunden wurde
- Die Regel der Code-Überprüfung, die nicht eingehalten worden war
Sie haben die folgende Übung abgeschlossen: Code-Überprüfung ausführen und Schnellkorrektur anwenden.
Zusammenfassung der Übung
Sie haben sämtliche Tasks der Übung "Code-Überprüfung ausführen und Schnellkorrektur anwenden" ausgeführt.
Tasks zum Ausführen einer Code-Überprüfung
Bei der Ausführung der Code-Überprüfung 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
Tasks zum Anwenden einer Schnellkorrektur
Bei der Anwendung der Schnellkorrektur haben Sie eine weitere Reihe von Tasks ausgeführt:
- Festgestellt, ob eine Schnellkorrektur für ein Überprüfungsergebnis verfügbar ist
- Eine Liste von Änderungen angezeigt, welche die Schnellkorrektur an dem Code durchführen würde
- Den ursprünglichen und den refaktorierten Code vorangezeigt
- Die Schnellkorrektur angewendet, um den Code zu refaktorieren
- Eine Bestätigung abgerufen, dass die Schnellkorrektur angewendet wurde
Nutzung des Potenzials einer Code-Überprüfung
Durch das proaktive Ausführen von Code-Überprüfungen sind Sie in der Lage, die Überprüfungsergebnisse frühzeitig zu analysieren. Dies bedeutet auch, dass Sie sie in einem frühen Stadium beheben können, bevor sie die folgenden Probleme verursachen:
- Die Leistung, Instandhaltung oder Skalierbarkeit Ihrer Anwendung beeinträchtigen
- Ihr Unternehmen Geld, Zeit und Ressourcen kosten
Nutzung des Potenzials einer Schnellkorrektur
Durch die Anwendung einer der mitgelieferten Schnellkorrekturen steht Ihnen eine automatisierte Möglichkeit zur Lösung eines allgemeinen Problems zur Verfügung. Schnellkorrekturen unterstützen Sie folgendermaßen:
- Sie korrigieren ein Problem oder einen Fehler jedes Mal durchgängig
- Lässt Ihnen mehr Zeit, sich um den Code zu kümmern, statt Fehler beheben zu müssen
Stellen Sie das Lernprogramm fertig, indem Sie die Lernziele in Zusammenfassung: Code-Überprüfung ausführen rekapitulieren.