Scarica sorgenti e Javadoc con Maven

1. Panoramica

Dare un'occhiata al codice sorgente e alla documentazione di diverse librerie e framework è un buon modo per saperne di più su di loro.

In questo breve tutorial, vedremo come configurare Maven, o chiedere a Maven, di scaricare per noi i sorgenti delle dipendenze e i loro Javadoc.

2. Riga di comando

Per impostazione predefinita, Maven scarica solo il file JAR effettivo di ciascuna dipendenza, non i file di origine e di documentazione.

Per scaricare solo i sorgenti , prima dobbiamo navigare nella directory contenente il pom.xml e poi eseguire il comando:

mvn dependency:sources

Potrebbe volerci un po 'di tempo per scaricare i sorgenti. Allo stesso modo, per scaricare solo i Javadoc, possiamo emettere il comando :

mvn dependency:resolve -Dclassifier=javadoc

Naturalmente, possiamo anche scaricarli entrambi in un unico comando:

mvn dependency:sources dependency:resolve -Dclassifier=javadoc

Ovviamente, se aggiungiamo una nuova dipendenza dopo aver emesso questi comandi, dobbiamo emettere nuovamente i comandi per scaricare sorgenti e Javadoc per la nuova dipendenza.

3. Impostazioni Maven

È anche possibile scaricare fonti e documentazione a livello di sistema su tutti i progetti Maven . Per farlo, dovremmo modificare il file ~ / m2 / settings.xml o crearne uno e aggiungervi la seguente configurazione:

    downloadSources  true true     downloadSources  

Come mostrato sopra, stiamo creando un profilo e lo attiviamo per impostazione predefinita. In questo profilo, stiamo impostando due proprietà che dicono a Maven di scaricare fonti e documentazione. Inoltre, Maven applicherà queste impostazioni a tutti i progetti.

4. Il file pom.xml

È anche possibile inserire questa configurazione nel pom.xml . In questo modo, costringiamo tutti i contributori del progetto a scaricare fonti e documentazione come parte della risoluzione delle dipendenze :

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

Qui stiamo configurando il plug-in Maven-dependency per scaricare i sorgenti e la documentazione.

5. Configurazione IDE

Possiamo anche impostare i nostri IDE preferiti per farlo per noi. Ad esempio, in IntelliJ IDEA, dobbiamo solo andare su Preferenze> Build, Execution, Deployment> Build Tools> Maven> importare e controllare le caselle di controllo delle fonti e della documentazione:

6. Conclusione

In questo breve tutorial, abbiamo visto come scaricare le fonti e la documentazione delle dipendenze in Maven in vari modi, dalle soluzioni della riga di comando alle configurazioni per progetto o a livello di sistema.