Download kilder og Javadocs med Maven

1. Oversigt

At kigge på kildekoden og dokumentationen til forskellige biblioteker og rammer er en god måde at lære mere om dem på.

I denne korte vejledning ser vi, hvordan vi konfigurerer Maven eller beder Maven om at downloade afhængighedskilderne og deres Javadocs til os.

2. Kommandolinje

Som standard downloader Maven kun den faktiske JAR-fil for hver afhængighed, ikke kilderne og dokumentationsfilerne.

For at downloade kun kilderneførst skal vi naviger til den mappe, der indeholder pom.xml og udfør derefter kommandoen:

mvn afhængighed: kilder

Det kan tage et stykke tid at downloade kilderne. Tilsvarende for at downloade bare Javadocs kan vi udstede kommandoen:

mvn afhængighed: løse -Dclassifier = javadoc

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

mvn afhængighed: kilder afhængighed: løse -Dclassifier = javadoc

Hvis vi tilføjer en ny afhængighed efter udstedelse af disse kommandoer, er vi åbenlyst at udstede kommandoerne for at downloade kilder og Javadocs til den nye afhængighed.

3. Maven-indstillinger

Det er også muligt at downloade kilder og dokumentation i hele systemet på alle Maven-projekter. For at gøre det skal vi redigere ~ / m2 / settings.xml fil eller opret en og tilføj følgende konfiguration til den:

    downloadSources ægte ægte downloadSources 

Som vist ovenfor opretter vi en profil og aktiverer den som standard. I denne profil indstiller vi to egenskaber, der fortæller Maven at downloade kilder og dokumentation. Desuden vil Maven anvende disse indstillinger på alle projekter.

4. Den pom.xml

Det er endda muligt at sætte denne konfiguration i pom.xml. På denne måde tvinger vi alle projektbidragere til at downloade kilder og dokumentation som en del af afhængighedsopløsningen:

   org.apache.maven.plugins maven-afhængighed-plugin 3.1.2 kilder løser javadoc 

Her konfigurerer vi maven-afhængigheds-plugin for at downloade kilderne og dokumentationen.

5. IDE-opsætning

Vi kan også oprette vores foretrukne IDE'er til at gøre dette for os. For eksempel i IntelliJ IDEA er vi bare nødt til at gå til Præference> Build, Execution, Deployment> Build Tools> Maven> import og tjek kilder og dokumentation afkrydsningsfelter:

6. Konklusion

I denne hurtige vejledning så vi, hvordan man downloadede afhængighedskilder og dokumentation i Maven på en række forskellige måder, lige fra kommandolinieløsninger til konfigurationer pr. Projekt eller hele systemet.


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