2018.06

Maven Archetype als Basis für neue MyCoRe Anwendungen

Zur Entwicklung einer eigenen MyCoRe-Anwendung stellen wir ein Anwendungsgerüst (Maven-Archetype) zur Verfügung, das als Grundlage für eigene Anwendung dienen kann.

Maven Archetype

Bis zur Version 2017.06 diente die MyCoRe-Anwendung „Skeleton“ (siehe Archiv) als Template für neue Anwendungen. Mit dem Maven-Archetype bieten wir nun eine fortgeschrittene Lösung an. Es generiert, durch die Abfrage von verschiedenen Parametern, eine neue MyCoRe-Anwendung, in der bereits eine Reihe von Voreinstellungen gesetzt sind. Dadurch entfällt das bisher notwendige Umbenennen von Dateien und Ordner sowie das Suchen und Ersetzen von Properties und Textbausteinenen nach dem Kopieren der Skeleton-Anwendung.

Voraussetzungen

Für die Anwendungsentwicklung mit Skeleton benötigen Sie die unter Systemanforderungen beschriebene Software.

1. Maven Archetype installieren

Damit der Archetype verwendet werden kann, muss er zuerst aus unserem Git-Repository heruntergeladen und im lokalen Maven-Repository installiert werden:

git clone https://github.com/MyCoRe-Org/mycore-skeleton-archetype mycore-skeleton-archetype
cd mycore-skeleton-archetype
mvn clean install

Mit einer neuen Anwendung starten

Im Folgenden beschreiben wir, wie man an der Kommandozeile oder mit Eclipse unter Verwendung des Maven-Archetypes eine neue Anwendung einrichtet. Beispielhaft verwenden wir den Namen „Skeleton“. Es sollte jedoch gleich der echte Name der neu zu erstellenden Anwendung gewählt werden.

a) über die Kommandozeile

Wir empfehlen, zuerst ein Arbeitsverzeichnis anzulegen.
(z.B. C:\skeleton\workspace oder ~/skeleton/workspace).

Danach wechselt man in dieses Verzeichnis und ruft das Maven-Kommando zum Erstellen der Anwendung auf:
mvn archetype:generate -DarchetypeGroupId=org.mycore.skeleton -DarchetypeArtifactId=mycore-skeleton-archetype -DarchetypeVersion=2018.06.0.2-SNAPSHOT
Das Kommando fragt dann die folgenden Parameter ab:

groupId:
org.myinstition.skeleton
artifactId:
skeleton
version:
1.0-SNAPSHOT (default)
package:
org.myinstition.skeleton (default)
mcrSolrMainCoreName:
skeleton_main
projectName:
My new Skeleton App

Die drei ersten Parameter werden in den zu erstellenden *.pom Dateien verwendet. package ist das Root-Package für die zu erstellenden Java-Klassen. mcrSolrMainCoreName bezeichnet den Namen (URL-Pfad auf dem SOLR-Server) des Haupt-Solr-Kerns für die Anwendung. Aus projectName wird u.a. der Titel der Webanwendung abgeleitet.

b) ein neues Eclipse-Projekt erstellen

In der Entwicklungsumgebung Eclipse kann eine neue Anwendung als Eclipse-Projekt über einen Wizzard erstellt werden.

Der Wizzard wird über New Maven Project gestartet

Maven Archetype auswählen
Abbildung: Eclipse: New Maven project starten
Formular erstellen
Abbildung: Eclipse: Maven Archetype auswählen
Formular erstellen
Abbildung: Eclipse: Parameter setzen

 Robert Stephan, Kathleen Neumann - 2018-11-15