Übung 1.2: Codeprüfung ausführen und Quick-Fix anwenden
Für diese Übung wird vorausgesetzt, dass Sie bereits Übung 1.1: Erforderliche Ressourcen importieren ausgeführt haben. Lesen Sie zunächst das Benutzerszenario. Versetzen Sie sich anschließend in die Rolle des im Szenario beschriebenen Softwareentwicklers.
Benutzerszenario
Eine große Gruppe geographisch verteilter Entwickler schreibt den Code für eine neue Softwareanwendung. Es ist erforderlich, dass die Entwickler routinemäßig Codeprüfungen ausführen, um ihren Code auf Fehler zu überprüfen.
Ein Entwickler möchte eine Codeprüfung ausführen, um seine Arbeit allgemein zu beurteilen. Um zu prüfen, ob für neu geschriebenen Code in mehreren Bereichen die Einhaltung der Best Practices gewährleistet ist, führt er eine schnelle Codeprüfung aus. Bei dieser Prüfung werden mehrere Regelkategorien auf den Code angewendet. Jede Regelkategorie überprüft die Qualität des Codes in einem bestimmten Bereich, z. B. im Bereich Leistung.
Nach Abschluss der Codeprüfung erhalten Sie eine Liste der gefundenen Fehler. Jeder Fehler steht für eine Codezeichenfolge, bei der eine angewendete Regel nicht streng eingehalten wurde. Für einen der gefundenen Fehler steht ein Quick-Fix zur Verfügung. So kann der Entwickler die automatisierte Lösung anwenden und den Fehler umgehend korrigieren.
Im ersten Teil der Übung führen Sie im Rahmen der Codeprüfung die folgenden Aufgaben aus:
- Auswählen einer Codeprüfung
- Anzeigen der in der Codeprüfung angewendeten Regeln
- Wählen des Codes, für den die Prüfung ausgeführt werden soll
- Ausführen der Codeprüfung
- Anzeigen der bei der Codeprüfung gefundenen Fehler
- Auswählen eines Fehlers, um die folgenden Informationen dazu anzuzeigen:
- Quellcode
- Beschreibung, Beispiele und Lösungen
Anschließend führen Sie die folgenden Aufgaben aus, um einen Quick-Fix auf einen der bei der Codeprüfung gefundenen Fehler anzuwenden:
- Erkennen, wenn ein Quick-Fix für einen gefundenen Fehler zur Verfügung steht
- Anzeigen einer Liste mit Änderungen, die durch den Quick-Fix am Code vorgenommen werden
- Voranzeige des ursprünglichen und des umstrukturierten Codes vor der Anwendung des Quick-Fixes
- Anwenden des Quick-Fixes zur Umstrukturierung (Refactoring) des Codes
- Abrufen einer Bestätigung nach der Anwendung des Quick-Fixes
Übung
Codeprüfung auswählen
So wählen Sie eine Codeprüfung aus:
- Klicken Sie in der Funktionsleiste in der Ansicht "Code Review" auf das Symbol für Regeln verwalten
.

- Klicken Sie in der Liste Codeprüfung auswählen auf den Eintrag für Schnelle Codeprüfung. Die Ordner mit den Regeln für die von Ihnen ausgewählte Codeprüfung werden angezeigt (siehe folgenden Screenshot):

- Zum Anzeigen einer der Regeln, die bei der Codeprüfung angewendet werden erweitern Sie den Ordner J2SE Best Practices und anschließend den Unterordner Null. Ordner "Null" zeigt eine Regel mit einer Fehlerwertigkeit an (siehe folgenden Screenshot):

Zur Verdeutlichung enthält die folgende Abbildung eine Übersicht über die Symbole für die Wertigkeit:

- Klicken Sie auf OK, um die Option für "Schnelle Codeprüfung" auszuwählen.
Codebasis für die Prüfung auswählen
So wählen Sie das Projekt als Codebasis für die Prüfung aus:
- Klicken Sie in der Funktionsleiste in der Ansicht "Code Review" auf das Symbol für Prüfung
> Projekte > Review CodeReview_Examples.
Codeprüfung ausführen
Nach Auswahl der Codebasis für die Prüfung wird die Codeprüfung ausgeführt. Sie können den Status der Prüfung anhand des Fortschrittsanzeigers in der unteren rechten Ecke der Ansicht verfolgen.
Bei der Codeprüfung gefundene Fehler anzeigen
Nach Abschluss der Codeprüfung werden die gefundenen Fehler in der Ansicht "Code Review" angezeigt (siehe folgenden Screenshot):

Bei der Codeprüfung erhalten Sie die folgenden Informationen:
- Statistik zur Codeprüfung: Die Zeile oberhalb der gefundenen Fehler enthält Informationen über die zuletzt ausgeführte Codeprüfung: Typ, Umfang, Anzahl der Regeln und geprüften Dateien sowie Anzahl und Wertigkeit der Fehler.
- Bei der Codeprüfung gefundene Fehler: Die bei der Codeprüfung gefundenen Fehler werden in der Ansicht "Code Review" in Ordnern aufgelistet. Jeder Ordnername gibt Auskunft über die Regelkategorien und die Anzahl der Fehler.
Weitere Informationen zu einem bei der Codeprüfung gefundenen Fehler abrufen
So rufen Sie weitere Informationen zu einem bei der Codeprüfung gefundenen Fehler ab:
- Blättern Sie in der Ansicht "Code Review" zum Ordner J2SE Best Practices: Comparison. Erweitern Sie anschließend den Ordner, um die darin enthaltenen Fehler anzuzeigen (siehe folgenden Screenshot):

- Der erste gefundene Fehler beginnt mit "EqualsHashCode_Example.java". Anschließend wird die angewendete Regel aufgeführt:
Überschreiben Sie immer sowohl "java.lang.Object.equals()" als auch "java.lang.Object.hashCode()".
- Klicken Sie doppelt auf den ersten Fehler. Details dazu werden an zwei Stellen angezeigt, wie in den folgenden Punkten und im Screenshot dargestellt:
- Quellcode: Zeigt den Code an, wo der Fehler auftritt, und hebt die genaue Position hervor.
- Ansicht "Codeprüfung - Details": Liefert eine detailliertere Fehlerbeschreibung und stellt Beispiele und Lösungen zur Korrektur bereit.

Fehler auswählen, für den ein Quick-Fix zur Verfügung steht
Sie können anhand des Symbols erkennen, dass für beide Fehler im Ordner "Best Practices: Comparison" ein Quick-Fix zur Verfügung steht. Zur Verdeutlichung enthält die folgende Abbildung eine Übersicht über die Symbole für die Quick-Fixes:

- Klicken Sie mit der rechten Maustaste auf den ersten Fehler in der Liste (siehe folgenden Screenshot).
- Die Menüauswahl im Quick-Fix-Popup-Menü ist abhängig von der Lösung. Für den von Ihnen ausgewählten Fehler besteht die Korrektur in der Implementierung der Methoden "hashCode" und "equals".

- Klicken Sie auf Quick Fix: Implement hashCode and equals.
Quick-Fix anwenden
Der Quick-Fix für den von Ihnen ausgewählten Fehler besteht in der Implementierung der Methoden "hashCode" und "equals".
So führen Sie die Prüfung aus und wenden den Quick-Fix auf den Fehler an:
- Zwei Codeversionen werden nebeneinander angezeigt (siehe folgenden Screenshot). Der ursprüngliche Quellcode wird links und der umstrukturierte Quellcode, der durch den Quick-Fix erstellt würde, wird rechts angezeigt. Wenn Sie den Quick-Fix anwenden, werden dadurch die hervorgehobenen fehlenden Codezeilen angefügt.

- Erweitern Sie die Liste im Bereich Changes to be performed, um genau sehen zu können, welche und wie der Quick-Fix Änderungen vornimmt (siehe folgenden Screenshot):

- Überprüfen Sie die Änderungen in der Liste. Klicken Sie dann auf OK, um den Quick-Fix auf alle ausgewählten Änderungen in der Liste anzuwenden.
- Nach der Anwendung des Quick-Fixes erscheint ein Haken neben dem behobenen Fehler.

Neben dem Haken werden die folgenden Informationen bereitgestellt:
- Angewendeter Quick-Fix
- Die Nummer der Zeile im Quellcode, in der sich der gefundene Fehler befindet
- Regel in der Codeprüfung, die nicht eingehalten wurde
Sie haben damit die Übung "Codeprüfung ausführen und Quick-Fix anwenden" abgeschlossen.
Nachbearbeitung der Übung
Sie haben alle Aufgaben in der Übung "Codeprüfung ausführen und Quick-Fix anwenden" ausgeführt.
Aufgaben zum Ausführen einer Codeprüfung
Bei dieser Codeprüfung führten Sie folgende Aufgaben aus:
- Auswählen einer Codeprüfung
- Anzeigen der in der Codeprüfung angewendeten Regeln
- Wählen eines Codes, auf dem die Prüfung ausgeführt werden sollte
- Ausführen der Codeprüfung
- Anzeigen der bei der Codeprüfung gefundenen Fehler
- Auswählen eines Fehlers, um die folgenden Informationen dazu anzuzeigen:
- Quellcode
- Beschreibung, Beispiele und Lösungen
Aufgaben zur Anwendung eines Quick-Fixes
Beim Anwenden des Quick-Fixes führten Sie die nächste Gruppe von Aufgaben aus:
- Erkennen, wenn ein Quick-Fix für einen gefundenen Fehler zur Verfügung steht
- Anzeigen einer Liste mit Änderungen, die durch den Quick-Fix am Code vorgenommen würden
- Voranzeigen des ursprünglichen und des umstrukturierten Codes
- Anwenden des Quick-Fixes zur Umstrukturierung (Refactoring) des Codes
- Abrufen einer Bestätigung über die Anwendung des Quick-Fixes
Vorteile einer Codeprüfung nutzen
Durch das proaktive Ausführen von Codeprüfungen können Sie die gefundenen Fehler nicht nur bereits in einem frühen Stadium analysieren, sondern auch korrigieren und somit die folgenden Probleme ausschließen:
- Beeinträchtigung der Leistung, Wartung oder Skalierbarkeit der Anwendung
- Verursachung von Kosten-, Zeit- und Ressourcenaufwänden für Ihr Unternehmen
Vorteile eines Quick-Fixes nutzen
Durch die Anwendung eines Quick-Fixes können Sie allgemeine Fehler automatisch korrigieren. Quick-Fixes ermöglichen Ihnen:
- Konsistente Korrektur eines Fehlers bei jedem Auftreten
- Effizientes Arbeiten und geringerer Zeitaufwand bei der Fehlerkorrektur
Zum Abschluss des Lernprogramms erhalten Sie in Zusammenfassung: Codeprüfung ausführen nochmals eine Übersicht über die Lernziele.