© istockphoto.com/270770
Kürzere Build-Konfiguration mit Polyglot Maven

Tycho ohne pom.xml


Bis vor Kurzem erforderten Builds mit Maven zwingend eine pom.xml-Datei. Für Tycho als Maven-Plug-in bedeutete dies für jedes einzelne Eclipse-Plug-in und Feature eine zusätzliche Datei mit wenig Mehrwert. Wer wissen möchte, wie man mittels Polyglot Maven pom. xml für Tycho Builds loswird, oder wer sich schon immer über die sprichwörtlichen „fünf Kilometer pom.xml“ aufgeregt hat, der sollte hier weiterlesen.

Ziel des Tycho-Projekts ist es, Eclipse-Artefakte wie Plug-ins, Features und Update Sites/p2 Repositories mit Maven bauen zu können. Sowohl Maven als auch Eclipse­ waren zu Beginn des Tycho-Projekts längst etablierte Projekte und brachten jeweils eigene Modelle für im Build wichtige Begriffe wie Artefakt, Versionierung, Abhängigkeiten zwischen Artefakten, Abhängigkeitsauflösung und Artefakt Repositories mit sich. Tycho bildet die Brücke zwischen der Maven- und Eclipse-Welt. Um zu verstehen, warum die pom.xml-Datei nötig war und was ihren Inhalt bestimmt, schauen wir uns zunächst die Artefaktmodelle von Maven und Eclipse an.

The Maven Way

In Maven werden Artefakte durch so genannte GAV-Koordinaten global eindeutig identifiziert (GAV = Group­Id, ArtifactId, Version). Diese Koordinaten sowie alle sonstigen Build-relevanten Einstellungen müssen in einer pom.xml-Datei (POM = Project Object Model) konfiguriert werden. Ein Maven-Artefakt hat genau ein POM. Auch Abhängigkeiten zu anderen Artefakten werden in pom.xml deklariert. Der Maven Dependency Resolver Aether löst diese Abhängigkeiten zum Zeitpunkt des Builds automatisch auf, sowohl lokal als auch von entfernten Maven-Artefakt-Repositories (Listing 1).

Listing 1: Einfache pom.xml mit GAV-Koordinaten und Abhängigkeiten

<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/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.example</groupId>
  <artifactId>my-project</artifactId>
  <version>1.0.0-SNAPSHOT</version>
  <dependencies>
  <dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.11</version>
    <scope>test</scope>
  </dependency>
  </dependencies>
</project>

The OSGi Way

Im Gegensatz dazu benutzen Eclipse-Plug-ins ähnliche Konzepte aus OSGi: Ein Eclipse-Plug-in ist ein OSGi Bundle; ein Bundle wird eindeutig durch seinen Bun­dle-SymbolicName-Header im OSGi Manifest (Datei META-INF/MANIFEST.MF) identifiziert. Der Bundle-Version-Header deklariert die Version. Abhängigkeiten zu anderen Bundles und/oder Java-Paketen werden über Require-Bundle oder Import-Package-Header angegeben (Listing 2).

Listing 2: Einfaches Eclipse-Plug-in-OSGi-Manifest mit Abhängigkeiten

Bundle-ManifestVersion: 2
Bundle-SymbolicName: org.example.bundle
Bundle-Version: 1.0.0.qualifier
Require-Bundle: org.eclipse.core.runtime
Import-Package: org.junit

Die Abhängigkeiten werden zur Laufzeit vom OSGi Resolver und im Fall von Eclipse zum Installationszeitpunkt von p2 aufgelöst. p2 bietet den Dependency Resolver und das binäre Artefakt-Repository-Format für Tycho, also in etwa äquivalent zu Maven Aether und Maven Remote Artifact Repositories.

The Manifest-first Way

Der Build von Eclipse-Plug-ins folgt dem so genannten Manifest-First-Ansatz. Manifest First bedeutet...

headline from sands settings