Susun atur Direktori Piawai Apache Maven

1. Pengenalan

Apache Maven adalah salah satu alat binaan yang paling popular untuk projek Java. Selain mendesentralisasi pergantungan dan repositori, mempromosikan struktur direktori yang seragam di seluruh projek juga merupakan salah satu aspek pentingnya.

Dalam artikel ringkas ini, kita akan meneroka susun atur direktori standard untuk projek Maven biasa.

2. Susun atur Direktori

Projek Maven khas mempunyai fail pom.xml dan struktur direktori berdasarkan konvensyen yang ditentukan:

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

Susun atur direktori lalai boleh diganti menggunakan deskriptor projek, tetapi ini tidak biasa dan tidak digalakkan.

Selanjutnya dalam artikel ini, kami akan menemui lebih banyak perincian mengenai setiap fail dan subdirektori standard.

3. Direktori Akar

Direktori ini berfungsi sebagai akar setiap projek Maven.

Mari kita perhatikan lebih dekat fail dan subdirektori standard yang biasanya terdapat di root:

  • maven-project / pom.xml - mendefinisikan pergantungan dan modul yang diperlukan semasa kitaran hayat pembinaan projek Maven
  • maven-project / LICENSE.txt - maklumat pelesenan projek
  • maven-project / README.txt - ringkasan projek
  • maven-project / NOTICE.txt - maklumat mengenai perpustakaan pihak ketiga yang digunakan dalam projek
  • maven-project / src / main - mengandungi kod sumber dan sumber yang menjadi sebahagian daripada artifak
  • maven-project / src / test - menyimpan semua kod dan sumber ujian
  • maven-project / src / it - biasanya dikhaskan untuk ujian integrasi yang digunakan oleh Maven Failsafe Plugin
  • maven-project / src / site - dokumentasi laman web dibuat menggunakan Maven Site Plugin
  • maven-project / src / assembly - konfigurasi pemasangan untuk pembungkusan binari

4. Direktori src / utama

Seperti namanya, src / main adalah direktori terpenting dari projek Maven. Apa-apa yang sepatutnya menjadi sebahagian daripada artifak, sama ada balang atau perang , mesti ada di sini.

Subdirektori adalah:

  • src / main / java - Kod sumber Java untuk artifak
  • src / main / resources - fail konfigurasi dan lain-lain seperti fail i18n , fail konfigurasi per-persekitaran, dan konfigurasi XML

  • src / main / webapp - untuk aplikasi web, berisi sumber daya seperti JavaScript, CSS, file HTML, templat tampilan, dan gambar
  • src / main / filter - mengandungi fail yang menyuntikkan nilai ke dalam sifat konfigurasi dalam folder sumber semasa fasa membina

5. Direktori src / ujian

Direktori src / test adalah tempat di mana ujian setiap komponen dalam aplikasi berada.

Perhatikan bahawa tidak ada direktori atau fail ini yang akan menjadi sebahagian daripada artifak. Mari lihat subdirektorinya:

  • src / test / java - Kod sumber Java untuk ujian
  • src / test / resources - fail konfigurasi dan lain-lain yang digunakan oleh ujian
  • src / test / filter - mengandungi fail yang memasukkan nilai ke dalam sifat konfigurasi dalam folder sumber semasa fasa ujian

6. Kesimpulannya

Dalam artikel ini, kami melihat susun atur direktori standard untuk projek Apache Maven.

Pelbagai contoh struktur projek Maven boleh didapati dalam projek GitHub.