Eine kurze Einführung
michael.eichberg@dhbw.de, Raum 149B
1.0.1
Management der Projektabhängigkeiten (z. B. JUnit, Log4J, Hibernate, Spring, ....)
Kompilieren des Quellcodes
Testen des Quellcodes
Paketieren des Quellcodes (.jar oder .war Datei erzeugen inkl. aller Abhängigkeiten)
Dokumentation erstellen
Reports erstellen (z.B. Testabdeckung, Code-Qualität)
... und vieles mehr, dass dann aber häufig Projektabhängig ist.
Ant[1]
Maven
Gradle
sbt
make (nicht spezifisch für Java)
Konvention, die praktisch über alle Build-Tools und IDEs hinweg gilt[2]:
Quellcode im Verzeichnis src/main/java
Testcode im Verzeichnis src/test/java
Ressourcen im Verzeichnis src/main/resources
Testressourcen im Verzeichnis src/test/resources
Konfigurationen und andere Ressourcen im Verzeichnis src/main/resources
gebaute Artefakte im Verzeichnis target
Maven ermöglicht es, den Rumpf für ein Java-Projekt mit einer einfachen Befehlszeile zu erstellen:
mvn archetype:generate \
-DgroupId=com.mycompany.app \
-DartifactId=my-app \
-DarchetypeArtifactId=maven-archetype-quickstart \
-DarchetypeVersion=1.5 \
-DinteractiveMode=falseDies erzeugt eine initiale Build-Konfiguration für ein einfaches Java-Projekt und erzeugt die Projektstruktur.[3]
Die GroupId folgt dabei den selben Konventionen wie Java-Packages. Die ArtifactId ist der Name des Projekts.
Eine Phase ist ein Schritt im Build-Lebenszyklus. Die ersten Phasen des Standardlebenszyklus sind:
validate
generate-sources
process-sources
generate-resources
process-resources
compile
Wenn eine Phase angegeben wird, dann werden alle vorherigen Phasen ausgeführt. Zum Beispiel führt mvn compile alle genannten Phasen in obiger Reihenfolge aus.
die wichtigsten Phasen des Standardlebenszyklus
überprüfen, ob das Projekt korrekt konfiguriert ist
kompilieren des Quellcodes des Projekts
testet den kompilierten Quellcode mit einem geeigneten Unit-Testing-Framework.
den kompilierten Code in ein verteilbares Format, z. B. ein JAR, verpacken.
Verarbeitet das Paket und stellt es, wenn nötig, in einer Umgebung bereit, in der Integrationstests ausgeführt werden können.
bereitstellen in einer Integrations- oder Release-Umgebung
Spezialisierte Lebenszyklen (mit eigenen Phasen)
bereinigt Artefakte, die von früheren Builds erzeugt wurden.
Phasen: pre-clean, clean, post-clean
generiert eine Site-Dokumentation für dieses Projekt
Phasen: pre-site, site, post-site, site-deploy
Code der Anwendung (in src/main/java/<package>/<class>.java)
1package de.dhbw;23/**4* Implements the main method to greet a user by name.5*/6public class HelloYou {78public static void main(String[] args) {9if (args.length == 0) {10System.out.println("Usage: java HelloYou <name>");11return;12}13System.out.println("Hello " + args[0] + "!");14} }
TestCode (in src/test/java/<package>/<class>.java)
(Herausforderung: Testing System.out)
Header
10public class HelloYouTest {1112// Let's redirect System.out to capture the output!13private final PrintStream defaultOut = System.out;14private final ByteArrayOutputStream testOut = new ByteArrayOutputStream();
Setup
15@BeforeEach16public void setOutputStream() {17final var out = new PrintStream(testOut);18System.setOut(out);19}2021@AfterEach22public void resetSystemOut() {23System.setOut(defaultOut);24}
Eigentliche Tests
28@Test29void testMainNoArgs() {30HelloYou.main(new String[0]);31assertEquals("Usage: java HelloYou <name>\n", testOut.toString());32}3334@Test35void testMainArg() {36HelloYou.main(new String[] { "Bob" });37assertEquals("Hello Bob!\n", testOut.toString());38}39}
Benötigte Imports
1package de.dhbw;23import static org.junit.jupiter.api.Assertions.assertEquals;4import org.junit.jupiter.api.Test;5import org.junit.jupiter.api.BeforeEach;6import org.junit.jupiter.api.AfterEach;7import java.io.ByteArrayOutputStream;8import java.io.PrintStream;
Maven - Build-Konfiguration (pom.xml im Root Verzeichnis des Projekts)
Header der Konfigurationsdatei
1<?xml version="1.0" encoding="UTF-8"?>23<project xmlns="http://maven.apache.org/POM/4.0.0"4xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"5xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">6<modelVersion>4.0.0</modelVersion>
Allg. projektspezifische Metainformationen (Achtung: Anpassung erforderlich!)
8<groupId>de.dhbw</groupId>9<artifactId>hello</artifactId>10<version>1.0</version>11<name>HelloYou</name>12<url>http://www.dhbw.de</url>
Buildumgebung
14<properties>15<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>16<maven.compiler.source>23</maven.compiler.source>17<maven.compiler.target>23</maven.compiler.target>18</properties>
Abhängigkeiten
20<dependencies>21<dependency>22<groupId>org.junit.jupiter</groupId>23<artifactId>junit-jupiter</artifactId>24<version>5.12.0</version>25<scope>test</scope>26</dependency>27</dependencies>
Konfiguration des Builds
29<build>30<plugins>
46<plugin>47<groupId>org.jacoco</groupId>48<artifactId>jacoco-maven-plugin</artifactId>49<version>0.8.12</version>50<executions>51<execution><goals><goal>prepare-agent</goal></goals></execution>52<execution>53<id>report</id>54<phase>test</phase>55<goals><goal>report</goal></goals>56</execution>57</executions>58</plugin>
59<plugin>60<artifactId>maven-surefire-plugin</artifactId>61<version>3.5.2</version>62</plugin>
63<plugin>64<artifactId>maven-jar-plugin</artifactId>65<version>3.0.2</version>66<configuration>67<archive>68<manifest>69<addClasspath>true</addClasspath>70<mainClass>de.dhbw.HelloYou</mainClass>71</manifest>72</archive>73</configuration>74</plugin>75</plugins>76</build>
77 </project>
Projekt bauen
mvn packageProjekt ausführen
Die gebauten Artefakte befinden sich im Verzeichnis target.
java -jar target/hello-1.0.jar <Name>Build-Konfiguration eines Java Projekts
(Falls Maven (mvn) noch nicht installiert ist, installieren Sie es.)
entpacken Sie das Projekt prog-adv-java-projects/code/newton-code.zip.
legen Sie eine pom.xml Datei an, um das Projekt zu bauen.
Konfigurieren Sie eine Abhängigkeit zu JUnit 5.12 und konfigurieren Sie das surefire Plugin, um die Tests auszuführen.
Nutzen Sie mvn test, um die Tests auszuführen.
Konfigurieren Sie das maven-jar-plugin, um ein ausführbares JAR zu erzeugen. Vergessen sie nicht die mainClass zu konfigurieren.
Nutzen Sie mvn package, um das Projekt zu bauen.
Nutzen Sie mvn site, um eine Dokumentation des Projekts zu erstellen.
Schauen Sie sich die erzeugten Artefakte an.
Testen Sie ob Sie die Anwendung mit java -jar target/newton-1.0-SNAPSHOT.jar starten können.
Weiterführende Aufgaben
(In diesem Fall ist es Ihrer Aufgabe zu recherchieren wie die Einbindung/Konfiguration zu erfolgen hat.)
Binden Sie Checkstyle in Ihre Projekt ein. D. h. wenn Sie die mvn site ausführen, dann soll automatisch ein Report in Hinblick auf die Einhaltung der Checkstyle-Regeln erstellt werden.
Schauen Sie sich den Report an und versuchen Sie für die Klasse Liste eine besser Einhaltung der Checkstyle Regeln zu erreichen.
Binden Sie das Maven-Plugin JaCoCo ein, dass automatisch die Testabdeckung berechnet und in einem Report darstellt. Führen Sie danach mvn test aus (und ggf. mvn site) und schauen Sie sich den Report an.
Wie hoch ist bereits die Testabdeckung für die Klasse List obwohl diese gar nicht explizit getestet wurde?
Schreiben Sie sinnvolle Tests für die Klasse List und erhöhen Sie die Anweisungsüberdeckung auf 100% - abgesehen von den Zeilen, die nur Exceptions werfen. D. h. Sie brauchen sich in den Tests nicht um den Code kümmern, der Exceptions wirft; ignorieren Sie diesen Aspekt für den Moment.
Binden Sie ein Maven-Plugin ein, dass automatisch die JavaDoc erstellt und in einem Report darstellt.