Detekt für Kotlin: Vollständiges Handbuch mit Beispielen

1. Was ist Detekt und warum wird es benötigt?

Detekt ist ein leistungsstarkes Tool zur statischen Codeanalyse für die Programmiersprache Kotlin, entwickelt von Arturbosch und unterstützt von der Community. Es dient der automatischen Erkennung potenzieller Probleme, sogenannter "Code Smells", Verstößen gegen Styleguides und Sicherheitslücken in Kotlin-Projekten. Detekt arbeitet auf der Ebene des abstrakten Syntaxbaums (AST), wodurch es Code tiefergehend analysieren kann als einfache textbasierte Linter. Das Tool lässt sich nahtlos in Build-Systeme wie Gradle und Maven sowie in CI/CD-Pipelines integrieren, was es für die Sicherstellung der Codequalität in der Teamarbeit unverzichtbar macht.

Warum ist Detekt wichtig? Erstens automatisiert es die Überprüfung des Codes auf Einhaltung der Kotlin Coding Conventions – besonders wertvoll in großen Projekten mit mehreren Entwicklern. Zweitens hilft Detekt, potenzielle Fehler frühzeitig zu erkennen: zum Beispiel ungenutzte Variablen, mögliche NullPointerException, komplexe Bedingungen und andere Probleme, die zu Laufzeitfehlern führen können. Drittens fördert das Tool die Refaktorisierung: Es hebt Codeabschnitte mit hoher zyklomatischer Komplexität, lange Funktionen, überflüssige Elvis-Operatoren und andere Muster hervor, die die Lesbarkeit und Wartbarkeit des Codes beeinträchtigen.

Detekt bietet über 150 integrierte Regeln, die in Kategorien unterteilt sind: potenzielle Fehler (potential bugs), Codestil (style), Leistung (performance), Komplexität (complexity), Ausnahmen (exceptions) und mehr. Das Tool ist vollständig konfigurierbar: Sie können einzelne Regeln aktivieren/deaktivieren, deren Schwellenwerte anpassen und sogar eigene Regeln in Kotlin schreiben. Detekt unterstützt die Generierung von Berichten in den Formaten HTML, XML, SARIF und Text, sodass es sich in jedes Codeanalyse-System integrieren lässt.

2. Installation

Detekt wird als Plugin für das Build-System Gradle (empfohlen) oder als eigenständiges CLI-Tool installiert. Nachfolgend finden Sie die genauen Installationsbefehle.

Installation über Gradle (Plugin)

Fügen Sie in Ihre Datei build.gradle.kts (oder build.gradle) Folgendes ein:

// build.gradle.kts
plugins {
    id("io.gitlab.arturbosch.detekt") version "1.23.6" // aktuelle Version zum Zeitpunkt der Erstellung
}

// Detekt-Konfiguration (optional)
detekt {
    buildUponDefaultConfig = true // Standardregeln + eigene verwenden
    allRules = false // nicht alle Regeln aktivieren (nur empfohlene)
    config.setFrom("$projectDir/config/detekt/detekt.yml") // Pfad zur Konfiguration
    baseline = file("$projectDir/config/detekt/baseline.xml") // Baseline zum Ignorieren von Fehlern
    reports {
        html.required.set(true) // HTML-Bericht generieren
        xml.required.set(true) // XML-Bericht generieren
        txt.required.set(true) // Textbericht generieren
    }
}

Nach dem Hinzufügen des Plugins führen Sie folgenden Befehl aus:

./gradlew detekt

Installation über CLI (Homebrew für macOS/Linux)

brew install detekt

Installation über SDKMAN

sdk install detekt

Installation über JAR (universelle Methode)

curl -sSLO https://github.com/detekt/detekt/releases/download/v1.23.6/detekt-cli-1.23.6-all.jar
alias detekt='java -jar detekt-cli-1.23.6-all.jar'

3. Schnellstart – Minimales Arbeitsbeispiel

Erstellen Sie eine einfache Kotlin-Datei src/main/kotlin/example.kt:

// example.kt
fun main() {
    val x = 1
    val y = 2
    if (x > 0) {
        println("Positive")
    } else {
        println("Non-positive")
    }
    println("Sum: ${x + y}")
}

Erstellen Sie eine Konfigurationsdatei config/