Einrichtung von Eclipse

Diese Dokumentation erläutert die Standard-Eclipse-Installation, wie sie von Next-Level-Integration für die Entwicklung mit der B2B by Practice empfohlen wird.

Vor der Installation

Java Development Kit Installieren

  1. Ein aktuelles JDK (Java Development Kit) x64 von der Oracle Website Herunterladen

  2. Der Installation folgen bis folgendes Fenster erreicht ist
    Geeignete Stelle für die Installation wählen Empfohlen C:\NLI\Java
    Bild von fertigem Installations Wizzard

Maven installieren

Es ist sinnvoll, eine separate Version von Apache Maven herunterzuladen und in eclipse einzubinden (siehe unten). Es wird empfohlen, Maven in der Version 3.6.1 zu verwenden. In den Maven-Settings kann ein Mirror zum NLI-Nexus hinzugefügt werden:

  <mirrors>
	<mirror>
		<id>nexus</id>
		<mirrorOf>*</mirrorOf>
		<url>http://nexus.next-level-apps.com:8081/nexus/content/groups/all_repos</url>
	</mirror>
  </mirrors>

Um auf unseren Nexus zugreifen zu können, müssen in unserer IT entsprechende IPs freigeschaltet werden.

Eclipse Installieren

Aktuelle Eclipse Version Herunterladen

  1. Eclipse kann von der Eclipse Website als Installer oder als Package herunter geladen werden
    Empfohlen wird die Installation via Package
    Bild von Eclipse Downloads

  2. Bild von Eclipse EE 64 bit

  3. Rechtsklick auf die Zip Datei und “Alle extrahieren” auswählen
    Geeignete Stelle zum Extrahieren wählen Empfohlen C:\Eclipse

Eclipse Updaten

Um die bereits laufende eclipse-Version zu aktualisieren, also nicht nur ein update aus eclipse heraus zu installieren, sondern ein neues Major Release zu nutzen, ist es nicht zwangsweise notwendig, sich neue workspaces einzurichten. Ein neues eclipse-Release kann auch den alten workspace öffnen. Dieser wird dann auf die neue VErsion angepasst und kann ggf. nicht mehr mit einer alten Version genutzt werden.

Eclipse Einrichten

Workspace

Nach dem ersten Start im “Eclipse Launcher” einen Workspace Wählen/Anlegen Empfohlen C:\Eclipse_Workspace_"Projekt"
Bild vom Eclipse Launcher

Preferences

Öffnen der Preferences unter Tab Window/Preferences
Bild vom Eclipse Window Dropdown

Speicherverbrauch

Es ist zu empfehlen, im Installationsordner von eclipse in der Eclipse\eclipse.ini den Speicher von -Xmx=1024 auf -Xmx4096m zu erhöhen. Außerdem ist es nützlich in den Einstellungen unter Window/Preferences/General den Haken bei Show Heap Status zu setzen. Es wird der Heapstatus in der Statusleiste ganz unten angezeigt und es kann die Garabage Collection für Eclipse angestoßen werden.

Java JDK Einbinden

  1. Navigieren zu Java/Installed JREs

  2. Add Auswählen

  3. Standart VM wählen

  4. Pfad der installierten JDK angeben C:\Java\jdk-___ Wenn Java an empfohle Stelle installiert wurde

  5. Finish wählen und Haken bei der Hinzugefügten JDK wählen

Maven Einbinden

  1. Navigieren zu Maven/Installations

  2. Add Auswählen

  3. Maven Pfad in “Installation home:” angeben C:\Maven\apache-maven-3.3.3 (Wenn Maven an empfohlener Stelle Installiert wurde.)

  4. Haken bei Hinzugefügter Version 3.3.3 Setzen

  5. Navigieren zu Maven/User Settings

  6. In User Settings den Pfad zur Maven settings.xml wählen
    C:\Maven\apache-maven-3.3.3\conf\settings.xml Wenn Maven an empfohlener Stelle installiert wurde

Encoding Ändern

  1. Navigieren zu General/Workspace

  2. Unter dem Punkt Text file encoding den Haken bei Other: setzen und UTF-8 auswählen

Static Imports

  1. Navigieren zu Java/Editor/Content Assist/Favorites

  2. New Type Button auswählen und folgende Hinzufügen

    • org.hamcrest.CoreMatchers
    • org.hamcrest.Matchers
    • org.hamcrest.MatcherAssert
    • org.junit.Assert
    • org.junit.jupiter.api.Assertions
    • org.junit.jupiter.api.Assumptions

Logausgabe in den Unittests

Wenn Junit-Tests ausgeführt werden, erscheinen keine LOGGER-Ausgaben in der Konsole, weil Log4j2 während der Laufzeit in Eclipse nicht konfiguriert ist. Mit dem JVM-Parameter -Dlog4j.configurationFile kann eine Datei mit der Logger-Konfiguration angegeben werden. Dies kann unter Preferenzes -> Java -> Installed JREs -> aktuelle JRE -> Edit -> Default VM arguments gemacht werden.

Eine passende Konfigurationsdatei für das Loglevel DEBUG liegt im Platform-Projekt test.util unter src/main/recources/config-log4j2-ide.xml

Log4j2 Eclipse Konfiguration

Beispiel-Einstellung: -Dlog4j.configurationFile="file:/C:\SVN\B2BPlatform\test.util\src\main\resources\config-log4j2-ide.xml"

Code-Stil

interne Daten

Richtlinien bzgl. Code-Stil, z.B. Formatter, Warnings und CleanUp-Rules, sind in unserer internen Dokumentation verlinkt. Die entsprechenden Daten können auf Anfrage zur Verfügung gestellt werden.

Die weiteren relevanten Informationen sind in unserer internen Dokumentation unter Prozesse/Entwicklung und QA/Coding Guidelines zu finden.

NLI Formatter

  1. Infos zum NLI Formatter in interner Dokumentation lesen und den dort verlinkten Formatter herunterladen
  2. Navigieren zu Java/Code Style/Formatter
  3. Import Button auswählen und den herunterladen Formatter auswählen

Warnings

  1. Navigieren zu Java/Compiler/Error/Warnings

  2. Einstellungen aus internen Dokumenten übernehmen

Clean Up

  1. Suche in den Einstellung nach clean

  2. Die interne Dokumentation gibt weitere Informationen zu den möglichen Einstellungen.

  3. Konfiguriere die Save Actions wie in den Screenshots in der internen Dokumentation.

Einstellungen in der Oberfläche

Automatische Builds deaktivieren

Optionale Einstellung
ACHTUNG! Entfernt einige nützlichen Feautes
Diese Einstellung verhindert das automatische Bauen des Projektes was bei größeren Projekten lange dauern kann

  1. Öffnen des Project Tabs

  2. Entfernen des Build Automatically Haken

Plugins

Öffnen des Eclipse Marketplace unter Tab Help/Eclipse Marketplace
Bild vom Eclipse Window Dropdown

In Find: den Namen des Plugins eingeben und der Installation folgen

Wichtige Plugins

  • Eclipse Class Decompiler
    Bild vom Decompiler Plugin

  • Subclipse oder subversive
    Bild vom Subclipse Plugin

  • Eclipse XML Editors and Tools
    Bild vom XML Editor Plugin

  • Sonar Lint (auch ohne Verbindung zu einem Sonar Server hilfreich)
    Bild vom Sonar Lint Plugin

Plugin Empfehlungen

  • Infinitest
    Bild vom Infinitest Plugin
    Sollte kein vollständiges Verständnis für die Vorgänge bei diesem Plugin vorliegen, sollte es noch deaktiviert oder nicht installiert werden.

  • tarlog (Zoom von Code in eclipse mit Strg++ und Strg+-)
    Downloadseite
    Jar-Datei herunterladen und im eclipse-Ordner in den Ordner dropins legen.

Nützliche Shortcuts

Shortcut Befehl Beschreibung
STRG + SHIFT + T Open Type Öffnet ein Suchfeld um Klassen, Enums und Interfaces der Projekte zu Finden
STRG + SHIFT + R Open Resource Öffnet ein Suchfeld um Resourcen wie xml und txt Dateien der Projekte zu Finden
STRG + SHIFT + O Organize Imports Entfernt ungenutze oder falsche Imports und fügt fehlende Imports hinzu
ALT + SHIFT + ARROW-UP Enclosing Element Umschließt das momentane Element
ALT + SHIFT + R Refactor: Rename Ändert den Namen des momentan ausgewählten Elements in der gesammten Klasse
ALT + SHIFT + T Refactoring Öffnet das Kontextmenü mit der Auswahl der verschiedenen eclipse-Refactorings
ALT + SHIFT + A Multi Line Select Wählt mehrere Zeilen aus um in allen die selbe Änderung vor zu nehmen
STRG + 1 Quick Fix Öffnet einen “Context assist dialog” mit welchem Fehler behoben oder zb. Variablen als Konstanten ausgelagert werden können
ALT + F5 Update Maven Project Öffnet den “Update Maven Project” Dialog zum aktualisieren der maven-Konfiguration der Projekte
View Me   Edit Me