Muat turun Sumber dan Javadocs dengan Maven

1. Gambaran keseluruhan

Mengintip kod sumber dan dokumentasi perpustakaan dan kerangka kerja yang berbeza adalah cara yang baik untuk mengetahui lebih lanjut mengenainya.

Dalam tutorial ringkas ini, kita akan melihat cara mengkonfigurasi Maven, atau meminta Maven, untuk memuat turun sumber pergantungan dan Javadocs mereka untuk kita.

2. Perintah

Secara lalai, Maven hanya memuat turun fail JAR sebenar setiap kebergantungan, bukan sumber dan fail dokumentasi.

Untuk memuat turun hanya sumbernya , pertama, kita harus menavigasi ke direktori yang mengandungi pom.xml dan kemudian melaksanakan perintah:

mvn dependency:sources

Mungkin perlu sedikit masa untuk memuat turun sumbernya. Begitu juga, untuk memuat turun hanya Javadocs, kita boleh mengeluarkan arahan :

mvn dependency:resolve -Dclassifier=javadoc

Sudah tentu, kita boleh memuat turun keduanya dalam satu arahan:

mvn dependency:sources dependency:resolve -Dclassifier=javadoc

Jelas, jika kita menambahkan ketergantungan baru setelah mengeluarkan perintah ini, kita harus mengeluarkan kembali perintah untuk memuat turun sumber dan Javadocs untuk ketergantungan baru.

3. Tetapan Maven

Anda juga boleh memuat turun sumber dan dokumentasi di seluruh sistem di semua projek Maven . Untuk melakukannya, kita harus mengedit fail ~ / m2 / settings.xml atau membuatnya dan tambahkan konfigurasi berikut ke dalamnya:

    downloadSources  true true     downloadSources  

Seperti yang ditunjukkan di atas, kami membuat profil dan mengaktifkannya secara lalai. Dalam profil ini, kami menetapkan dua sifat yang memberitahu Maven untuk memuat turun sumber dan dokumentasi. Lebih-lebih lagi, Maven akan menerapkan tetapan ini untuk semua projek.

4. The pom.xml

Bahkan mungkin memasukkan konfigurasi ini ke dalam pom.xml . Dengan cara ini, kami memaksa semua penyumbang projek memuat turun sumber dan dokumentasi sebagai sebahagian daripada resolusi ketergantungan :

   org.apache.maven.plugins maven-dependency-plugin 3.1.2    sources resolve   javadoc      

Di sini, kami mengkonfigurasi plugin-dependency maven untuk memuat turun sumber dan dokumentasi.

5. Persediaan IDE

Kami juga dapat menubuhkan IDE kegemaran kami untuk melakukan ini untuk kami. Sebagai contoh, di IntelliJ IDEA, kita hanya perlu pergi ke Preference> Build, Execution, Deployment> Build Tools> Maven> mengimport dan memeriksa kotak sumber dan dokumentasi:

6. Kesimpulannya

Dalam tutorial ringkas ini, kami melihat cara memuat turun sumber ketergantungan dan dokumentasi di Maven dengan pelbagai cara, mulai dari penyelesaian baris perintah hingga per-projek atau konfigurasi seluruh sistem.