{"id":683097,"date":"2026-02-23T01:53:31","date_gmt":"2026-02-23T00:53:31","guid":{"rendered":"https:\/\/blog.jetbrains.com\/?post_type=platform&p=683097"},"modified":"2026-02-23T01:53:35","modified_gmt":"2026-02-23T00:53:35","slug":"qodana-erweitern-benutzerdefinierte-codeinspektionen-erstellen","status":"publish","type":"platform","link":"https:\/\/blog.jetbrains.com\/de\/platform\/2026\/02\/qodana-erweitern-benutzerdefinierte-codeinspektionen-erstellen\/","title":{"rendered":"Qodana erweitern: Benutzerdefinierte Codeinspektionen erstellen"},"content":{"rendered":"

Qodana ist ein statisches Codeanalyse-Tool, das Codeinspektionen<\/a> und Quick-Fixes aus JetBrains-IDEs in Continuous-Integration-Systeme einbindet. Es kann in der Cloud<\/a> oder in einem Docker-Container<\/a> ausgef\u00fchrt, in CI\/CD-Pipelines integriert<\/a> oder in einer JetBrains-IDE aufgerufen werden.<\/p>\n

Qodana bringt von Haus aus eine beeindruckende Reihe von Inspektionen mit, ist jedoch nicht auf diese beschr\u00e4nkt. Sie k\u00f6nnen selbst definierte Inspektionen hinzuf\u00fcgen, um projektspezifische Anforderungen und Konventionen durchzusetzen.<\/p>\n

Nehmen wir zum Beispiel an, Sie haben ein Projekt mit folgender Codekonvention:<\/p>\n

\n

Jede Kotlin-Klasse in einem service<\/code> <\/mark>-Paket muss auf Service<\/code> enden.<\/p>\n<\/blockquote>\n

com.jetbrains.service.JetComponent<\/code> w\u00fcrde nicht dieser Konvention entsprechen, com.jetbrains.service.BrainComponentService<\/code> hingegen schon. Im Folgenden erstellen wir ein Plugin, das diese Inspektion implementiert, sodass Qodana diese Konvention in zuk\u00fcnftigen Projekten durchsetzen kann.<\/p>\n

Wir k\u00f6nnen diese Codekonvention implementieren, indem wir eine benutzerdefinierte Codeinspektion<\/strong> erstellen, die in einem Plugin<\/strong> bereitgestellt wird. Qodana-Plugins werden \u00e4hnlich wie JetBrains-IDE-Plugins entwickelt, das hei\u00dft, wir m\u00fcssen einfach ein IntelliJ-Plattform-Plugin erstellen, das in Qodana ausgef\u00fchrt werden kann. Hier ist ein kurzer \u00dcberblick \u00fcber die Schritte, die wir durchf\u00fchren werden:<\/p>\n

    \n
  1. Projekt aus dem IntelliJ Platform Plugin Template<\/a> initialisieren.<\/li>\n
  2. Die Projekteigenschaften und die Plugin-Beschreibung anpassen, zusammen mit den ben\u00f6tigten Abh\u00e4ngigkeiten.<\/li>\n
  3. Die lokale Inspektion in der Plugin-Beschreibung deklarieren und in Kotlin implementieren.<\/li>\n
  4. Das Plugin kompilieren und ein Paket erstellen.<\/li>\n
  5. Im Beispielprojekt das Plugin-Artefakt in ein geeignetes Verzeichnis kopieren.<\/li>\n
  6. Die Qodana-Konfigurationsdatei anpassen.<\/li>\n
  7. Qodana starten und den Bericht \u00fcberpr\u00fcfen.<\/li>\n<\/ol>\n

    Plugin-Projekt vorbereiten<\/h2>\n

    Um das Projekt zu starten, besuchen Sie das Repository IntelliJ Platform Plugin Template<\/a> und klicken Sie auf die Schaltfl\u00e4che Use this template<\/em>, um ein Plugin-Repository zu erstellen. Geben Sie als Namen classname-inspection-qodana-plugin<\/code> ein, kopieren Sie die Projekt-URL und \u00f6ffnen Sie sie in IntelliJ IDEA. Wenn das Projekt einsatzbereit ist, passen Sie die Datei gradle.properties<\/code> an, indem Sie pluginGroup<\/code>, pluginName<\/code> und pluginRepositoryUrl<\/code> entsprechend deklarieren. Vergessen Sie nicht, auf die schwebende Schaltfl\u00e4che Sync Gradle Changes<\/em> zu klicken, um die \u00c4nderungen zu \u00fcbernehmen. Um den eindeutigen Plugin-Bezeichner<\/a> zu \u00e4ndern, modifizieren Sie den Eintrag id<\/code> in der Plugin-Beschreibungsdatei plugin.xml<\/code>.<\/p>\n

    Abh\u00e4ngigkeiten deklarieren<\/h3>\n

    Unsere Codeinspektion gilt f\u00fcr Kotlin-Klassen, daher m\u00fcssen wir das Kotlin-Plugin zu den Abh\u00e4ngigkeiten des Qodana-Plugins hinzuf\u00fcgen. In der Datei gradle.properties<\/code> m\u00fcssen Sie Folgendes deklarieren:<\/p>\n

    platformBundledPlugins = org.jetbrains.kotlin<\/pre>\n
    Dar\u00fcber hinaus muss in den Abh\u00e4ngigkeiten der Plugin-Beschreibungsdatei plugin.xml<\/code> dasselbe geb\u00fcndelte Kotlin-Plugin enthalten sein:<\/p>\n
    org.jetbrains.kotlin<\/pre>\n
    Achten Sie wieder darauf, die Gradle-\u00c4nderungen zu synchronisieren, indem Sie auf die schwebende Schaltfl\u00e4che klicken.<\/p>\n
    Dar\u00fcber hinaus muss die Kotlin-Klasseninspektion den Kotlin-Compiler K2 unterst\u00fctzen, der seit Version 2025.1 der IntelliJ-Plattform standardm\u00e4\u00dfig aktiviert ist. Deklarieren Sie in der Plugin-Beschreibungsdatei die Erweiterung org.jetbrains.kotlin.supportsKotlinPluginMode<\/code>.<\/p>\n
        \n<\/pre>\n
    Codeinspektion erstellen<\/h3>\n
    Der tats\u00e4chliche Code f\u00fcr jede Codeinspektion f\u00fcr Kotlin-Klassen erfordert drei Schritte:<\/p>\n
      \n
    1. Eine com.intellij.localInspection<\/code>-Erweiterung in der Plugin-Beschreibungsdatei deklarieren, zusammen mit den ben\u00f6tigten Attributen und einem vollst\u00e4ndig qualifizierten Verweis auf die Implementierungsklasse.<\/li>\n
    2. Eine Implementierungsklasse erstellen \u2013 vorzugsweise in Kotlin.<\/li>\n
    3. Eine separate HTML-Datei mit einer Beschreibung der Inspektion, der Nutzungsanleitung und einem Beispiel anlegen.<\/li>\n<\/ol>\n
      Erweiterung deklarieren<\/h4>\n
      Tragen Sie die folgende Deklaration in die Plugin-Beschreibungsdatei plugin.xml<\/code> ein:<\/p>\n
          \n<\/pre>\n
      Das Attribut language<\/code> gibt an, dass die Inspektion f\u00fcr Kotlin-Quellcodedateien gilt. Es ist wichtig, die Inspektion explizit als standardm\u00e4\u00dfig aktiviert zu deklarieren, da Qodana sie andernfalls nicht ausf\u00fchrt. Geben Sie anschlie\u00dfend einen leicht lesbaren, aussagekr\u00e4ftigen Anzeigenamen unter displayName<\/code> ein, der im Bericht und in den Einstellungen angezeigt werden soll. Das Attribut groupName<\/code> legt die Inspektionskategorie fest, die sowohl im Qodana-Bericht als auch in den IDE-Einstellungen angezeigt wird. Geben Sie schlie\u00dflich einen vollst\u00e4ndig qualifizierten Namen f\u00fcr die Implementierungsklasse ein.<\/p>\n
      Quellcode der Codeinspektion<\/h4>\n
      Das Kotlin-Plugin stellt eine n\u00fctzliche Basis-Inspektionsklasse f\u00fcr Kotlin-Inspektionen bereit: AbstractKotlinInspection<\/code>. \u00dcberschreiben Sie die Methode buildVisitor<\/code> und stellen Sie eine PSI-Visitor-Instanz bereit, die die Kotlin-Klassenelemente auf typsichere Weise durchl\u00e4uft. classVisitor<\/code> ist eine praktische DSL-\u00e4hnliche Funktion, die den ben\u00f6tigten PSI-Visitor zur\u00fcckgibt und f\u00fcr jede Kotlin-Klasse im analysierten Projekt aufgerufen wird.<\/p>\n
      package org.intellij.sdk.codeInspection\n\nimport com.intellij.codeInspection.ProblemHighlightType\nimport com.intellij.codeInspection.ProblemsHolder\nimport com.intellij.psi.PsiElementVisitor\nimport org.jetbrains.kotlin.idea.codeinsight.api.classic.inspections.AbstractKotlinInspection\nimport org.jetbrains.kotlin.psi.KtClass\nimport org.jetbrains.kotlin.psi.KtVisitorVoid\nimport org.jetbrains.kotlin.psi.classVisitor\n\nclass ServicePackageClassNameInspection : AbstractKotlinInspection() {\n    override fun buildVisitor(holder: ProblemsHolder, isOnTheFly: Boolean) = classVisitor { klass ->\n        val classNamePsi = klass.nameIdentifier ?: return@classVisitor\n        val classFqn = klass.fqName?.asString() ?: return@classVisitor\n        if (klass.packageLastComponent == \"service\" && !classFqn.endsWith(\"Service\")) {\n            holder.registerProblem(\n                classNamePsi,\n                \"Class name in the 'service' package must have a 'Service' suffix\"\n            )\n        }\n    }\n\n    private val KtClass.packageLastComponent: String\n        get() = containingKtFile.packageFqName.shortName().asString()\n}<\/pre>\n
      Die Visitor-Unterklasse extrahiert den vollst\u00e4ndig qualifizierten Kotlin-Klassennamen, untersucht das \u00e4u\u00dferste rechte Paketelement und pr\u00fcft dieses auf das entsprechende Suffix. Unzul\u00e4ssige Klassennamen werden an die ProblemsHolder<\/code>-Instanz gemeldet, eingeschlossen in eine PSI-Elementklasse und mit einer f\u00fcr Menschen lesbaren Problembeschreibung.<\/p>\n
      Inspektionsbeschreibung<\/h4>\n
      F\u00fcr jede lokale Inspektion muss eine Beschreibungsdatei im HTML-Format bereitgestellt werden. Wenn Sie den Quick-Fix Create description file ServicePackageClassNameInspection.html<\/em> anwenden, wird im richtigen Verzeichnis eine Datei mit dem Namen src\/main\/resources\/inspectionDescriptions\/ServicePackageClassName.html<\/code> angelegt. Sie m\u00fcssen auch eine Beschreibung bereitstellen, die im Qodana-Bericht und in den IDE-Einstellungen angezeigt wird.<\/p>\n
      Reports class names in the service<\/code> packages that lack the Service<\/code> suffix. Example:<\/b><\/pre>\n
      \n  package com.example.foo.service\n  class SomeComponent {\n    \/* class members *\/\n  }<\/pre>\n
      Plugin kompilieren<\/h2>\n
      Jetzt ist alles vorbereitet \u2013 wir k\u00f6nnen die Kompilierung starten! F\u00fchren Sie den Gradle-Task buildPlugin<\/code> aus und \u00fcberpr\u00fcfen Sie das Artefakt build\/distributions\/qodana-code-inspection-0.0.1.zip<\/code>, das im Gradle-Ausgabeverzeichnis bereitgestellt wird. Die JAR-Datei wird als Hauptartefakt im Qodana-Scan verwendet.<\/p>\n
      Typ des Plugin-Artefakts beachten<\/h4>\n
      Qodana unterst\u00fctzt keine lokalen ZIP-Plugin-Artefakte, die zus\u00e4tzliche JAR-Archive oder Drittanbieter-Abh\u00e4ngigkeiten enthalten. Jedes Plugin muss als einzelne JAR-Datei vorliegen oder in ein bestimmtes Verzeichnis entpackt werden.<\/p>\n
      Playground-Projekt mit Qodana pr\u00fcfen<\/h2>\n
      Nachdem wir nun Qodana mit unserem Plugin erweitert haben, erstellen wir ein Playground-Projekt in Kotlin, das wir mit Qodana analysieren k\u00f6nnen. Um das Qodana-Plugin lokal auszuf\u00fchren, stellen Sie sicher, dass zwei Softwarekomponenten auf Ihrem System verf\u00fcgbar sind:<\/p>\n