streamalism.org

1. Bemutatkozás

Az Apache Maven az egyik legnépszerűbb Java-projektek építőeszköze. A függőségek és az adattárak decentralizálásán kívül az egyik fontos szempont a projektek közötti egységes címtárstruktúra támogatása is.

Ebben a rövid cikkben egy tipikus Maven-projekt szabványos könyvtárelrendezését tárjuk fel.

2. Könyvtár elrendezése

Egy tipikus Maven-projektnek van egy pom.xml fájl és könyvtárstruktúra meghatározott konvenciók alapján:

└───maven-project ├───pom.xml ├───README.txt ├───NOTICE.txt ├───LICENSE.txt └───src ├───main │ ├──── java │ ├───források │ ├─── szűrők │ └───webapp ├─── teszt │ ├ ├───jaja │ ├─── források │ └─── szűrők ├───it ├── ─ helyszín └─── összeszerelés

Az alapértelmezett könyvtárelrendezés felülírható a projektleírók segítségével, de ez nem gyakori és nem ajánlott.

Ebben a cikkben további részleteket tárunk fel az egyes szabványos fájlokról és alkönyvtárakról.

3. A gyökérkönyvtár

Ez a könyvtár minden Maven-projekt gyökérpontjaként szolgál.

Vizsgáljuk meg közelebbről azokat a standard fájlokat és alkönyvtárakat, amelyek általában a gyökérben találhatók:

• maven-project / pom.xml - meghatározza a Maven projekt összeállításának életciklusa során szükséges függőségeket és modulokat
• maven-project / LICENC.txt - a projekt engedélyezési információi
• maven-project / README.txt - a projekt összefoglalása
• maven-project / NOTICE.txt - információk a projektben használt külső könyvtárakról
• maven-project / src / main - forráskódot és erőforrásokat tartalmaz, amelyek a műtárgy részévé válnak
• maven-project / src / test - rendelkezik az összes tesztkóddal és erőforrással
• maven-project / src / it - általában a Maven Failsafe bővítmény
• maven-project / src / site - a Maven Site Plugin
• maven-project / src / assembly - a bináris csomagolás összeállításának konfigurációja

4. A src / main Könyvtár

Ahogy a neve is jelzi, src / main a Maven-projekt legfontosabb címjegyzéke. Bármi, ami állítólag egy műtárgy része, legyen az a befőttes üveg vagy háború, jelen kell lennie itt.

Alkönyvtárai a következők:

• src / main / java - Java forráskód a műtárgyhoz
• src / main / resources - konfigurációs fájlok és mások, mint pl i18n fájlok, környezetenkénti konfigurációs fájlok és XML-konfigurációk

• src / main / webapp - webalkalmazásokhoz olyan erőforrásokat tartalmaz, mint a JavaScript, CSS, HTML fájlok, sablonok és képek
• src / main / szűrők - olyan fájlokat tartalmaz, amelyek értékeket juttatnak az erőforrások mappában lévő konfigurációs tulajdonságokba a készítés szakaszában

5. A src / teszt Könyvtár

A könyvtár src / teszt az a hely, ahol az alkalmazás egyes alkotóelemeinek tesztjei találhatók.

Ne feledje, hogy ezek a könyvtárak vagy fájlok nem válnak a műtermék részévé. Nézzük meg az alkönyvtárakat:

• src / test / java - Java forráskód a tesztekhez
• src / test / resources - konfigurációs fájlok és a tesztek által használt egyéb fájlok
• src / test / szűrők - olyan fájlokat tartalmaz, amelyek értékeket juttatnak a konfigurációs tulajdonságokba az erőforrások mappában a teszt fázis alatt

6. Következtetés

Ebben a cikkben egy Apache Maven projekt szabványos könyvtárelrendezését vizsgáltuk.

A Maven projektstruktúrákra több példa található a GitHub projektben.