Last ned kilder og Javadocs med Maven

1. Oversikt

Å kikke på kildekoden og dokumentasjonen til forskjellige biblioteker og rammer er en god måte å lære mer om dem.

I denne korte opplæringen vil vi se hvordan du konfigurerer Maven, eller spør av Maven, for å laste ned avhengighetskildene og deres Javadocs for oss.

2. Kommandolinje

Som standard laster Maven bare ned den faktiske JAR-filen for hver avhengighet, ikke kildene og dokumentasjonsfilene.

For å laste ned bare kildeneførst skal vi naviger til katalogen som inneholder pom.xml og utfør deretter kommandoen:

mvn avhengighet: kilder

Det kan ta litt tid å laste ned kildene. På samme måte, for å laste ned bare Javadocs, kan vi utstede kommandoen:

mvn avhengighet: løse -Dclassifier = javadoc

Selvfølgelig kan vi også laste ned dem begge i en kommando:

mvn avhengighet: kilder avhengighet: løse -Dclassifier = javadoc

Åpenbart, hvis vi legger til en ny avhengighet etter at vi har utstedt disse kommandoene, må vi utstede kommandoene på nytt for å laste ned kilder og Javadocs for den nye avhengigheten.

3. Maven-innstillinger

Det er også mulig å laste ned kilder og dokumentasjon på hele Maven-prosjekter. For å gjøre det, bør vi redigere ~ / m2 / settings.xml fil eller opprett en og legg til følgende konfigurasjon i den:

    downloadSources true true downloadSources 

Som vist ovenfor oppretter vi en profil og aktiverer den som standard. I denne profilen setter vi to egenskaper som forteller Maven å laste ned kilder og dokumentasjon. Videre vil Maven bruke disse innstillingene på alle prosjekter.

4. Den pom.xml

Det er til og med mulig å sette denne konfigurasjonen i pom.xml. På denne måten tvinger vi alle prosjektbidragsytere til å laste ned kilder og dokumentasjon som en del av avhengighetsoppløsningen:

   org.apache.maven.plugins maven-avhengighet-plugin 3.1.2 kilder løser javadoc 

Her konfigurerer vi maven-avhengighets-plugin for å laste ned kildene og dokumentasjonen.

5. IDE-oppsett

Vi kan også sette opp våre favoritt IDEer for å gjøre dette for oss. For eksempel, i IntelliJ IDEA, må vi bare gå til Preferanse> Bygge, utføre, distribuere> Byggverktøy> Maven> importere og merk av for kildene og dokumentasjonen:

6. Konklusjon

I denne raske veiledningen så vi hvordan du laster ned avhengighetskilder og dokumentasjon i Maven på en rekke måter, alt fra kommandolinjeløsninger til konfigurasjoner per prosjekt eller hele systemet.


$config[zx-auto] not found$config[zx-overlay] not found