Archivi categoria: MAVEN

La categoria contiene una serie di articoli dedicati a Maven, il gestore di progetti della comunity Apache

MAVEN TUTORIAL – 11 – INTEGRARE JASPERREPORTS

In questo articolo vedremo come integrare un interessante plugin maven per la compilazione automatica dei report realizzati con jasperReports.

Incominciamo con il creare il nostro progetto maven con la direttiva

mvn archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-app -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

La direttiva crea una cartella contenente contenente il file pom.xml e la cartella src contenente i sorgenti e i file junit per l’esecuzione dei test.

Lanciamo la direttiva mvn eclipse:eclipse per creare i file necessari ad un progetto eclipse ed importiamo il progetto nel nostro workspace.

A questo punto agganciamo il plugin responsabile della compilazione dei sorgenti jrxml, tipici di JasperReports. Tale plugin prevede la presenza di una cartella jasperreports sotto src/main. Creiamo la cartella e modifichiamo il pom inserendo la dichiarazione del plugin.

A questo punto lanciamo la direttiva mvn compile per verificare la correttezza delle nostre operazioni. Se avete sbagliato a posizionare la cartella il plugin vi ricorderà il percorso esatto.

Restano da definire le dipendenze dalla versione di jasperReports da usare. Per farlo è sufficiente specificare la dipendenza a livello di progetto e a livello di plugin, nel nostro caso ho scelto la versione 4.0.2

Creiamo il nostro file jrxml nella cartella jasperreports e lanciamo la direttiva mcn compile. A questo sotto la cartella target avremo il nostro file compilato e pronto all’uso.

Il vantaggio di questa soluzione è di aver all’atto della compilazione tutti i report in linea con i file jrxml presenti nel progetto.

Qui trovate i sorgenti dell’articolo.

MAVEN TUTORIAL – 10 – GESTONE DEI MODULI

Nell’articolo di oggi vedremo una delle caratteristiche più interessanti di maven, ovvero quella di poter strutturare un progetto in moduli, componenti del progetto principale detto parent. In particolare definiremo un progetto composto da una interfaccia grafica realizzata in flex e un back-end che espone servizi soa basati su spring ws. Per le caratteristiche di spring-ws rimando alla sezione dedicata.

Iniziamo con il creare il progetto parent tramite la direttiva base

Adesso dobbiamo configurare i moduli all’interno del nostro progetto. Per farlo è sufficiente modificare il tag di packaging specificando pom al posto di jar e indicando i moduli tramite il tag modules.

Creiamo il progetto relativo al front-end realizzato in flex. In questo caso ci avvaliamo di flexmojos, un set di plugin realizzati da Sonatype per consentire in maven la compilazione, l’ottimizzazione e il testing di componenti flex. Mister Sonatype ha messo a disposizione una serie di archetipi per soddisfare le nostre esigenze: la creazione di una libreria, la creazione di una applicazione flex e la creazione di un progetto progetto suddiviso in moduli swc, swf e flex. Nel nostro caso ci avvaliamo del secondo archetipo e scegliamo la versione stable che è , nel momento in cui scrivo, la 3.9.

Generato il progetto occorre modificare il pom per includere il repository maven di Sonatype per consentire il download di tutti i componenti necessari alla compilazione. Potete includere il repository all’interno del pom file dello specifico progetto o nel file settings.xml per renderlo disponibile per tutti i progetti.

 

Infine specifichiamo il path del flash player stand alone per poter eseguire i test tramite la variabile flashPlayer.command

Creiamo il progetto del back-end realizzato in spring-ws 2.0. Usiamo la direttiva che abbiamo usato in uno dei precedenti articoli per generare il nostro back-end.

All’interno del progetto back-end specifichiamo la dipendenza dal progetto front-end tramite il tag dependencies

e includiamo il plugin flexmojos-maven-plugin responsabile di copiare gli swf generati nella root del nostro back-end.

Per verificare il corretto funzionamento lanciamo la direttiva mvn package sul progetto parent. I moduli verranno compilati e assemblati nell’ordine dichiarato, ottenenendo il seguente ouput:

Qui trovate i file necessari per fare il vostro progetto modulare.

MAVEN TUTORIAL – 9 – CREARE UN ARCHETIPO

Nell’articolo di oggi vedremo una delle funzioni più interessanti di Maven, ovvero la creazione di archetipi. La creazione di archetipi consente all’utente di creare progetti base da cui far partire gli sviluppi evitando le noiose fasi di configurazione, integrazione e i copia e incolla di sorgenti comuni.

L’uso di archetipi consente di definire dei progetti standard, la cui alberatura e le cui classi rispondono agli standard scelti, e che sono alla base deii progetti da essi derivati.

La generazione dell’archetipo si basa sulla direttiva archetype:create-from-project.

Tale direttiva genera l’archetipo basato sul progetto nella directory target/generated-sources/archetype.

Accediamo alla directory dell’archetipo e lanciamo la direttiva mvn:install.

Tale direttiva consente l’installazione dell’archetipo nel catalogo locale a disposizione per la creazione di altri progetti.

Per sfruttare l’archetipo appena generato creiamo una nuova directory e dopo esserci spostati al suo interno usiamo la seguente direttiva

mvn archetype:generate -DarchetypeCatalog=local

Tale direttiva consente attraverso una procedura guidata la creazione del nostro progetto basato sull’archetipo generato.

Il passo successivo è condividere il nostro archetipo su un repository maven all’interno della nostra azienda in modo da consentire a tutti gli utenti la creazione agevole di nuovi progetti.

MAVEN TUTORIAL – 8 – INTEGRARE SONAR

Nell’articolo di oggi vedremo come integrare Sonar all’interno di Maven. Sonar è una piattaforma open per la gestione della qualità del codice. Esso analizza il codice del progetto ed estrae tutte le statistiche utili per migliorare il progetto.

E’ possibile installare sonar come server indipendente o come web application su un container Tomcat. Si appoggia ad un database per le statistiche estratte. Presenta un database embedded Apache Derby, ma Sonar consiglia di appoggiarsi ad un database più robusto. Sonar supporta i seguenti database:

  • MySQL 5.1.x
  • Oracle 10g XE
  • PostgreSQL
  • MS SqlServer 2005

Per configurare un database diverso da Apache Derby occorre agire sul file di configurazione e agire sui parametri:

  • sonar.jdbc.url : URL del database
  • sonar.jdbc.driver : driver
  • sonar.jdbc.user : username (default ‘sonar’)
  • sonar.jdbc.password : password (default ‘sonar’)

Nel nostro caso installeremo sonar come web application su un tomcat. Scaricate la distribuzione zip, scompattatela e lanciate il bat presente nella directory war.

Una volta creato il file .war fate il deploy sul vostro tomcat e accertatevi che il context sia attivo. Il war si preoccuperà di generare in automatico tutte le tabelle utili sul vostro database.

A questo punto non resta che integrare il plugin nel nostro progetto maven. L’integrazione avviene in 3 step:

  • Inserire il puntamento al server nel file settings.xml di maven. Il file si trova sotto la conf di maven.

  •  Inserire il plugin nel pom file

  •  infine lanciare la seguente direttiva

mvn sonar:sonar

Dopo l’elaborazione della direttiva possiamo accedere alla dashboard di sonar e vedere i risultati

MAVEN TUTORIAL – 7 – GESTIRE UN REPOSITORY

Nel processo di gestione del processo Maven si basa sul concetto di repository. Per repository si intende un contenitore in cui sono presenti tutti gli artifatti utili alla gestione del progetto, opportunamente localizzati.

Il repository centrale di Maven è disponibile all’url http://repo1.maven.org/maven2, come definito nel file settings.xml.

Maven crea un repository in locale sotto la home dell’utente al fine di evitare accessi alla rete inutili. Nel processo di gestione del progetto Maven verifica in locale l’esistenza della libreria desiderata e in caso negativo interroga il repository centrale.

E’ possibile aggiungere altri repository, agendo sul file settings.xml oppure sul pom file del progetto.

La gestione di nuovi repository si rende necessaria quando occorre integrare librerie sviluppate internamente alla nostra organizzazione o ad oggi non ancora supportate dalla comunity di Maven.

Chi scrive usa artifactory, un ottimo repository open source realizzato da JFrog Ltd.

Sostanzialmente è una web application che implementa tutti i servizi necessari per la gestione di un repository Maven, dalla gestione delle librerie agli snapshot, dalla possibilità di importare e esportare i repository o solo alcuni rami di libreria.

Per l’installazione e l’utilizzo rimando al sito di artifactory, dove c’è un ottimo manuale wiki.

Per integrarlo all’interno del nostro progetto è sufficiente aggiungere nel pom file la sezione repositories

 Con questo articolo si chiude la presentazione di Maven. Per approfondimenti rimando al sito di Maven e all’ottimo tutorialpresente sul sito di Mokabyte.

MAVEN TUTORIAL – 6 – DIRETTIVE PRINCIPALI

Dopo aver visto le componenti principali del file pom analizziamo le direttive più comuni. Maven funziona a linea di comando. Il comando principale è mvn seguito da una serie di parametri, legati ai plugin agganciati nel file pom. Il comando mvn deve essere lanciato nella directory dove è presente il pom file, salvo che si voglia creare un progetto ex novo.

  • mvn –version

permette di inidividuare la versione di maven utilizzata, comodo per verificare se l’installazione è andata a buon fine.

  • mvn archetype:generate -DgroupId=com.mycompany.app -DartifactId=my-app -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

crea una directory di nome my-app con all’interno il pom file base, l’alberatura del progetto e degli unit test.

  • mvn eclipse:eclipse

crea i file di progetto per consentire l’import all’interno di eclipse

  • mvn eclipse:clean

rimuove i file di progetto di eclipse

  • mvn compile

genera tutti i file .class secondo l’alberatura del progetto

  • mvn clean

elimina i file generati

  • mvn package

assembla il progetto nel formato desiderato

E’ importante notare che è possibile lanciare in sequenza i comandi

  • mvn clean compile package

MAVEN TUTORIAL – 5 – SYSTEM INTEGRATION

Il pom file permette di integrare diversi sistemi all’interno del nostro progetto.

E’ possibile integrare un sistema per la gestione del tracking dei difetti. Tramite il tag issueManagement è possibile inserire le coordinate del sistema di tracking.

E’ possibile integrare un sistema per la Continuous Integration

Un sistema per la gestione di una mailing list

Un sistema per il software configuration come svn

E’ possibile aggiungere altri repository, oltre quello previsto dal sistema Maven http://repo1.maven.org/maven2/

Il repository è il sistema che contiene tutti gli artifatti necessari per la gestione del progetto. Possono essere aggiunti altri repository, che contengono libreria necessarie per la gestione del progetto.

MAVEN TUTORIAL – 4 – BUILD

Oggi analizziamo la sezione dedicata al build, ovvero l’insieme di tutte le informazioni riguardanti la struttura del progetto, dei plugin e dei report.

La sezione base presenta la seguente struttura:

  •  Il tag defaultGoal indica l’obiettivo che deve eseguire Maven una volta lanciato. Normalmente viene indicato tramite linea di comando
  • Il tag directory indica dove viene salvato il prodotto di Maven
  • il tag flnalName indica come viene nominato il prodotto di Maven
  • Il tag filter individua i file filter. Sono dei file che contengono variabili che vengono applicate durante la fase di compilazione e packaging.

Altra sezione fondamentale è quella dedicata alle risorse, ovvero quei file che non vengono compilati ma inglobati nel bundle generato.

  • Il tag filtering indica se applicare le variabil contenute nei file filtri.
  • Il taf directory indica dove si trovano le risorse
  • Il tag include permette di selezionare alcune risorse, specificando un pattern
  • Il tag exclude permette di escludere alcune risorse, specificando un pattern

MAVEN TUTORIAL – 3 – GESTIONE DELLE DIPENDENZE

Per la gestione del progetto Maven applica i concetti di dipendenza, ereditarietà e aggregazione.

La dipendenza viene gestita tramite il tag dependency. Tale tag permette di individuare gli elementi necessari per la gestione del progetto.

La tripletta groupId, artifactId e version identifica univocamente la libreria all’interno del repository Maven.

Il tag type individua il formato della libreria, se non è indicato vale jar.

Il tag scope invidua per quale fase del progettoè necessaria la libreria. Può assumere vari valori:

  • compile –> indica che la libreria è necessaria per la compilazione. E’ il valore di default qualora non venga indicato.
  • provided –> indica che la libreria è necessaria per la compilazione, ma che viene fornita dalla JDK o dal container.
  • runtime –> indica che la libreria non è necessaria per la compilazione, ma solo per l’esecuzione.
  • test –> indica che la libreria è usata solo in fase di testing.
  • system –> è simile al provided, ma in tal caso è compito dell’utente indicare dove reperire la libreria tramite il tag systemPath

Il tag optional indica che la libreria è opzionale qualora si volesse aggiungere in un nuovo progetto la dipendenza da questo progetto.

Tramite il tag exclusion è possibile rimuovere delle specifiche dipendenze dagli artifatti aggiunti.

L’ereditarietà permette di creare nuovi POM file che ereditano le relazioni definite in un super POM. Il tutto viene gestito tramite il tag parent. Ecco un esempio.

E’ possibile anche definire un progetto come aggregato di altri progetti. L’aggregazione viene gestita dal tag module. In tal modo è possibile tramite un solo pom gestire il ciclo di vita di più sottoprogetti.

MAVEN TUTORIAL – 2 – INFORMAZIONI GENERALI

In questo articolo continuiamo l’analisi del POM file, cuore di Maven. Dopo aver visto la configurazione minima, che localizza in modo univoco il progetto all’interno di un repository maven, analizziamo altri tag presenti all’interno del file. In particolare analizziamo la sezione dedicata alle informazioni generali.

Il tag name individa il nome del progetto e viene usato nella generazione della documentaziotag ne.

Il tag description fornisce una descrizione base del progetto e viene usato nella generazione della documentazione.

Il tag url indica l’indirizzo web del sito del progetto.

Il tag inceptionYear indica l’anno di avvio del progetto.

Il tag licenses contiene i riferimenti alle licenze specifiche del progetto.

Il tag organization presenta le informazioni della organizzazione responsabile del progetto.

Il tag developer presenta le informazioni che identificano il team di sviluppo.

Il tag contributor presenta le informazioni che identificano eventuali contributori.

Ecco un esempio del file xml