Standardni izgled direktorija Apache Maven

1. Uvod

Apache Maven jedan je od najpopularnijih alata za izgradnju Java projekata. Osim samo decentraliziranja ovisnosti i spremišta, promicanje jedinstvene strukture direktorija u projektima također je jedan od njegovih važnih aspekata.

U ovom ćemo kratkom članku istražiti standardni izgled direktorija tipičnog Mavenova projekta.

2. Izgled direktorija

Tipični Mavenov projekt ima pom.xml datoteka i struktura direktorija temeljena na definiranim konvencijama:

└───maven-projekt ├───pom.xml ├───README.txt ├───NOTICE.txt ├───LICENCA.txt └───src ├───glavna │ ├─── java │ ├───resources │ ├───filters │ └───webapp ├───test │ ├───java │ ├───resources │ └───filters ├───it ├── ─site └───montaža

Zadani izgled direktorija može se nadjačati pomoću deskriptora projekta, ali to je neobično i obeshrabreno.

Nastavljajući u ovom članku, otkrit ćemo više detalja o svakoj standardnoj datoteci i poddirektoriju.

3. Korijenski direktorij

Ovaj direktorij služi kao korijen svakog Mavenova projekta.

Pogledajmo bliže standardne datoteke i poddirektorijume koji se obično nalaze u root-u:

  • maven-project / pom.xml - definira ovisnosti i module potrebne tijekom životnog ciklusa gradnje Mavenova projekta
  • maven-project / LICENSE.txt - informacije o licenciranju projekta
  • maven-project / README.txt - sažetak projekta
  • maven-project / OBAVIJEST.txt - informacije o neovisnim knjižnicama korištenim u projektu
  • maven-project / src / main - sadrži izvorni kod i resurse koji postaju dijelom artefakta
  • maven-project / src / test - sadrži sav testni kôd i resurse
  • maven-project / src / it - obično rezervirano za integracijske testove koje koristi Maven Failsafe dodatak
  • maven-project / src / site - dokumentacija o mjestu izrađena pomoću Dodatak za web mjesto Maven
  • maven-project / src / assembly - konfiguracija sklopa za pakiranje binarnih datoteka

4. The src / glavni Imenik

Kao što i samo ime govori, src / glavni je najvažniji direktorij Mavenova projekta. Sve što bi trebalo biti dio artefakta, bilo da je to staklenka ili rat, trebao bi biti prisutan ovdje.

Njegovi su poddirektoriji:

  • src / main / java - Java izvorni kod za artefakt
  • src / glavni / resursi - konfiguracijske datoteke i druge poput i18n datoteke, konfiguracijske datoteke po okruženju i XML konfiguracije

  • src / main / webapp - za web aplikacije sadrži resurse poput JavaScript, CSS, HTML datoteka, pregledajte predloške i slike
  • src / main / filters - sadrži datoteke koje ubrizgavaju vrijednosti u svojstva konfiguracije u mapi resursa tijekom faze izrade

5. The src / test Imenik

Imenik src / test je mjesto gdje se nalaze testovi svake komponente u aplikaciji.

Imajte na umu da niti jedan od ovih direktorija ili datoteka neće postati dio artefakta. Pogledajmo njegove poddirektorije:

  • src / test / java - Java izvorni kod za testove
  • src / test / resources - konfiguracijske datoteke i ostale koje koriste testovi
  • src / test / filtri - sadrži datoteke koje ubacuju vrijednosti u svojstva konfiguracije u mapi resursa tijekom faze ispitivanja

6. Zaključak

U ovom smo članku pogledali standardni izgled direktorija za projekt Apache Maven.

Više primjera struktura projekata Maven može se naći u projektu GitHub.