Skip to content

Technik Blog

Programmieren | Arduino | ESP32 | MicroPython | Python | Raspberry Pi | Raspberry Pi Pico

Menu
  • Smarthome
  • Gartenautomation
  • Arduino
  • ESP32 & Co.
  • Raspberry Pi & Pico
  • Solo Mining
  • Deutsch
  • English
Menu

Apache Groovy #12 – Code Analyse mit Groovy-Lint

Posted on 12. Oktober 20223. Mai 2023 by Stefan Draeger

In diesem Beitrag möchte ich dir zeigen, wie du Groovy-Lint einrichtest, um die Codequalität deiner Groovy-Projekte zu tracken und im besten Fall sogar zu erhöhen.

Apache Groovy #12 - Code Analyse mit Groovy-Lint
Apache Groovy #12 – Code Analyse mit Groovy-Lint

Die offizielle Dokumentation zu Groovy-Lint findest du unter https://github.com/nvuillam/npm-groovy-lint.

  • Warum sollte ich die Codequalität analysieren?
    • Ein kleines Groovy Projekt
  • Wie richte ich Groovy-Lint ein?
  • Ausführen von Groovy-Lint
    • eine Groovy Datei prüfen
    • ein Verzeichnis / Package prüfen
  • Ein Report erzeugen

Warum sollte ich die Codequalität analysieren?

Fehler können passieren und jeder Entwickler macht Fehler, aber manchmal schleichen sich Fehler ein, welche man nicht sofort sieht oder nur in einer bestimmten Konstellation auftreten können.

Mit einer Code-Analyse können einige solcher Fehler automatisch gefunden werden. Die Analyse wird meist anhand von bestehenden Rules durchgeführt, welche sich jedoch konfigurieren lassen.

Das Ergebnis einer Code-Analyse kann zu weiteren Schritten im Softwareprojekt führen, zbsp. die Einführung eines Patterns, erweitern einer Definition of Done etc.

Wenn sehr früh im Projekt mit einer automatischen Analyse begonnen wird, wirkt sich dieses positiv auf die Entwicklung des Codes aus, denn diese kleinen Fehler hinterher zu fixen fehlt meistens die Zeit oder der Kunde sieht dieses als weniger schwierig an und möchte eher seine Requirements umgesetzt haben.

Ein kleines Groovy Projekt

Im Nachfolgenden benötigen wir ein kleines Groovy-Projekt, hier möchte ich dir ein einfaches Eclipse-Projekt zum Download anbieten.

kleines Groovy-Projekt für Groovy-LintHerunterladen

Ich beziehe mich bei den Beispielen auf dieses Projekt, wenn du dieses nicht verwenden möchtest, dann musst du die Befehle für dein Projekt anpassen.

Wie richte ich Groovy-Lint ein?

Damit wir dieses kleine Kommandozeilentool ausführen können, benötigen wir Node.JS welches wir kostenfrei unter https://nodejs.org/en/ herunterladen können (während der Installation werden Administrationsrechte benötigt).

Wenn Node.JS installiert wurde, wurde zusätzlich der Package Manager NPM mitinstalliert, über welchen wir nun groovy-lint auf der Kommandozeile mit dem nachfolgenden Befehl installieren.

npm install -g npm-groovy-lint

Ausführen von Groovy-Lint

Wenn alles erfolgreich installiert wurde, können wir unser Groovy-Projekt mit Groovy-Lint prüfen. Dabei können wir entweder nur einzelne Dateien prüfen oder auch ganze Verzeichnisse / Packages.

eine Groovy Datei prüfen

Mit dem Befehl „npm-groovy-lint /pfad/zur/Datei.groovy“ können wir eine einzelne Datei prüfen. Nach der Prüfung wird das Ergebnis in der Kommandozeile ausgegeben und wir können daraus To-do ableiten.

In meinem Fall wurden an der Klasse „Greetings.groovy“ 8 Auffälligkeiten in 2 Schwierigkeitsgraden gefunden.

Das Tool stellt zusätzlich auf der Kommandozeile dar, was gemacht werden muss, um diese vermeintlichen Fehler zu beheben.

┌─────────┬───────────┬─────────────┐
│ (index) │ Severity  │ Total found │
├─────────┼───────────┼─────────────┤
│    0    │  'Error'  │      0      │
│    1    │ 'Warning' │      1      │
│    2    │  'Info'   │      7      │
└─────────┴───────────┴─────────────┘

In meinem Fall musste ich in der IDE den Formatter anpassen, JavaDoc hinzufügen und den AccessModifier „public“ an der Methode „sayHello“ entfernen.

package de.draegerit.samplehelloword

import groovy.transform.CompileStatic

/**
 * Klasse zum ausgeben einer Begrüßung auf der Kommandozeile.
 *
 * @author Stefan Draeger
 */
@CompileStatic
class Greeting {

    /**
     * Methode erzeugt eine Ausgabe auf der Kommandozeile
     * im Format "Hello" gefolgt von den Parametern.
     * @param firstname - Vorname
     * @param lastname - Nachname
     */
    void sayHello(String firstname, String lastname) {
        println("Hello $firstname $lastname")
    }

}
npm-groovy-lint results in 1 linted files:
┌─────────┬───────────┬─────────────┐
│ (index) │ Severity  │ Total found │
├─────────┼───────────┼─────────────┤
│    0    │  'Error'  │      0      │
│    1    │ 'Warning' │      0      │
│    2    │  'Info'   │      0      │
└─────────┴───────────┴─────────────┘

C:\Tools\Workspaces\SampleHelloWorldProject\src\de\draegerit\samplehelloword>

ein Verzeichnis / Package prüfen

Wenn wir ein ganzes Verzeichnis oder ein Package prüfen wollen, dann lassen wir am Befehl einfach den Dateinamen am Ende weg.

npm-groovy-lint /pfad/zum/Vezeichnis
--oder für das aktuelle Verzeichnis einfach nur
npm-groovy-lint 

Ein Report erzeugen

Wenn man ein ganzes Projekt prüft, nutzt die Ausgabe in der Konsole recht wenig bzw. ist sehr unübersichtlich, hier gibt es die Möglichkeit, die Ausgabe in eine Datei umzuleiten.

Auf der Konsole kann man dieses in der Regel einfach mit einem „> dateiname.txt“ machen, jedoch werden hier noch zusätzliche Zeichen eingefügt, welches auf ein fehlerhaftes Encoding zurückzuführen ist.

Das Tool bietet die Möglichkeit Reports in den Formaten TXT, HTML, sowie JSON zu erzeugen. Der TXT Report ist einfach nur die Ausgabe, welche auch in der Konsole ausgegeben wird in einer Datei.

Ich bevorzuge jedoch den HTML Report, dieser ist dynamisch und farbig aufgebaut und dadurch deutlich lesbarer als der Text-Report.

C:\Tools\Workspaces\SampleHelloWorldProject>npm-groovy-lint --output "report.html"
GroovyLint: Successfully processed CodeNarc:
CodeNarc completed: (p1=0; p2=0; p3=1) 114ms


C:\Tools\Workspaces\SampleHelloWorldProject>

Der Report wird dann in dem Verzeichnis abgelegt, in welchem der Befehl ausgeführt wurde. Im Browser wird dann pro Datei mit Auffälligkeiten eine Tabelle angelegt. Wurde für eine Datei nichts gefunden, wird diese auch nicht aufgeführt!

Beispielreport von Groovy-Lint mit CodeNarc
Beispielreport von Groovy-Lint mit CodeNarc

Am Ende der HTML Seite werden zusätzlich die Rules aufgeführt, gegen welche der Code geprüft wird.

Schreibe einen Kommentar Antworten abbrechen

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert

Fragen oder Feedback?

Du hast eine Idee, brauchst Hilfe oder möchtest Feedback loswerden?
Support-Ticket erstellen

Newsletter abonnieren

Bleib auf dem Laufenden: Erhalte regelmäßig Updates zu neuen Projekten, Tutorials und Tipps rund um Arduino, ESP32 und mehr – direkt in dein Postfach.

Jetzt Newsletter abonnieren

Unterstütze meinen Blog

Wenn dir meine Inhalte gefallen, freue ich mich über deine Unterstützung auf Tipeee.
So hilfst du mit, den Blog am Leben zu halten und neue Beiträge zu ermöglichen.

draeger-it.blog auf Tipeee unterstützen

Vielen Dank für deinen Support!
– Stefan Draeger

Kategorien

Tools

  • Unix-Zeitstempel-Rechner
  • ASCII Tabelle
  • Spannung, Strom, Widerstand und Leistung berechnen
  • Widerstandsrechner
  • 8×8 LED Matrix Tool
  • 8×16 LED Matrix Modul von Keyestudio
  • 16×16 LED Matrix – Generator

Links

Blogverzeichnis Bloggerei.de TopBlogs.de das Original - Blogverzeichnis | Blog Top Liste Blogverzeichnis trusted-blogs.com

Stefan Draeger
Königsberger Str. 13
38364 Schöningen
Tel.: 01778501273
E-Mail: info@draeger-it.blog

Folge mir auf

link zu Fabook
link zu LinkedIn
link zu YouTube
link zu TikTok
link zu Pinterest
link zu Instagram
  • Impressum
  • Datenschutzerklärung
  • Disclaimer
  • Cookie-Richtlinie (EU)
©2025 Technik Blog | Built using WordPress and Responsive Blogily theme by Superb
Cookie-Zustimmung verwalten
Wir verwenden Technologien wie Cookies, um Geräteinformationen zu speichern und/oder darauf zuzugreifen. Wir tun dies, um das Surferlebnis zu verbessern und um personalisierte Werbung anzuzeigen. Wenn Sie diesen Technologien zustimmen, können wir Daten wie das Surfverhalten oder eindeutige IDs auf dieser Website verarbeiten. Wenn Sie Ihre Zustimmung nicht erteilen oder zurückziehen, können bestimmte Funktionen beeinträchtigt werden.
Funktional Immer aktiv
Die technische Speicherung oder der Zugang ist unbedingt erforderlich für den rechtmäßigen Zweck, die Nutzung eines bestimmten Dienstes zu ermöglichen, der vom Teilnehmer oder Nutzer ausdrücklich gewünscht wird, oder für den alleinigen Zweck, die Übertragung einer Nachricht über ein elektronisches Kommunikationsnetz durchzuführen.
Vorlieben
Die technische Speicherung oder der Zugriff ist für den rechtmäßigen Zweck der Speicherung von Präferenzen erforderlich, die nicht vom Abonnenten oder Benutzer angefordert wurden.
Statistiken
Die technische Speicherung oder der Zugriff, der ausschließlich zu statistischen Zwecken erfolgt. Die technische Speicherung oder der Zugriff, der ausschließlich zu anonymen statistischen Zwecken verwendet wird. Ohne eine Vorladung, die freiwillige Zustimmung deines Internetdienstanbieters oder zusätzliche Aufzeichnungen von Dritten können die zu diesem Zweck gespeicherten oder abgerufenen Informationen allein in der Regel nicht dazu verwendet werden, dich zu identifizieren.
Marketing
Die technische Speicherung oder der Zugriff ist erforderlich, um Nutzerprofile zu erstellen, um Werbung zu versenden oder um den Nutzer auf einer Website oder über mehrere Websites hinweg zu ähnlichen Marketingzwecken zu verfolgen.
Optionen verwalten Dienste verwalten Verwalten von {vendor_count}-Lieferanten Lese mehr über diese Zwecke
Einstellungen anzeigen
{title} {title} {title}