Bereits in den 1980er Jahren wurden die ersten Zeilen ABAP Code geschrieben. Seither hat sich ABAP stetig weiterentwickelt und die Art und Weise, ABAP Code zu schreiben, hat sich ebenso mitentwickelt. Der „Pretty Printer“ gehört lange schon zum guten Ton der ABAP-Entwicklung. Auch dieses Tool stößt aber mittlerweile bei SELECT-Statements, modernen Methodenaufrufen oder neuer ABAP-Syntax an seine Grenzen.
Durch eine große Auswahl an neuer Syntax, welche teilweise zu sehr langen und verschachtelten Statements führen kann, gibt es zahlreiche Wege neuen Code zu formatieren. Um ABAP-Code wieder zu vereinheitlichen und Best Practices zu schaffen wurde „Clean ABAP“ ins Leben gerufen.
Das Eclipse Plugin „ABAP Cleaner“ ermöglicht bereits bei der Entwicklung etwaige Abweichungen des Programmcodes zu den Clean ABAP-Regeln zu erkennen und diese per Knopfdruck zu optimieren bzw. zu formatieren.
Besonderheiten
Formatierung: Besonders mit neuer Syntax stößt man mit dem Pretty Printer an seine Grenzen. Code wird nicht mehr (richtig) formatiert. Um einen einheitlichen Look aller Entwicklungen zu gewährleisten, empfiehlt es sich den ABAP Cleaner zu verwenden.
Quellcode Optimierung: Alte, unnötig komplexe oder leistungsintensive Syntax werden durch neue optimierte Syntax ersetzt.
Installation
Die Installation ist denkbar einfach. Das Plugin kann wie auch die ADT-Tools in Eclipse über „Help > Install New Software…“ installiert werden. Dazu folgende Update-Site verwenden: https://sap.github.io/abap-cleaner/updatesite
Verwendung
Das Tool kann auf zwei Arten verwendet werden.
Der „Automated“-Mode formatiert und bereinigt den Code automatisch ohne weiteres Zutun (zu vergleichen mit dem Pretty Printer). (Strg + 4)
Der „Interactive“-Mode erlaubt es die Codeanpassungen vor der Änderung zu begutachten und diese abzulehnen oder zu akzeptieren. (Strg + Shift + 4)
Interactive Mode
Anbei ein Beispiel für die Verwendung des Interactive-Modes. Links der Quellcode ohne Anpassungen, in dem alle Änderungsvorschläge gelb und rot markiert werden. Rechts der angepasste Quellcode, in dem alle Anpassungen gelb und grün markiert werden.
Konfiguration
Um eine firmen- oder teamweite einheitliche Formatierung zu ermöglichen, können bestimmte Clean Code Regeln übernommen oder abgeschaltet werden (links im Bild). Dadurch kann ein Standard erarbeitet werden, der von jedem Teammitglied importiert und genutzt werden kann.
