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

  1. Eine auszuführende Code-Überprüfung auswählen
  2. Die Regeln anzeigen, die in der Code-Überprüfung Anwendung finden
  3. Den Code auswählen, der überprüft werden soll
  4. Die Code-Überprüfung ausführen
  5. Die Ergebnisse der Code-Überprüfung anzeigen
  6. Ein Überprüfungsergebnis auswählen, um folgenden Informationen dafür anzuzeigen:

Anschließend führen Sie die folgenden Tasks aus, um eine Schnellkorrektur auf ein Ergebnis Ihrer Code-Überprüfung anzuwenden:

  1. Feststellen, ob eine Schnellkorrektur für ein Überprüfungsergebnis verfügbar ist
  2. Eine Liste von Änderungen anzeigen, welche die Schnellkorrektur an dem Code durchführen wird
  3. Den ursprünglichen und den refaktorierten Code voranzeigen, bevor Sie die Schnellkorrektur anwenden
  4. Die Schnellkorrektur anwenden, um den Code zu refaktorieren
  5. 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:

  1. Klicken Sie in der Funktionsleiste der Code-Überprüfungssicht auf das Symbol Regeln verwalten Text.
  2. Sicht 'Code-Überprüfung'

  3. 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:
  4. Fenster 'Benutzervorgaben', 'Quick Code Review' ausgewählt

  5. 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:
  6. Fenster 'Benutzervorgaben', Kategorie 'J2SE Best Practices', Vergleichsordner erweitert

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

    Text

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



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:

Code-Überprüfungsergebnisse, komprimiert

In der Code-Überprüfungssicht finden Sie die folgenden Informationen:



Weitere Informationen zu einem bestimmten Ergebnis der Code-Überprüfung abrufen

So rufen Sie weitere Informationen zu einem Ergebnis der Code-Überprüfung ab:

  1. 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:
  2. Code-Überprüfungsergebnisse, Kategorie 'J2SE Best Practices', Vergleichsordner erweitert

  3. Das erste Ergebnis beginnt mit "EqualsHashCode_Example.java". Die Regel, die angewendet wurde, ist danach vermerkt:
  4. Always override both java.lang.Object.equals() and java.lang.Object.hashCode()

  5. 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:
  6. Details für ausgewähltes Code-Überprüfungsergebnis.



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:

Text

  1. Klicken Sie mit der rechten Maustaste auf das erste Ergebnis in der Liste, wie in der nächsten Anzeigenerfassung dargestellt.
  2. 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.
  3. Popup-Menü 'Schnellkorrektur'

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

  1. 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.
  2. 'Quick Fix' - Komprimierte Liste der Änderungen mit ursprünglichem und refaktoriertem Code

  3. 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:
  4. 'Quick Fix' - Erweiterte Liste der Änderungen

  5. 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.
  6. Nachdem die Schnellkorrektur angewendet wurde sehen Sie einen Haken neben dem Überprüfungsergebnis, das Sie erfolgreich bearbeitet haben.
  7. Code-Überprüfungsergebnisse mit Haken

    Neben dem Haken finden Sie die folgenden Informationen:

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:

  1. Eine auszuführende Code-Überprüfung ausgewählt
  2. Die Regeln angezeigt, die in der Code-Überprüfung Anwendung finden
  3. Ein Stück Code ausgewählt, das überprüft werden sollte
  4. Die Code-Überprüfung ausgeführt
  5. Die Ergebnisse der Code-Überprüfung angezeigt
  6. Ein Überprüfungsergebnis ausgewählt, um folgende Informationen dafür anzuzeigen:


Tasks zum Anwenden einer Schnellkorrektur

Bei der Anwendung der Schnellkorrektur haben Sie eine weitere Reihe von Tasks ausgeführt:

  1. Festgestellt, ob eine Schnellkorrektur für ein Überprüfungsergebnis verfügbar ist
  2. Eine Liste von Änderungen angezeigt, welche die Schnellkorrektur an dem Code durchführen würde
  3. Den ursprünglichen und den refaktorierten Code vorangezeigt
  4. Die Schnellkorrektur angewendet, um den Code zu refaktorieren
  5. 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:



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:

Stellen Sie das Lernprogramm fertig, indem Sie die Lernziele in Zusammenfassung: Code-Überprüfung ausführen rekapitulieren.



Feedback
(C) Copyright IBM Corporation 2000, 2005. Alle Rechte vorbehalten.