streamalism.org

1. Úvod

Apache Maven je jedným z najpopulárnejších nástrojov na zostavenie projektov Java. Okrem decentralizácie závislostí a úložísk je jedným z dôležitých aspektov aj podpora jednotnej štruktúry adresárov naprieč projektmi.

V tomto rýchlom článku preskúmame štandardné rozloženie adresárov typického projektu Maven.

2. Rozloženie adresára

Typický projekt Maven má pom.xml súbor a adresárová štruktúra na základe definovaných konvencií:

└───maven-project ├───pom.xml ├───README.txt ├───NOTICE.txt ├───LICENSE.txt └───src ├───main │ ├─── java │ ├───resources │ ├─── filtry │ └───webapp ├───test │ ├───java │ ├───zdroje │ └─── filtry ├───it ├── ─site └───zostavenie

Predvolené rozloženie adresára je možné prepísať pomocou deskriptorov projektu, je to však neobvyklé a neodporúča sa to.

Ďalej v tomto článku odhalíme ďalšie podrobnosti o každom štandardnom súbore a podadresári.

3. Koreňový adresár

Tento adresár slúži ako koreň každého projektu Maven.

Pozrime sa bližšie na štandardné súbory a podadresáre, ktoré sa zvyčajne nachádzajú v koreňovom adresári:

• maven-project / pom.xml - definuje závislosti a moduly potrebné počas životného cyklu zostavovania projektu Maven
• maven-project / LICENSE.txt - licenčné informácie o projekte
• maven-project / README.txt - zhrnutie projektu
• maven-project / NOTICE.txt - informácie o knižniciach tretích strán použitých v projekte
• maven-project / src / main - obsahuje zdrojový kód a zdroje, ktoré sa stanú súčasťou artefaktu
• maven-project / src / test - obsahuje všetok testovací kód a zdroje
• maven-project / src / it - obvykle vyhradené pre integračné testy používané serverom Maven Failsafe Plugin
• maven-project / src / site - dokumentácia k miestu vytvorená pomocou Doplnok Maven Site
• maven-project / src / zhromaždenie - konfigurácia zostavy pre balenie binárnych súborov

4. The src / main Adresár

Ako naznačuje názov, src / main je najdôležitejším adresárom projektu Maven. Čokoľvek, čo má byť súčasťou artefaktu, nech je to jar alebo vojna, by tu mal byť prítomný.

Jeho podadresáre sú:

• src / main / java - Zdrojový kód Java pre artefakt
• src / main / resources - konfiguračné súbory a ďalšie, ako napr i18n súbory, konfiguračné súbory podľa prostredia a konfigurácie XML

• src / main / webapp - pre webové aplikácie, obsahuje zdroje ako JavaScript, CSS, súbory HTML, šablóny zobrazenia a obrázky
• src / main / filtre - obsahuje súbory, ktoré vkladajú hodnoty do vlastností konfigurácie v priečinku resources počas fázy vytvárania

5. src / test Adresár

Adresár src / test je miesto, kde sa nachádzajú testy každého komponentu v aplikácii.

Upozorňujeme, že žiadny z týchto adresárov alebo súborov sa nestane súčasťou artefaktu. Pozrime sa do jeho podadresárov:

• src / test / java - Zdrojový kód Java pre testy
• src / test / zdroje - konfiguračné súbory a ďalšie použité pri testoch
• src / test / filtre - obsahuje súbory, ktoré počas testovacej fázy vkladajú hodnoty do vlastností konfigurácie v priečinku prostriedkov

6. Záver

V tomto článku sme sa pozreli na štandardné rozloženie adresárov pre projekt Apache Maven.

Viaceré príklady štruktúr projektu Maven možno nájsť v projekte GitHub.