Enterprise Project Startup Kit

Dieses Artefakt enthält eine Anleitung zum Einrichten der persönlichen Arbeitsumgebung. Neben der Beschreibung einiger grundlegender Konfigurationen wird hier auch die Basis für eine optimale und flüssige Zusammenarbeit im Entwicklungsteam geebnet - durch die Verwendung der selben IDE-Einstellungen und Formatter.

Die IDE-Einstellungen und Formatter sind abgestimmt auf die Checkstyle- und PMD-Regeln, die bei Verwendung des Enterprise Starters in den Build-Prozess integriert werden.

Inhalt:

• Git
• IDE-Formatter
  • Eclipse / Spring Tool Suite (STS)
  • IntelliJ
• Maven-Settings
• Lombok

Git

Bei Git sollte der User und die Email-Adresse gesetzt sein, damit nachvollziehbar ist, wer welche Commits getätigt hat.

git config --global user.name "John Doe"
git config --global user.email johndoe@example.com

Folgende Konfiguration ist sinnvoll, damit seitens des Git-Clients keine Änderungen an den Zeilenumbrüchen vorgenommen werden:

git config --global core.autocrlf false

IDE-Formatter

Für ein angenehmes gemeinsames Entwickeln sollten alle Entwickler die gleichen Einstellungen für die Code-Formatierung verwenden.

Eclipse / Spring Tool Suite (STS)

Im Ordner ide-config\eclipse sind Formatter- sowie Cleanup-Vorlagen zu finden, die direkt importiert werden können. Für Save Actions gibt es einen Screenshot, der eine auf die Code-Analyse-Tools abgestimmte Konfiguration zeigt.

Am Beispiel Java hier eine Anleitung:

• Formatter: Preferences -> Java -> Code Style -> Formatter dort dann über Import... die entsprechende Datei auswählen.
• Cleanup: Preferences -> Java -> Code Style -> Clean Up dort dann über Import... die entsprechende Datei auswählen.
• Save Actions: Preferences -> Java -> Editor -> Save Actions dort gibt es keine Import/Export-Möglichkeit, daher muss hier manuell die Konfiguration entsprechend dem Screenshot angepasst werden.

IntelliJ

IntelliJ bietet ähnlich zu Eclipse eine Import/Export-Funktion für Formatter u.Ä., welche über die Settings erreichbar ist. Die Settings werden mit Ctrl+Alt+S aufgerufen.

• Formatter: Import über Editor -> Code Style -> Java, dort Scheme -> Import Scheme -> IntelliJ Idea code style XML. Die Vorlage für den IntelliJ-Formatter befindet sich im Ordner src\main\resources\intellij.
• Save Actions: IntelliJ verfügt nicht über Save-Actions, da InteliJ Auto-Save benutzt. Es gibt ein Plugin dafür.

Für den Fall, dass ein anderer als der oben referenzierte Eclipse-Formatter genutzt werden soll, findet sich hier eine Anleitung, wie ein IntelliJ-Formatter aus einem Eclipse-Formatter erzeugt werden kann.

Maven-Settings

Die angepassten Maven-Settings müssen aus dem Ordner maven in den Ordner ~/.m2 kopiert werden. Dadurch wird zum Beispiel ein spezieller Nexus für Maven konfiguriert.

Lombok

Zum Verwenden von Lombok muss die IDE entsprechend eingerichtet werden, eine Anleitung dazu findet sich hier.

Lombok ist ein sehr hilfreiches Tool zum Vermeiden von Boilerplate Code. Es bietet Möglichkeiten wie sehr einfache automatische Generation von Gettern, Settern, Konstruktoren, ToString-Methoden und vieles mehr, einfach durch Anbringen von Annotationen im Quellcode.

In jedem Projekt, in dem Lombok genutzt wird, sollte die Datei, die hier im Ordner lombok liegt, in das Hauptverzeichnis des jeweiligen Projektes kopiert werden. Dies sorgt dafür, dass die generierten Codezeilen von JaCoCo bei Berechnung der Code-Coverage ausgelassen werden.