Ü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:

  1. Auswählen einer Codeprüfung
  2. Anzeigen der in der Codeprüfung angewendeten Regeln
  3. Wählen des Codes, für den die Prüfung ausgeführt werden soll
  4. Ausführen der Codeprüfung
  5. Anzeigen der bei der Codeprüfung gefundenen Fehler
  6. Auswählen eines Fehlers, um die folgenden Informationen dazu anzuzeigen:

Anschließend führen Sie die folgenden Aufgaben aus, um einen Quick-Fix auf einen der bei der Codeprüfung gefundenen Fehler anzuwenden:

  1. Erkennen, wenn ein Quick-Fix für einen gefundenen Fehler zur Verfügung steht
  2. Anzeigen einer Liste mit Änderungen, die durch den Quick-Fix am Code vorgenommen werden
  3. Voranzeige des ursprünglichen und des umstrukturierten Codes vor der Anwendung des Quick-Fixes
  4. Anwenden des Quick-Fixes zur Umstrukturierung (Refactoring) des Codes
  5. Abrufen einer Bestätigung nach der Anwendung des Quick-Fixes


Übung

Codeprüfung auswählen

So wählen Sie eine Codeprüfung aus:

  1. Klicken Sie in der Funktionsleiste in der Ansicht "Code Review" auf das Symbol für Regeln verwalten Text.
  2. Ansicht 'Code Review'

  3. 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):
  4. Fenster für Vorgaben, Eintrag für 'Schnelle Codeprüfung' ausgewählt

  5. 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):
  6. Fenster für Vorgaben, Kategorie 'J2SE Best Practices', Ordner für Vergleich (erweitert)

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

    Text

  7. 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:



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 gefundene Fehler, ausgeblendet

Bei der Codeprüfung erhalten Sie die folgenden Informationen:



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:

  1. 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):
  2. Bei der Codeprüfung gefundene Fehler, Kategorie 'J2SE Best Practices', Ordner für Vergleich (erweitert)

  3. Der erste gefundene Fehler beginnt mit "EqualsHashCode_Example.java". Anschließend wird die angewendete Regel aufgeführt:
  4. Überschreiben Sie immer sowohl "java.lang.Object.equals()" als auch "java.lang.Object.hashCode()".

  5. Klicken Sie doppelt auf den ersten Fehler. Details dazu werden an zwei Stellen angezeigt, wie in den folgenden Punkten und im Screenshot dargestellt:
  6. Details zum ausgewählten Fehler der Codeprüfung.



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:

Text

  1. Klicken Sie mit der rechten Maustaste auf den ersten Fehler in der Liste (siehe folgenden Screenshot).
  2. 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".
  3. Quick-Fix-Popup-Menü

  4. 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:

  1. 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.
  2. Ausgeblendete Liste der Änderungen für den Quick-Fix mit ursprünglichem und umstrukturiertem Code

  3. 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):
  4. Liste der mit dem Quick-Fix verbundenen Änderungen (erweitert)

  5. Ü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.
  6. Nach der Anwendung des Quick-Fixes erscheint ein Haken neben dem behobenen Fehler.
  7. Bei der Codeprüfung gefundene Fehler mit Haken

    Neben dem Haken werden die folgenden Informationen bereitgestellt:

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:

  1. Auswählen einer Codeprüfung
  2. Anzeigen der in der Codeprüfung angewendeten Regeln
  3. Wählen eines Codes, auf dem die Prüfung ausgeführt werden sollte
  4. Ausführen der Codeprüfung
  5. Anzeigen der bei der Codeprüfung gefundenen Fehler
  6. Auswählen eines Fehlers, um die folgenden Informationen dazu anzuzeigen:


Aufgaben zur Anwendung eines Quick-Fixes

Beim Anwenden des Quick-Fixes führten Sie die nächste Gruppe von Aufgaben aus:

  1. Erkennen, wenn ein Quick-Fix für einen gefundenen Fehler zur Verfügung steht
  2. Anzeigen einer Liste mit Änderungen, die durch den Quick-Fix am Code vorgenommen würden
  3. Voranzeigen des ursprünglichen und des umstrukturierten Codes
  4. Anwenden des Quick-Fixes zur Umstrukturierung (Refactoring) des Codes
  5. 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:



Vorteile eines Quick-Fixes nutzen

Durch die Anwendung eines Quick-Fixes können Sie allgemeine Fehler automatisch korrigieren. Quick-Fixes ermöglichen Ihnen:

Zum Abschluss des Lernprogramms erhalten Sie in Zusammenfassung: Codeprüfung ausführen nochmals eine Übersicht über die Lernziele.



Nutzungsbedingungen | Feedback
(C) Copyright IBM Corporation 2000, 2004. Alle Rechte vorbehalten.