Dynamische Projekteigenschaften mit Maven Resources Plugin und Filter

Das Maven Resources Plugin wird häufig zum Filtern von Dateien verwendet, wodurch Platzhalter in Ressourcendateien durch in der pom.xml definierte Werte ersetzt werden können. Im Kontext der Ausgabe der Versionsnummer kann dieses Plugin dynamische Projekteigenschaften (Version, artifactId, groupId) während des Build-Prozesses direkt in Ressourcendateien einfügen. Die Maven-Koordinaten bestehen aus groupId, artifactId und version.

Maven verwendet Konventionen für die Namensgebung von Koordinaten. Die groupId identifiziert eindeutig eine Projektgruppe über alle anderen Gruppen hinweg. Sie sollte den Java-Paketnamensregeln folgen, beginnend mit einem umgekehrten Domainnamen, den Sie kontrollieren. Die artifactId ist der Name, unter dem das Projekt bekannt ist. Zusammen mit der groupId erzeugt sie einen Schlüssel, der dieses Projekt von allen anderen Projekten unterscheidet. Die version gibt an, um welche Version es sich handelt.

Um das Maven Resources Plugin für die Filterung zu verwenden, muss zuerst der Abschnitt in der Datei pom.xml konfiguriert werden. Diese Konfiguration weist Maven an, die Filterung für die Ressourcendateien im Projekt zu aktivieren.

So aktualisieren Sie die Datei pom.xml, um die Ressourcenfilterung zu aktivieren:

Diese Konfiguration weist Maven an, alle Dateien im Verzeichnis src/main/resources zu verarbeiten und eine Filterung anzuwenden, um alle Platzhalter durch die entsprechenden Werte aus den Maven-Projekteigenschaften (z. B. ${project.version}) zu ersetzen.

Die Zeile true ist der Schlüsselteil, der diese Funktion aktiviert.

Als Nächstes wird eine Ressourcendatei (z. B. version.txt) im Verzeichnis src/main/resources erstellt. Diese Datei kann Platzhalter wie ${project.version} enthalten, die während des Build-Prozesses dynamisch durch die in der Datei pom.xml definierte Versionsnummer ersetzt werden.

Erstellen Sie beispielsweise eine Datei version.txt mit folgendem Inhalt:

Bauen des Projekts
Nachdem die Konfiguration eingerichtet wurde, kann das Projekt mit dem Maven-Befehl erstellt werden:

$ mvn clean package

Nach dem Erstellen des Projekts befindet sich die gefilterte Datei version.txt standardmäßig im Verzeichnis target/classes/. Die Platzhalter ${project.version}, ${project.artifactId} und ${project.groupId} werden durch die in der Datei pom.xml angegebenen Werte ersetzt:

Es ist auch möglich, benutzerdefinierte Eigenschaften im -Abschnitt der pom.xml zu definieren und diese dann in den Ressourcendateien zu verwenden. Zum Beispiel:

Diese Eigenschaft kann dann in einer Ressourcendatei wie folgt verwendet werden:

Also eine pom.xml enthält z.B.

ergibt: