Arbeiten mit Maven

Benötigte Tools

JDK und Eclipse

Maven-Projekt anlegen

• Starte Eclipse
• Führe die Funktion File - New - Maven Project aus
• Markiere die Option Create a simple project (skip archetype selection), entmarkiere die Option Use default Workspace location, gib die nachfolgenden Informationen ein und betätige die Drucktaste Next >
  • Location: [Pfad zu Deinem Projektordner] (z.B. C:\Users\Daniel Appenmaier\git\Java)
• Gib die nachfolgenden Informationen ein und betätige die Drucktaste Finish
  • Group Id: [Eine Domain].[Dein Name bzw. Deine Organisation in Kleinbuchstaben] (z.B. edu.appenmaier)
  • Artifact Id: [Der Name Deines Projekts in Kleinbuchstaben und ohne Leerzeichen] (z.B. java)
  • Version: 0.0.1-SNAPSHOT
  • Packaging: jar
  • Name: [Der Name Deines Projekts] (z.B. Java)
  • Description: [Die Beschreibung Deines Projekts] (z.B. Java)

Java-Version und Codierung festlegen

• Starte Eclipse
• Navigiere in der View Package Explorer zu Deinem Maven-Projekt
• Navigiere in Deinem Maven-Projekt zur Datei pom.xml und öffne diese
• Füge den abgebildeten Quellcode ein, um die Java-Version sowie die Codierung festzulegen, speichere die Änderungen und schließe die Datei wieder

pom.xml (Auszug)

   ...
   <properties>
      <!-- Java-Version -->
      <maven.compiler.release>[Deine installierte Java Version]</maven.compiler.release>
      <!-- Codierung -->
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
   </properties>
   ...

JavaDoc erstellen

• Starte Eclipse
• Navigiere in der View Package Explorer zu Deinem Maven-Projekt
• Navigiere in Deinem Maven-Projekt zur Datei pom.xml und öffne diese
• Füge den abgebildeten Quellcode ein, um das JavaDoc-Plugin einzubinden, speichere die Änderungen und schließe die Datei wieder
• Führe die Funktion Run - Run As - 1 Maven build... aus
• Gib die nachfolgenden Informationen ein und betätige die Drucktaste Run
  • Goals: clean package (alternativ: javadoc:javadoc)

pom.xml (Auszug)

   ...
   <build>
      <plugins>
         <!-- JavaDoc -->
         <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>[Version]</version>
            <executions>
               <execution>
                  <phase>package</phase>
                  <goals>
                     <goal>javadoc</goal>
                  </goals>
               </execution>
            </executions>
         </plugin>
      </plugins>
   </build>
   ...

Ausführbare JAR-Datei erstellen

• Starte Eclipse
• Navigiere in der View Package Explorer zu Deinem Maven-Projekt
• Navigiere in Deinem Maven-Projekt zur Datei pom.xml und öffne diese
• Füge den abgebildeten Quellcode ein, um das Shade-Plugin einzubinden, speichere die Änderungen und schließe die Datei wieder
• Führe die Funktion Run - Run As - 1 Maven build... aus
• Gib die nachfolgenden Informationen ein und betätige die Drucktaste Run
  • Goals: clean package

pom.xml

   ...
   <build>
      <plugins>
         <!-- Shade -->
         <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-shade-plugin</artifactId>
            <version>[Version]]</version>
            <executions>
               <execution>
                  <phase>package</phase>
                  <goals>
                     <goal>shade</goal>
                  </goals>
                  <configuration>
                     <shadedArtifactAttached>true</shadedArtifactAttached>
                     <transformers>
                        <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                           <mainClass>[Startklasse]]</mainClass>
                        </transformer>
                     </transformers>
                  </configuration>
               </execution>
            </executions>
         </plugin>
      </plugins>
   </build>
   ...