Ein Java Projekt besteht meistens aus mehreren Komponenten bzw. sollte aus mehreren Komponenten bestehen, denn die fachlichen Anforderungen sollten klar von den Technischen getrennt sein. Dieses ist mit Apache Maven und ein Multi Module Projekt in wenigen Schritten umzusetzen.
Als Erstes muss man sich um die benötigten Module ein Gedanken machen, für dieses Beispiel habe ich folgende Anforderung:
- Es soll eine JavaFX Anwendung werden.
- Es wird eine Datenbank benötigt.
Aus diesen beiden Anforderungen entstehen schonmal 2 Module welche als
- app -> JavaFX Anwendung
- dbservice -> Datenbank
bezeichnet werden.
In den nachfolgenden Schritten verwende ich die Kommandozeile in der Eingabeaufforderung.
Erstellen des Parent Projektes
Als erstes erzeugt man das Parent Project dieses wird für
- die Verwaltung
- der Module
- der Abhängigkeiten (Dependencies)
- das Erzeugen der Anwendung
benötigt.
Mit folgender Batch Datei kann man sich, die für dieses Tutorial benötigte Struktur erstellen lassen.
@ECHO ON REM --- Auf das Laufwerk "C" wechseln c: REM ---- Erzeugen des temporären Verzeichnisses mkdir temp REM ---- Wechsel in das temporären Verzeichnisses cd temp REM ----- Erzeugen des Projekt Verzeichniss mkdir JFxProject REM ----- Wechsel in das Projekt Verzeichniss cd JFxProject REM ---- Erzeugen der Verzeichnisstruktur für die Module mkdir app\src\main\java mkdir app\src\main\resources mkdir app\src\test\java mkdir app\src\test\resources mkdir dbservice\src\main\java mkdir dbservice\src\main\resources mkdir dbservice\src\test\java mkdir dbservice\src\test\resources
Nachdem die Verzeichnisstruktur besteht, kann nun mit dem Erstellen der POMs begonnen werden.
Erstellen der Parent POM
Die Parent POM enthält die Verweise auf die benötigten Module sowie die allgemeinen Dependencies und Projekteigenschaften (zbsp. die Versionsnummer).
- Erzeugen Sie im Ordner JFxProject eine Textdatei und benennen diese in „pom.xml“ um,
- nun öffnen Sie diese erzeugte Datei mit einem doppelklick.
(Ich empfehle einen Editor wie Notepad++ oder PSPad da diese die XML Struktur besser darstellen können.)
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>de.firmenname</groupId> <artifactId>JFxProject</artifactId> <version>1.0</version> <packaging>pom</packaging> <modules> <module>app</module> <module>dbservice</module> </modules> </project>
Erstellen der Module POM
Als Nächstes müssen die POM Dateien in den Modulen erzeugt werden.
Modul app
Um die POM Datei für das Modul app zu erzeugen,
- wechselt man in den Ordner app,
- erzeugt eine Textdatei und benennen diese in „pom.xml“ um,
- nun öffnen Sie diese erzeugte Datei mit einem doppelklick.
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <!-- Parent Projekt --> <parent> <groupId>de.firmenname</groupId> <artifactId>JFxProject</artifactId> <version>1.0</version> </parent> <artifactId>app</artifactId> </project>
Da die Versionsnummer und die GroupId gleich sind kann man sich in den Modulen die Tags „version“ & „groupId“ sparen. Somit verbleibt nur der Tag „artifactId“ welcher den Namen des Modules bekommt.
Modul dbservice
Da die POM Dateien der Module sich in den Grundeinstellungen nur in dem Tag „artifactId“ unterscheiden kann man hier die zuvor erstellte Datei einfach aus dem Ordner app nach dbservice kopieren. Nachdem kopieren muss jedoch die ArtifactId auf „dbservice“ angepasst werden.
Abschlussarbeiten
Nachdem die Verzeichnisstruktur und die POM Dateien erzeugt wurden kann man das Projekt einmal compilieren, da zum öffnet man die Kommandozeile und wechselt in den Ordner JFxProject.
Folgender Befehl erzeugt nun den Ordner „target“ und kompiliert die Projekte.
mvn clean install
Zusätzlich werden in dem lokalen Maven Repository die Module abgelegt.
Download des Projektes
Für einen einfachen Einstieg biete ich hier den Download des erzeugten Projektes an.
Nächste Schritte
Die nächsten Schritte wären dieses Maven Projekt in eclipse zu importieren und dort mit der eigentlichen Entwicklung zu beginnen.