Jameica in Eclipse einrichten

Die folgende Anleitung beschreibt, wie du Jameica innerhalb der Eclipse Entwicklungsumgebung einrichten kannst.

Eine aktuelle Version der Eclipse-Entwicklungsumgebung (SDK) für Java findest du auf http://www.eclipse.org/downloads/

Diese Beschreibung basiert auf Eclipse „Mars“: Wähle eine Version für „Java Developer“ incl. Git aus.

• Starte Eclipse und öffne den „Package Explorer“
• starte mit einem Rechtsklick der Maus den „Import“
• Wähle aus unter Punkt „Git“ → „Projects from Git“
• Wähle „Clone URI“ aus
• Gib das Jameica Repository ein: https://github.com/willuhn/jameica
• Als nächstes nur die benötigten Branches aktivieren (üblicherweise master und origin)
• Dann den Zielort auf deinem System eingeben…
• Den Dialog bestätigen, dann wird auch schon heruntergeladen…
• Dann noch „Eclipse-Projekte in diesem Pfad suchen ausführen, voila - dann sollte es als Eclipse-Projekt vorhanden sein.

Weitere Eclipse-Projekte sind unter https://github.com/willuhn/ zu finden…

Zum Erstellen der ausführbaren Programme werden folgende Repositories benötigt:

• https://github.com/willuhn/jameica
• https://github.com/willuhn/hibiscus

Die folgenden Repositories sind optional, da die daraus erzeugten JAR-Dateien bereits in o.g. Hibiscus-Repository (im Ordner „lib“) enthalten sind:

• https://github.com/hbci4j/hbci4java
• http://git.code.sf.net/p/obantoo/obantoo

BTW: Bei Verwendung von Eclipse Oomph kann alternativ auch folgende Oomph-Setup-URI zur Einrichtung verwendet werden:

• https://raw.githubusercontent.com/willuhn/hibiscus/master/Hibiscus.setup

• Lade dir den Quellcode der aktuellsten Version (Nightly Build) von Jameica sowie das Beispiel-Plugin herunter und speichere die ZIP-Archive in einem beliebigen Verzeichnis.

• Klicke im Eclipse Navigator oder Package-Explorer mit der rechten Maustaste und wählen „Import…“. Wähle in dem sich öffnenden Fenster die Option „Existing Project into Workspace“.

• Wähle das ZIP-Archiv „jameica-<versionsnummer>-nightly.src.zip“ aus.

• Wiederhole den Vorgang für das Beispiel-Plugin. Im Package-Explorer/Navigator werden nun beide Projekte angezeigt.

Das Bild zeigt noch einen älteren Stand. In der Zwischenzeit hat sich die Namensgebung geändert und das Beispielprojekt heißt jameica.example.

• Wenn du nicht mit Linux sondern mit Windows oder MacOS arbeitest, muss noch der Classpath zur Datei „swt.jar“ für dein Betriebssystem ausgewählt werden. Klicke hierzu mit der rechten Maustaste auf das Projekt „jameica“ und wähle „Properties“ (ganz unten). Klicke links auf „Java Build Path“ und aktiviere anschließend rechts den Reiter „Libraries“.

• Wähle die Datei „swt.jar“ aus und klicke auf den Button „Edit…“. Wechsle in das Verzeichnis „jameica/lib/swt“ und suche dort die passende „swt.jar“ für dein Betriebssystem aus. Achte darauf, die Datei „swt.jar“ auch unter „Order and Export“ wieder zu aktivieren, damit die SWT-Klassen auch in den Plugin-Projekten verfügbar sind.

Um Jameica innerhalb des Eclipse-Debuggers zu starten, lege eine neue Launch-Konfiguration über das Hauptmenü „Run»Debug…“ an. Sollte dieser Menüpunkt nicht existieren, vergewissere dich, dass die „Debug“-Perspektive aktiviert ist. Öffne diese ggf. manuell über „Window»Open Perspective»Other…“. Wähle nun linker Hand die Art der Launch-Konfiguration „Java Application“ und drücke den Button „New“ um eine neue Konfiguration anzulegen. Gib folgende Eigenschaften ein:

Mit dem Parameter “-f„ kann ein abweichendes Arbeitsverzeichnis für Jameica angegeben werden, um zu vermeiden, dass die Einstellungen deiner produktiven Hibiscus/Jameica-Installation geladen werden. Gib niemals ein Arbeitsverzeichnis an, welches sich innerhalb des Eclipse-Projektes befindet. Jameicas Security-Manager verweigert das Schreiben von Dateien im Programm-Verzeichnis, um Manipulationen durch Plugins zu verhindern. Der Start von Jameica würde in diesem Fall mit einer „SecurityException“ fehlschlagen. Zu Testzwecken kannst du einen zusätzlichen Parameter “-p <password>„ verwenden, wenn du nicht bei jedem Start im Debugger das Master-Passwort eingeben möchtest. Alle anderen Parameter belässt du auf den Original-Einstellungen.

• Drücke „Apply“ um die Einstellungen zu speichern und anschliessend auf „Debug“. Du kannst anschliessend die letzte benutzte Launch-Konfiguration über die Taste „F11“ starten, ohne erneut diesen Dialog öffnen zu müssen.

Du solltest nun eine leere Jameica-Instanz ohne installierte Plugins sehen. Dieses Verhalten ist normal. In Jameica können beliebig viele Plugin-Verzeichnisse angegeben werden. Standardmässig ist dies jedoch nur das Verzeichnis „plugins“ innerhalb des Jameica-Projektes. Beende daher Jameica wieder und öffne die automatisch angelegte Konfigurations-Datei

in einem Text-Editor. Füge eine neue Zeile des Parameters „jameica.plugin.dir“ mit der fortlaufenden Nummer „0“ ein (die Plugin-Verzeichnisse werden in der Reihenfolge der Nummerierung geladen) und gib als Verzeichnis “../jameica.example„ ein. Damit zeigt das Plugin-Verzeichnis direkt in das zugehörige Eclipse-Projekt.

jameica.plugin.dir.0=../jameica.example

Speichere die Datei ab und starte Jameica erneut in Eclipse. Beim Start-Vorgang durchsucht Jameica nun auch das Projekt-Verzeichnis des Beispiel-Plugins und wird im „bin“- Verzeichnis fündig (dort werden ja die Klassen des Plugins hinkompiliert). Du solltest nun ein Jameica-Fenster mit installiertem Beispiel-Plugin sehen.

Falls das Plugin-Projekt Compile-Fehler erzeugt, stelle sicher, dass die swt.jar im Jameica-Projekt in den Projekteinstellungen unter „Order & Export“ aktiviert ist, damit das Plugin auf die SWT-Klassen zugreifen kann.

• Fertig.

Du kannst nun im Quellcode beliebig Breakpoints definieren und damit zeilenweise durch den Quellcode steppen oder ein eigenes Plugins nach analogem Aufbau zum Beispiel-Plugin erstellen.

Du kannst auch ein Release erzeugen, das ausserhalb von Eclipse benutzt werden kann. Klicke hierzu mit der rechten Maustaste auf die Datei „build/build.xml“ eines Projektes und wähle „Run As»Ant Build…“. Deaktiviere das Target „all“ und wähle stattdessen „fast“. Klicke „Run“ um das Erzeugen des Release zu starten. Ist das Script fehlerfrei durchgelaufen, klicke mit der rechten Maustaste im Navigator/Project Explorer auf das Projekt und wähle „Refresh“ um die Anzeige zu aktualisieren. Du solltest nun ein zusätzliches Verzeichnis „releases“ sehen, in dem sich das erzeugte Release befindet. Hinweis: Lösche erstellte Releases bitte wieder, wenn sie nicht mehr benötigt werden. Denn wenn der Eclipse-Projekt-Ordner gleichzeitig auch in „de.willuhn.jameica.system.Config.properties“ als Plugin-Verzeichnis registriert ist, würde Jameica beim nächsten Start nicht nur im „bin“-Verzeichnis das Plugin finden sondern zusätzlich auch in den Release-Verzeichnissen. Dies kann dazu führen, dass ein Plugin fälschlicherweise mehrfach geladen wird.

Aufruf von der Kommandozeile: Du kannst das Build-Script auch aus der Kommandozeile heraus aufrufen, wenn du Apache ANT installiert hast. Das Build-Script muss hierbei aus dem Ordner „build“ heraus aufgerufen werden (der Aufruf von „ant -f build/build.xml fast“ wird fehlschlagen).

cd build
ant fast

Hinweis: Das Skript build.xml geht davon aus, dass der Quellcode aus dem GIT-Repository gecloned wurde und versucht daher per Default (im Target „all“), den Code zu taggen. Dazu wird erwartet, dass das Kommandozeilenprogramm git verfügbar ist und Schreibzugriff auf dem GIT-Repository existiert. Nachdem dass bei den meisten nicht der Fall sollte für Testzwecke das Target „fast“ des Build-Scripts ausgeführt werden. Das überspringt das Taggen und erzeugt nur ein lokales Release.