Inhaltsverzeichnis
Grundprinzipien von Clean ABAP
Die Grundprinzipien von Clean ABAP orientieren sich an den Clean-Code-Ideen und verfolgen das Ziel, ABAP-Programme leichter verständlich, wartbarer und nachhaltiger zu gestalten.
Im Mittelpunkt steht die Lesbarkeit: Code sollte so geschrieben werden, dass er ohne zusätzliche Erklärungen nachvollziehbar ist. Dazu gehören aussagekräftige Namen für Variablen, Methoden und Klassen, kurze und klar strukturierte Methoden sowie der Verzicht auf unnötige Komplexität oder Verschachtelung.
Wiederholter Code wird konsolidiert, um Redundanzen zu vermeiden und Fehlerquellen zu reduzieren.
Moderne ABAP-Syntax und Best Practices – wie Inline-Deklarationen, Expressions und saubere Fehlerbehandlung über Exceptions – unterstützen eine zeitgemäße und effiziente Entwicklung.
Insgesamt helfen die Clean-ABAP-Prinzipien dabei, langlebigen, klaren und leicht erweiterbaren Code zu schreiben, der in Projekten langfristig Zeit und Kosten spart.
Die konsequente Umsetzung dieser Prinzipien im Entwicklungsalltag kann jedoch zeitaufwendig sein. Genau hier setzt ABAP Cleaner an: Das Tool unterstützt Entwickler dabei, Clean-ABAP-Regeln automatisiert und konsistent auf bestehenden und neuen Code anzuwenden.
Wie ABAP Cleaner verwendet wird
Automatische oder interaktive Bereinigung aus ADT
Bei der Verwendung von ABAP Cleaner aus den ABAP Development Tools (ADT) kann die Bereinigung wie folgt durchgeführt werden:
- Automatisch mit einem einzigen Tastendruck (Clean Up With Automated ABAP Cleaner“).
- Interaktiv, indem die ABAP-Cleaner-Benutzeroberfläche geöffnet wird (Clean Up With Interactive ABAP Cleaner…“).
Diese Ansicht ermöglicht es Ihnen, alle Änderungen zu prüfen, unerwünschte Änderungen mit einem Mausklick rückgängig zu machen und das Ergebnis schließlich zu übernehmen oder zu verwerfen.
- Dritte Option: Nur-Lesen-Vorschau
Zeigt eine schreibgeschützte Vorschau des Bereinigungsergebnisses, ohne den Code zu sperren oder zu ändern – nützlich z. B. wenn Sie im aktuellen System keine Entwicklungsberechtigung haben. (Ctrl + Shift + 5 oder Menü „Source Code / Show Read-Only Preview With ABAP Cleaner…“).
Integration von ABAP Cleaner in ABAP Development Tools (ADT)
ABAP Cleaner ist vollständig in ADT integriert und kann direkt während der Entwicklung genutzt werden.
Regelkonfiguration
ABAP Cleaner bietet umfangreiche Konfigurationsmöglichkeiten, um projektspezifische Coding-Standards umzusetzen. Dazu zählen unter anderem Regeln für
- Keyword-Schreibweise
- Einrückungsregeln
- Leerzeilen und Blöcke
- Alignment-Regeln
- Naming-Conventions
- Syntax-Modernisierung
- Clean-ABAP-Regeln
Unternehmen können eigene Coding-Guidelines als Konfigurationsprofil hinterlegen.
Beispiel: Vorher & Nachher
Vorher
LOOP AT lt_data INTO DATA(ls_row).IF ls_row-flag = ‚X‘.sum = sum + ls_row-value.ENDIF.ENDLOOP.
Nachher
LOOP AT lt_data INTO DATA(ls_row).
IF ls_row-flag = ‚X‘.
sum += ls_row-value.
ENDIF.
ENDLOOP.
Erklärung des Programmablaufs:
Das Programm durchläuft eine interne Tabelle lt_data zeilenweise. Für jede Zeile wird geprüft, ob das Feld flag den Wert ‚X‘ hat. Ist diese Bedingung erfüllt, wird der Wert aus dem Feld value zur Variablen sum addiert. Am Ende der Schleife enthält sum die aufsummierten Werte aller Datensätze, die die Bedingung erfüllen.
Im Beispiel wird derselbe Programmablauf einmal in unübersichtlicher und einmal in bereinigter Form dargestellt. ABAP Cleaner trennt die Anweisungen in logisch strukturierte Zeilen, sorgt für eine einheitliche Einrückung und verwendet moderne ABAP-Syntax. Dadurch wird der Code deutlich besser lesbar, leichter wartbar und entspricht den Clean-ABAP-Richtlinien.
Fazit
ABAP Cleaner unterstützt Entwickler effektiv bei der Einhaltung von Clean-ABAP-Standards. Durch die automatisierte Bereinigung und einheitliche Formatierung wird die Codequalität erhöht und eine moderne, gut lesbare ABAP-Entwicklung gefördert. Der Einsatz des Tools trägt dazu bei, Wartungsaufwand zu reduzieren und langfristig stabile Softwarelösungen zu schaffen.
