Maven - Pierwsze kroki

• Stworzenie projektu w Eclipse
• Stworzenie projektu w IntelliJ
• Struktura projektu Maven
• Typowy plik pom.xml
• Uruchomienie za pomocą komendy mvn
• Lokalne repozytorium Mavena
• Brak pliku pom.xml
• Problem z wersją Javy i rozwiązanie
• Problem z celem clean i rozwiązanie

Stworzenie projektu w Eclipse

Stworzenie projektu w IntelliJ

Struktura projektu Maven

• Konfiguracja projektu przetrzymywana jest głównym katalogu projektu w pliku xml o nazwie pom.xml.
• Źródła (pliki *.java) są przechowywane w projekcie w ścieżce: src/main/java.
• Pliki statyczne (na przykład *.html, *.properties) są przechowywane w projekcie w ścieżce: src/main/resources.
  
  Zwyczajowo tutaj przechowujemy źródła aplikacji, takie jak widoki w plikach *.html, pliki Javascript *.js (np. pliki AngularJS), konfiguracje w postaci plików *.properties, *.yaml, *.xml itp.
• Testy (pliki Java z testami) są przechowywane w projekcie w ścieżce: src/test/java.
• Pliki statyczne testów (na przykład pliki konfiguracyjne *.properties, *.yaml, *.xml itp) są przechowywane w projekcie w ścieżce: src/test/resources.
• Jeśli używamy innych języków w projekcie to przechowujemy je analogicznie w ścieżkach: src/main/groovy, src/test/groovy.
• Po kompilacji wynikowe pliki klas (pliki *.class) są umieszczane w katalogu target .
• Zawartość katalogu target jest pakowana do archiwów (paczek) typu *.jar, *.war, *.ear itp., które są gotowe do wdrożenia na serwerze.

Typowy plik pom.xml

• Deklaracja przestrzeni nazw xml, w ramach której będziemy korzystać z tagów w pliku:

  <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">
  
• Informacje o projekcie, w tym między innymi nazwa artefaktu oraz numer jego wersji (szczegóły w tabelce pod listingiem):

      <modelVersion>4.0.0</modelVersion>	
      <groupId>com.javappa</groupId>
      <artifactId>appaadmin</artifactId>
      <version>1.0.0</version>
      <name>AppaAdmin</name>
      <description>AppaAdmin</description>
  

  Nazwa taga	Znaczenie
  modelVersion	numer modelu zgodny z numerem w przestrzeni nazw
  groupId	grupa projektowa - najczęściej odwrócona nazwa domeny firmy, dla której pracujemy, a jeśli to nasz prywatny projekt to możemy użyć innego formatu, np. <nazwisko>.<imie>
  artifactId	nazwa identyfikująca artefakt - najczęściej nazwa naszego projektu
  version	numer wersji naszego artefaktu - w najprostszej wersji jest to zbiór trzech cyfr rozdzielonych kropkami, natomiast w prawdziwym projekcie biznesowym do tego numeru doklejane są jeszcze postfixy oznaczające etap w jakim znajduje się kod projektu (np. SNAPSHOT, M1, RC1, RELEASE, Final)
  name	nazwa identyfikująca artefakt - najczęściej nazwa naszego projektu napisana w eleganckiej formie - wyświetla się ona na konsoli podczas budowy projektu
  description	opis artefaktu - krótki i zwięzły opis projektu - również wyświetla się na konsoli poczas budowy projektu
• dependencies - zależności do innych artefaktów Mavena (najczęściej innych projektów w postaci paczek *.jar) lub bibliotek zewnętrznych:

  <dependencies>
      <dependency>
          <groupId>org.apache.commons</groupId>
          <artifactId>commons-lang3</artifactId>
          <version>3.0</version>
      </dependency>
      ...
  </dependencies>
  
• build - sekcja dodatkowych opcji uruchamianych podczas procesu budowy projektu (możemy tutaj na przykład dodać i skonfigurować wtyczki)

  <build>
      <plugins>
          <plugin>
              <groupId>org.apache.maven.plugins</groupId>
              <artifactId>maven-compiler-plugin</artifactId>
              <configuration>
                  <source>1.8</source>
                  <target>1.8</target>
              </configuration>
          </plugin>
          ...
      </plugins>		
  </build>
  
• repositories - sekcja, w której możemy podać repozytoria zewnętrzne, na których Maven będzie szukał zewnętrznych artefaktów, z których korzysta projekt. Jest ona dosyć często pomijana, ze względu na to, że repozytoria częściej definiujemy globalnie dla wielu projektów poprzez plik z ustawieniami zewnętrznymi settings.xml.

  <repositories>
      <repository> 
          <id>repository.spring.release</id> 
          <name>Spring GA Repository</name> 
          <url>http://repo.spring.io/release</url> 
      </repository>
      ...
  </repositories>
  

<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>com.javappa</groupId>
    <artifactId>appaadmin</artifactId>
    <version>1.0.0</version>
    <name>AppaAdmin</name>
    <description>AppaAdmin</description>
    
    <dependencies>
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.0</version>
        </dependency>
    </dependencies>
    
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                </configuration>
            </plugin>
        </plugins>		
    </build>
    
    <!-- Relatywnie rzadko używane w pliku pom (częściej repozytoria są przechowywane w pliku settings.xml), 
    ale warto znać taką możliwość, gdyż może się zdarzyć, że będzie ona stosowana w którymś z Waszych projektów. -->
    <repositories>
        <repository> 
            <id>repository.spring.release</id> 
            <name>Spring GA Repository</name> 
            <url>http://repo.spring.io/release</url> 
        </repository>
    </repositories>    

</project>

Uruchomienie za pomocą komendy mvn

mvn <NAZWA FAZY>

• compile - kompiluje kod źródłowy oraz kopiuje zasoby do katalogu classes (w target)
• package - tworzy paczkę typu *.jar, *.war itp. (w zależności od konfiguracji w pom.xml - domyślnie jest to *.jar)
• install - instaluje wynikową paczkę w lokalnym repozytorium
• clean - czyści katalog target wraz z wszystkim wygenerowanymi zasobami
• deploy - instaluje paczkę w zewnętrznym repozytorium (poza naszą maszyną, na przykład w firmowym repozytorium)

mvn clean install

Lokalne repozytorium Mavena

Brak pliku pom.xml

Problem z wersją Javy

Problem z celem clean