- 10. Januar 2014

Auf Fehlersuche in der NWDS mit dem Java Code Inspektor

In der ABAP Workbench hat die SAP mit dem Code Inspector ein Tool integriert, das eine automatisierte Prüfung des Codings auf zuvor festgelegte Varianten und Richtlinien hin ermöglicht. Die Seite der Java-Programmierung wurde jedoch nicht mit einer solchen Spürnase für uneinheitliche Code-Darstellung und Verletzung von Richtlinien beglückt und muss sich daher anders behelfen.

Das Checkstyle-Plugin für NWDS

Glücklicherweise gibt es im Bereich Eclipse – und damit auch für die NWDS – bereits Plugins, die eine automatisierte Prüfung des Quelltextes nach zuvor definierten Regeln ermöglichen. Ein solches Plugin ist „Checkstyle“. Ist es einmal eingebunden, kann es für bestimmte Projekte in der NWDS aktiviert werden. Innerhalb der übersichtlichen Darstellung aller aufgetretenen Abweichungen, zum Beispiel in Form von Diagrammen und Listen, kann direkt an die Fundstelle des Verstoßes navigiert werden. Weiter sorgt das Plugin in Projekten mit mehreren Entwicklern für die Einhaltung des definierten Codestyles.

Features von Checkstyle

Die Überprüfung mit Checkstyle liefert eine Liste von Coding, bei dem die vorgegebenen Richtlinien nicht eingehalten wurden. Beispielhaft ist eine solche Liste untenstehend dargestellt.

NWDS Plugin -  Checkstyles Liste der Abweichungen

NWDS Plugin – Checkstyles Liste der Abweichungen

In diesem Fall wurde auf die mit dem Plugin ausgelieferte Richtlinie von Sun zurückgegriffen. Es können jedoch auch umfangreiche eigene Kriterien für die Überprüfung definiert werden. Ein entsprechendes Tutorial und weitergehende Informationen finden Sie auf: http://eclipse-cs.sourceforge.net/basic_creating_config.html.

Durch einen Doppelklick auf eine Checkstyle-Meldung kann direkt in den bemängelten Code-Abschnitt navigiert werden, um die Abweichung gegebenenfalls zu korrigieren.

Checkstyle Code Highlighting

Hervorhebung gefundener Stellen durch Checkstyles

Die aufgespürten Codestellen sind gelb hinterlegt, über die Lupe am linken Rand kann die dazugehörige Meldung von Checkstyle per Mouseover eingeblendet werden.

Was kann aufgespürt werden?

Wie umfangreich ist jedoch der Kriterienkatalog? Einen Eindruck davon gibt der folgende Screenshot:

Checkstyle Konfiguration

Konfiguration eigener Checkstyles

Zu jedem Punkt gibt es einige Unterpunkte, die konfiguriert werden können. Durch Doppelklick auf ein Modul auf der rechten Seite können die Kriterien spezifiziert werden.

Einbinden des Checkstyle-Plugins

In der geöffneten NWDS kann das Plugin über den Pfad „Help“ -> „Install new Software“ im Repository
http://eclipse-cs.sf.net/update/
gefunden werden. Folgen Sie einfach den Installationsanweisungen. Anschließend bedarf es der Aktivierung in den Eclipse Properties und auf dem gewünschten Projekt.

Eine kurze Beschreibung dazu kann ebenfalls auf der Homepage von Checkstyle gefunden werden.

Abschließend interessiert mich natürlich: Welche Maßnahmen zur Sicherung der Codequalität und Einhaltung der Programmierrichtlinien setzen Sie in Ihren Projekten ein? Ich freue mich auf Ihre Kommentare.


SHARE



Schreiben Sie einen Kommentar

Bitte füllen Sie alle mit * gekennzeichneten Felder aus. Ihre E-Mail Adresse wird nicht veröffentlicht.