Download bronnen en Javadocs met Maven

1. Overzicht

Gluren naar de broncode en documentatie van verschillende bibliotheken en frameworks is een goede manier om er meer over te weten te komen.

In deze korte tutorial zullen we zien hoe we Maven kunnen configureren, of Maven kunnen vragen om de afhankelijkheidsbronnen en hun Javadocs voor ons te downloaden.

2. Commandoregel

Standaard downloadt Maven alleen het daadwerkelijke JAR-bestand van elke afhankelijkheid, niet de bronnen en documentatiebestanden.

Om alleen de bronnen te downloaden, ten eerste moeten we navigeer naar de directory met de pom.xml en voer vervolgens het commando uit:

mvn-afhankelijkheid: bronnen

Het downloaden van de bronnen kan even duren. Evenzo om alleen de Javadocs te downloaden, kunnen we de opdracht geven:

mvn-afhankelijkheid: oplossen -Dclassifier = javadoc

Natuurlijk kunnen we ze ook allebei in één opdracht downloaden:

mvn-afhankelijkheid: bronafhankelijkheid: oplossen -Dclassifier = javadoc

Het is duidelijk dat als we een nieuwe afhankelijkheid toevoegen na het geven van deze commando's, we de commando's opnieuw moeten uitgeven om bronnen en Javadocs te downloaden voor de nieuwe afhankelijkheid.

3. Maven-instellingen

Het is ook mogelijk om systeembreed bronnen en documentatie te downloaden voor alle Maven-projecten. Om dat te doen, moeten we het ~ / m2 / settings.xml bestand of maak er een aan en voeg de volgende configuratie eraan toe:

    downloadSources echte echte downloadSources 

Zoals hierboven weergegeven, maken we een profiel aan en activeren we dit standaard. In dit profiel stellen we twee eigenschappen in die Maven vertellen om bronnen en documentatie te downloaden. Bovendien past Maven deze instellingen toe op alle projecten.

4. Het pom.xml

Het is zelfs mogelijk om deze configuratie in het pom.xml. Op deze manier dwingen we alle projectmedewerkers om bronnen en documentatie te downloaden als onderdeel van de afhankelijkheidsoplossing:

   org.apache.maven.plugins maven-dependency-plugin 3.1.2 bronnen lossen javadoc 

Hier configureren we het maven-afhankelijkheid-plugin om de bronnen en documentatie te downloaden.

5. IDE-instellingen

We kunnen ook onze favoriete IDE's instellen om dit voor ons te doen. In IntelliJ IDEA moeten we bijvoorbeeld gewoon naar Voorkeur> Bouwen, Uitvoering, Implementatie> Bouwtools> Maven> importeren en vink de selectievakjes voor bronnen en documentatie aan:

6. Conclusie

In deze korte tutorial hebben we gezien hoe afhankelijkheidsbronnen en documentatie in Maven op verschillende manieren kunnen worden gedownload, variërend van opdrachtregeloplossingen tot configuraties per project of systeembrede.


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