Padroneggiare Maven: comandi dettagliati, opzioni e suggerimenti per uno sviluppo efficiente

Gli strumenti di automazione e sviluppo sono sicuramente tra gli aspetti più importanti di un progetto e in questo blog vogliamo parlare di Maven. Maven è un potente strumento di automazione per progetti Java. Semplifica il processo di creazione e crea una struttura uniforme per i progetti. Quindi, semplifica la gestione e la comprensione dei progetti. Questo blog copre quasi tutto ciò che riguarda il mondo di Maven, coprendo un'ampia gamma di comandi e opzioni che semplificheranno il flusso di lavoro di sviluppo. Esploreremo vari aspetti come la gestione di server e contenitori, la gestione del controllo del codice sorgente (SCM) e GPG per la firma degli artefatti. Inoltre, esamineremo comandi specializzati per la gestione dei plug-in, l'assemblaggio e la distribuzione e la generazione di siti e report di progetto. Quindi, alla fine di questa guida, avrai una conoscenza approfondita di Comandi e opzioni di Maven.

Panoramica di Maven; Ciclo di vita del progetto

Nella lingua yiddish, la parola Maven significa “accumulatore di conoscenza”. Questo significato spiega praticamente la potenza di Maven come strumento di automazione per progetti Java. Maven rende il processo di creazione e la gestione del progetto molto semplice. E lo fa automatizzando varie attività e fornendo un sistema di creazione uniforme.

Ora, per avere un’idea chiara di come funziona Maven, analizziamo il concetto di a Modello oggetto del progetto (POM). POM è un file XML che contiene informazioni sul progetto e dettagli di configurazione. Maven utilizza POM come base del suo lavoro. Pertanto, Maven prende le dipendenze del progetto, la directory di build, la directory di origine, la directory di origine di test e gli obiettivi da questa origine per funzionare.

Dopo aver definito il progetto e le sue dipendenze da pom.xml, ogni volta che esegui un comando Maven, legge il file pom per eseguire la fase di compilazione specifica di quel comando. Esiste un lungo ciclo di vita del progetto dal momento in cui lo crei fino a quando non lo distribuisci effettivamente. Questo ciclo di vita definisce la sequenza di fasi che il tuo progetto dovrebbe attraversare. Ogni fase rappresenta una fase del ciclo di vita ed esegue attività specifiche, come la compilazione del codice sorgente, l'esecuzione di test e il confezionamento del codice in un formato distribuibile. Tutto ciò rende il ciclo di vita del progetto di Maven un concetto importante da comprendere. Diamo quindi uno sguardo più da vicino alle fasi del ciclo di vita di Maven:

1. Convalidare: Questa fase verifica che il progetto sia corretto e che tutte le informazioni necessarie siano disponibili.
2. Compilare: In questa fase viene compilato il codice sorgente del progetto.
3. Test: Questa fase testa il codice sorgente compilato utilizzando un idoneo framework di unit test.
4. Pacchetto: Questa fase impacchetta il codice compilato nel suo formato distribuibile (ad esempio JAR, WAR).
5. Installare: Nella fase di installazione, il pacchetto viene installato nel repository locale e diventa disponibile per altri progetti sulla stessa macchina.
6. Distribuire: Questa fase copia il pacchetto finale nel repository remoto per condividerlo con altri sviluppatori e progetti.

Ognuna di queste fasi ha un comando mvn corrispondente che tratteremo nelle prossime sezioni del nostro cheatsheet Maven. Questi saranno i comandi più importanti da utilizzare per gestire il processo di creazione del tuo progetto.

Gestione delle dipendenze

Una delle funzionalità principali di Maven è la gestione delle dipendenze. Questa funzionalità è così significativa nelle prestazioni di Maven perché semplifica la gestione delle dipendenze del progetto.

Come Maven gestisce le dipendenze

Maven utilizza un repository centralizzato, noto come Repository centrale Maven, dove è ospitata una vasta gamma di librerie e plugin. Quando un progetto richiede una dipendenza, Maven scarica automaticamente le librerie richieste dal repository centrale e le archivia nel repository locale. Questo repository locale è una cache sul tuo computer locale che riduce i tempi di download per le build future.

Le dipendenze in Maven sono specificate nel file pom.xml file sotto il <dipendenze> sezione. Ogni dipendenza è definita da un insieme di coordinate: ID gruppo, artefattoId, E versione.

Ambiti di dipendenza

Quando lavori con Maven, puoi specificare l'ambito delle dipendenze. Questo fattore definisce la visibilità del percorso di classe e la fase del ciclo di vita della dipendenza. Quindi, puoi sapere quale fase richiede questa dipendenza. Gli ambiti comuni sono:

• Compilare: Questo è l'ambito predefinito e viene utilizzato quando non viene specificato alcun ambito. Le dipendenze con questo ambito sono disponibili in tutte le fasi di compilazione e sono incluse nel pacchetto finale.
• Fornito: Ci aspettiamo che le dipendenze con questo ambito siano pronte dall'ambiente di runtime. Vengono utilizzati durante la compilazione ma non sono inclusi nel pacchetto finale.
• Durata: Queste dipendenze non sono necessarie per la compilazione ma lo sono durante l'esecuzione. Sono inclusi nel classpath di runtime.
• Test: Queste dipendenze sono necessarie solo per la compilazione e l'esecuzione dei test. Non sono inclusi nel runtime o nel pacchetto finale.
• Sistema: L'ambito del sistema è simile all'ambito fornito, ma è necessario fornire il JAR che Maven utilizzerà. Il JAR deve essere presente nel percorso di sistema.

Dipendenze transitive

Una delle potenti funzionalità di Maven è che può gestire dipendenze transitive. Quando un progetto dichiara una dipendenza, Maven include automaticamente non solo quella dipendenza ma anche le sue dipendenze, le dipendenze delle loro dipendenze e così via. Questa catena di dipendenze è nota come dipendenze transitive. Per chiarire le cose, immagina che il tuo progetto dipenda da spring-boot-starter-web, ora Maven includerà anche tutte le librerie da cui dipende spring-boot-starter-web, come Spring Core, Spring MVC e Jackson.

Ora che conosci la teoria su come Maven gestisce le dipendenze, vediamo come lavorarci nella pratica:

mvn dependency:resolve

Questo comando può risolvere e visualizzare tutte le dipendenze richieste per il tuo progetto. Puoi usarlo per vedere da quali librerie dipende il tuo progetto e assicurarti che tutto sia in ordine.

mvn dependency:tree

Con questo comando puoi avere una struttura ad albero delle dipendenze del tuo progetto. Mostra come ciascuna dipendenza è correlata e aiuta a identificare potenziali conflitti.

mvn dependency:analyze

Questo comando analizza le dipendenze del tuo progetto per trovare eventuali artefatti inutilizzati. Ti aiuta a ripulire il tuo progetto ed evitare inutili gonfiori.

Le funzionalità di gestione delle dipendenze di Maven semplificano il processo di sviluppo. Ti aiutano anche a evitare le trappole più comuni e a mantenere una struttura del progetto pulita e organizzata.

Esecuzione

L'esecuzione in Maven prevede l'esecuzione di attività o obiettivi specifici all'interno del progetto. Queste attività possono variare dall'esecuzione di programmi Java all'esecuzione di script o comandi esterni. Maven fornisce potenti plugin per semplificare queste esecuzioni. Questa è un'altra caratteristica di Maven che lo rende un ottimo strumento per automatizzare diverse parti del flusso di lavoro del progetto. Quindi, esaminiamo i comandi di esecuzione chiave di Maven:

mvn exec:java

Questo comando viene utilizzato per eseguire una classe Java nel tuo progetto. È utile per eseguire classi principali o testare programmi Java autonomi senza prima impacchettarli.

mvn exec:exec

Questo comando ti consente di eseguire qualsiasi programma o script esterno dall'interno dell'ambiente Maven. Puoi usarlo per eseguire script di shell, strumenti esterni o altri programmi che fanno parte del processo di creazione.

I comandi di esecuzione in Maven ti aiutano ad automatizzare le attività ripetitive. Puoi anche usarli per integrare strumenti e script esterni nel ciclo di vita della build Maven. Quindi, nel complesso possono aiutarti a gestire le tue attività in modo molto più efficace.

Gestione di server e contenitori

La gestione di server e contenitori è una fase importante nello sviluppo e nella distribuzione di applicazioni web. Maven facilita questo processo con potenti plug-in che ti consentono di eseguire, distribuire e gestire applicazioni Web su vari server e contenitori direttamente dal processo di creazione. Ecco alcuni comandi Maven essenziali per la gestione di server e contenitori:

mvn tomcat7:run

Questo comando esegue l'applicazione Web utilizzando Apache Tomcat. È utile per lo sviluppo e i test locali e ti consente di distribuire e testare rapidamente la tua applicazione web senza configurare un ambiente server completo.

mvn jetty:run

Questo comando esegue la tua applicazione web utilizzando un popolare server web chiamato Molo. Come Tomcat, Jetty è ottimo per lo sviluppo e i test grazie alle sue capacità di distribuzione leggere e veloci.

Come funziona la gestione di server e contenitori

Maven utilizza plugin come Tomcat7-maven-plugin E plugin-jetty-maven per gestire le operazioni del server. Questi plugin ti consentono di avviare, arrestare e configurare i server come parte del ciclo di vita della build. Pertanto, sviluppare e testare applicazioni web in un ambiente coerente diventa molto più semplice. L'utilizzo dei profili Maven per definire le configurazioni del server per ambienti diversi ti aiuta a gestire diverse impostazioni per sviluppo, test e produzione. Questa funzionalità di Maven ti consente anche di configurare la registrazione e il monitoraggio all'interno dei plug-in del tuo server. In questo modo puoi tenere traccia delle attività del server e risolvere rapidamente i problemi.

SCM (gestione del controllo del codice sorgente)

Un aspetto importante di qualsiasi progetto di sviluppo è la gestione del controllo del codice sorgente (SCM). I team di sviluppo necessitano di SCM per gestire le modifiche al codice sorgente nel tempo. Maven ha una serie di comandi per interagire con i sistemi SCM come Git, Subversion e altri. Questi comandi possono automatizzare varie attività, come l'archiviazione del codice, l'estrazione del codice e l'aggiornamento delle versioni del progetto. Ecco alcuni dei comandi chiave di Maven SCM e le relative opzioni:

mvn scm:checkin

Puoi utilizzare questo comando mvn per archiviare le modifiche del progetto nell'SCM. Questo comando aiuta ad automatizzare il processo di commit delle modifiche al repository del controllo del codice sorgente. Pertanto, gli ultimi aggiornamenti vengono sicuramente salvati e condivisi con il team.

mvn scm:checkout

Questo comando Maven viene utilizzato per estrarre il codice del progetto dal repository SCM ed è utile per ottenere una copia locale del progetto. Quindi, sei sempre sicuro di lavorare con la versione più recente del codice sorgente.

mvn scm:update

Questo comando mvn aggiorna la copia di lavoro locale del progetto con le ultime modifiche dal repository SCM. Il compito di questo comando è quello di assicurarsi che la codebase locale sia sincronizzata con il repository e includa eventuali nuove modifiche apportate da altri membri del team.

mvn scm:status

Questo comando mvn visualizza lo stato della copia di lavoro locale in relazione al repository SCM. In altre parole, ti informa su tutte le modifiche che sono state apportate localmente ma non ancora trasferite nel repository.

mvn scm:tag

Questo comando viene utilizzato per creare un tag nel repository SCM. I tag segnano punti specifici nella storia del progetto, come rilasci o traguardi significativi.

I comandi Maven SCM possono semplificare notevolmente il processo di gestione del codice sorgente del tuo progetto. Comprendere e utilizzare questi comandi migliorerà la tua efficienza e collaborazione all'interno del tuo team di sviluppo.

GPG (Guardia della privacy GNU)

GNU Privacy Guard (GPG) è un software crittografico che consente agli utenti di crittografare e firmare dati e comunicazioni. Nel contesto di Maven, GPG viene utilizzato per firmare gli artefatti per garantirne l'autenticità e l'integrità. Questo è importante quando distribuisci artefatti in repository pubblici perché consente agli utenti di verificare che gli artefatti non siano stati manomessi. Maven fornisce diversi comandi per lavorare con GPG e facilita il processo di firma e distribuzione degli artefatti del tuo progetto. Vediamo alcuni di questi comandi come esempi:

mvn gpg:sign

Puoi utilizzare questo comando esperto per firmare gli artefatti del progetto con GPG. La firma degli artefatti garantisce che possano essere verificati da altri e fornisce un livello di sicurezza e fiducia. Questo comando viene spesso utilizzato durante il processo di creazione per firmare JAR, WAR e altri tipi di artefatti prima della distribuzione.

mvn gpg:sign-and-deploy-file

Questo comando mvn combina la firma e la distribuzione di un file in un unico passaggio. Puoi usarlo quando vuoi firmare un artefatto e distribuirlo immediatamente in un repository. Ciò semplifica il processo e garantisce che tu voglia firmare un artefatto e distribuirlo immediatamente in un repository.

Incorporare l'accesso GPG nel processo di creazione di Maven può migliorare la sicurezza e l'affidabilità del tuo software. Pertanto, diventa più facile per gli utenti fidarsi e verificare i tuoi artefatti.

Gestione dei rilasci

La gestione dei rilasci è molto importante nello sviluppo del software. Con una gestione efficace dei rilasci puoi assicurarti che le versioni del software siano gestite, inserite in pacchetti e distribuite correttamente. Maven fornisce una serie di comandi per automatizzare e semplificare il processo di rilascio. Diamo un'occhiata ad alcuni esempi di opzioni e comandi Maven per la gestione dei rilasci:

mvn release:prepare

Questo comando mvn viene utilizzato per preparare un progetto per un rilascio. Esegue attività come verificare che non vi siano modifiche non salvate e aggiornare i numeri di versione nel file pom.xml file, contrassegnando la versione nel sistema di gestione del controllo del codice sorgente (SCM) e aggiornando il file pom.xml file alla successiva versione di sviluppo. Si assicura che il progetto sia in uno stato stabile e pronto per il rilascio.

mvn release:perform

Questo comando esegue l'effettivo processo di rilascio. Estrae il progetto dall'SCM nel tag creato da rilasciare: preparare comando, crea il progetto e distribuisce gli artefatti nel repository specificato. Questo comando garantisce che gli artefatti vengano creati dallo stato esatto del codice al momento della preparazione del rilascio.

mvn release:clean

Questo comando mvn rimuove tutti i file di backup del descrittore di rilascio creati durante il rilasciare: preparare processo. Pulisce l'ambiente e si assicura che non vi siano file rimanenti dai precedenti tentativi di rilascio. Questo comando ti offre uno spazio di lavoro pulito e previene potenziali problemi nelle prossime versioni.

L'utilizzo dei comandi di gestione dei rilasci semplifica i processi di rilascio, migliora la qualità del software e garantisce che i rilasci siano gestiti in modo efficace.

Archetipo

Se sei uno sviluppatore che desidera creare strutture di progetto basate su modelli predefiniti, dovresti prendere in considerazione l'utilizzo del plugin Maven Archetype. Qui discuteremo i principali comandi Maven associati agli archetipi.

mvn archetype:generate

Puoi utilizzare questo comando mvn per creare un nuovo progetto da un modello esistente o "archetipo". Questo comando guida l'utente nella selezione di un archetipo e nella configurazione del nuovo progetto. Quindi, ti aiuta a impostare un progetto ben strutturato.

mvn archetype:catalog

Questo comando elenca gli archetipi disponibili che possono essere utilizzati per generare nuovi progetti. È utile per esplorare i vari modelli forniti dalla comunità Maven e determinare quale archetipo si adatta meglio alle esigenze del tuo progetto.

Utilizzando questi due comandi esperti, puoi avviare rapidamente un nuovo progetto. Che tu stia avviando una semplice applicazione Java o un progetto aziendale complesso, gli archetipi di Maven forniscono un prezioso punto di partenza.

Gestione dei plugin

I plugin Maven consentono agli sviluppatori di estendere le funzionalità di Maven e automatizzare varie attività all'interno del ciclo di vita della build. La gestione efficace dei plugin garantisce che il tuo progetto rimanga manutenibile e che le build siano riproducibili. Questa sezione tratterà i comandi essenziali per la gestione dei plugin Maven.

mvn plugin:download

Questo comando viene utilizzato per scaricare un plug-in Maven specifico dal repository. Puoi usarlo quando vuoi assicurarti che un plugin specifico sia disponibile nel tuo repository locale prima di eseguire altri comandi Maven che dipendono da esso.

mvn plugin:help

Questo comando Maven visualizza informazioni dettagliate e documentazione su uno specifico plug-in Maven. Puoi usarlo quando hai bisogno di comprendere i vari obiettivi, parametri e configurazioni disponibili per un plugin.

Questi comandi di gestione dei plugin Maven migliorano il processo di creazione, automatizzano i flussi di lavoro e mantengono elevati standard di qualità e coerenza del progetto.

Assemblaggio e distribuzione

La funzionalità di assemblaggio e distribuzione di Maven consente agli sviluppatori di impacchettare i propri progetti in diversi formati per la distribuzione. Puoi utilizzarli per creare JAR eseguibili, applicazioni in bundle o distribuzioni personalizzate che includono dipendenze e altre risorse. Qui tratteremo i comandi chiave di Maven per l'assemblaggio e la distribuzione.

mvn assembly:assembly

Questo comando crea un assembly per il progetto. Un assembly è un pacchetto distribuibile che può includere file binari, codice sorgente, dipendenze e altre risorse. Questo comando utilizza il plugin Assembly per generare questi pacchetti in base al descrittore di assembly fornito.

mvn assembly:directory

Questo comando mvn crea la struttura di directory dell'assembly senza creare effettivamente il file di archivio. Questo comando è utile per testare e verificare il contenuto e la struttura dell'assembly prima di confezionarlo.

Imparare a utilizzare i comandi di assemblaggio e distribuzione di Maven può aiutarti molto nel confezionamento e nella distribuzione delle tue applicazioni.

Comandi per la generazione del sito

I comandi del sito di Maven sono un ottimo modo per documentare i progetti. Questi comandi creano siti Web di documentazione completi per i tuoi progetti. Qui tratteremo i comandi essenziali del sito e le loro funzioni:

mvn site

Il comando mvn site genera la documentazione del sito del progetto e include informazioni sul progetto, come il riepilogo del progetto, i rapporti sulle dipendenze, l'utilizzo dei plug-in e altro.

mvn site:deploy

È possibile utilizzare questo comando per distribuire il sito generato su un server remoto. Ciò è utile per rendere la documentazione disponibile a un pubblico più ampio, ad esempio i membri del team o il pubblico.

mvn site:stage

Questo comando posiziona il sito in una directory locale. È possibile utilizzare questo comando per visualizzare in anteprima il sito localmente prima di distribuirlo sul server remoto.

Una documentazione ordinata e organizzata è molto importante nello sviluppo di un progetto. Il comando maven site ti consente di avere tutto a posto e di avere una migliore comunicazione all'interno dei team di sviluppo.

Comandi WAR e JAR

Come sviluppatore, sai sicuramente che essere in grado di impacchettare le tue applicazioni in diversi formati è così importante nel processo di sviluppo. Maven consente di creare pacchetti di applicazioni Java in vari formati, inclusi file WAR (Web Application Archive) e JAR (Java Archive). L'importanza di questi formati di packaging diventa chiara quando si desidera distribuire applicazioni su server e distribuire librerie. Qui, trattiamo i comandi mvn chiave per generare file WAR e JAR:

mvn war:war

Questo comando compila il tuo progetto e lo impacchetta in un file WAR. Quando esegui questo comando, Maven genererà un file WAR nella directory di destinazione del tuo progetto.

mvn jar:jar

Questo comando compila il tuo progetto e lo impacchetta in un file JAR nella directory di destinazione del tuo progetto.

Questi due comandi ti aiutano nella distribuzione e nella distribuzione. Quindi puoi usarli per gestire e distribuire in modo efficiente le tue applicazioni Java.

Segnalazione

Qualsiasi progetto software necessita di report dettagliati per monitorare i progressi. E Maven dispone di potenti plugin e comandi mvn per generare vari tipi di report. Questa sezione copre due plugin Maven che puoi utilizzare per i report: Surefire e JaCoCo.

Plug-in sicuro

Puoi utilizzare questo plugin per eseguire unit test in un progetto Maven. Genera report dettagliati sui test eseguiti in modo da poter essere sicuri che il codice si comporti come previsto.

mvn surefire-report:report

Questo comando genera un rapporto di test unitario in un formato facile da leggere e analizzare. Con questo comando Maven crea un report HTML nel file obiettivo/sito directory del tuo progetto. Questo report include informazioni sul numero di test eseguiti, superati e falliti, insieme a analisi dello stack dettagliate per eventuali errori.

Plug-in JaCoCo

È possibile utilizzare questo plugin per misurare e segnalare la copertura del codice tramite test unitari. Quindi, puoi assicurarti che i tuoi test coprano la base di codice.

mvn jacoco:report

Se vuoi vedere quali parti del codice sono state testate e quali no, questo comando ti fornisce un rapporto sulla copertura del codice. Il report creato da questo comando è un report HTML nel file destinazione/sito/jacoco directory che mostra metriche di copertura dettagliate per classi, metodi e righe di codice.

Questi due plugin ti aiutano a tenere traccia dei risultati dei test e della copertura del codice e ti forniscono informazioni utili sullo stato e sulla qualità della tua base di codice.

Costruisci personalizzazione

Maven ti consente di personalizzare la build per soddisfare i requisiti specifici del tuo progetto. In questa sezione tratteremo come utilizzare i profili Maven e le definizioni delle proprietà per la personalizzazione della build.

Profili esperti

Con i profili Maven puoi definire diverse configurazioni per il tuo progetto, che possono essere attivate in base a diversi fattori come proprietà del sistema, variabili di ambiente o condizioni personalizzate. Ciò significa che puoi personalizzare il processo di compilazione per diversi ambienti, come sviluppo, test e produzione. Puoi definire i profili nel tuo pom.xml file sotto il <profili> sezione. E il -p L'opzione seguita dall'ID del profilo attiverà il profilo per te.

Definizioni delle proprietà

Le proprietà Maven ti consentono di definire valori che possono essere riutilizzati in tutto il tuo pom.xml file. Queste proprietà possono essere specificate nel file pom.xml, tramite la riga di comando o in file di proprietà esterni. È possibile definire le proprietà nel file <proprietà> sezione del tuo pom.xml. Dopo averle definite è possibile utilizzare queste proprietà in tutto il file pom.xml file.

La personalizzazione del processo di creazione in Maven può aiutarti ad adattare il tuo progetto a diversi ambienti e requisiti. Utilizzando i profili è possibile passare tra diverse configurazioni di compilazione e utilizzando le proprietà è possibile riutilizzare e gestire i valori in modo efficiente.

Conclusione

Questo blog ha fornito un'introduzione completa a Maven guidandoti attraverso ogni fase del processo di sviluppo di un'applicazione Java. Essendo un potente strumento di automazione per progetti Java, Maven ha diversi comandi e funzionalità per ogni fase dello sviluppo e sapere come lavorare con questi comandi ed essere al passo con essi cambia in meglio la qualità del processo di sviluppo.

Domande frequenti

A cosa serve Maven?

Maven è uno strumento di automazione della build e di gestione dei progetti per progetti Java. Semplifica il processo di creazione, gestisce le dipendenze del progetto e fornisce una struttura di progetto standardizzata. Maven supporta anche la documentazione, il reporting e la distribuzione del progetto.

Cos'è il POM in Maven?

Maven è uno strumento che automatizza il processo di creazione e la gestione delle dipendenze per i progetti Java. POM (Project Object Model) è un file XML in Maven che contiene informazioni sul progetto e dettagli di configurazione utilizzati da Maven per creare il progetto. Il file POM definisce le dipendenze del progetto, i plugin, gli obiettivi e altre configurazioni di build.