Trabajando con un proyecto gvSIG
- Compilar mi proyecto
- Desplegar mi proyecto
- Publicar mi proyecto
- Generación de documentación e informes
- Cómo añadir o actualizar una dependencia
Compilar mi proyecto
Para compilar un proyecto desde maven, basta con invocar el objetivo:
mvn compile
Desde eclipse, se ha creado un lanzador en la opción de External Tools que permite compilar desde maven fácilmente, con el nombre: mvn compile.
Antes de usar este lanzador, deberemos seleccionar o estar editando algun archivo del proyecto que vamos a compilar, ya que se emplea la variable project_loc para invocar a maven sobre un proyecto.
Hay que tener en cuenta que el proyecto de eclipse está configurado de forma que las clases compiladas se generan en el mismo directorio que lo hace maven, así que, por lo general, al invocar este objetivo sobre un proyecto que tengamos abierto en eclipse, ya esté todo compilado y no haga nada.
Además de compilar, si queremos lanzar los tests unitarios de nuestro proyecto desde maven, emplearemos el objetivo:
mvn test
Finalmente, si queremos que el código que compilemos en un proyecto, esté disponible para otros proyectos que dependendan del mismo, deberemos generar el o los archivos .jar correspondientes, e instalarlos en el repositorio local de maven. Para ello emplearemos el objetivo:
mvn install
El objetivo install, además de compilar, lanza los tests unitarios del proyecto. Si queremos hacer la instalación sin lanzarlos, podemos usar el objetivo:
mvn install (no tests)
El equivalente desde consola es:
mvn -Dmaven.test.skip=true install
Los proyectos de gvSIG están configurados para generar, además del archivo .jar con las clases compiladas, otro archivo .jar con los fuentes. Esto nos será útil al enlazar las dependencias en maven y su uso desde los proyectos de eclipse.
Por otro lado, si queremos hacer una instalación y compilación desde cero, podemos usar el objetivo:
mvn clean install
Desplegar mi proyecto
Si nuestro proyecto es una extensión de gvSIG, existe una tarea adicional, además de la compilación y generación de archivos .jar: la instalación de la extensión sobre gvSIG.
Para ello se ha creado el siguiente perfil en maven:
install-extension: copia los archivos .jar generados, junto con el resto de recursos de la extensión (configuración, properties con textos multiidioma, imágenes, etc.) a gvSIG.
Dicho perfil está activado por defecto en los proyectos de tipo extensión, cuando invocamos al objetivo:
mvn install
Publicar mi proyecto
Una vez que hayamos terminado un determinado desarrollo en nuestro proyecto, y queramos que esté disponible para otros proyectos, sin que éstos tengan que descargar el código fuente de nuestro proyecto y compilarlo, podemos publicarlo en el repositorio de maven de gvSIG.
Este paso adicional se realiza a través del objetivo:
mvn deploy
Este objetivo realiza un mvn install y, a continuación, sube los artefactos generados, como el archivo .jar con las clases compiladas, al repositorio de maven.
Note
para que el deploy funcione deberemos tener un usuario con permisos en el proyecto gvSIG, y haber realizado correctamente la configuración definida en el documento Configuración inicial de maven (ver contenido relacionado al final del documento).
Los proyectos de gvSIG están configurados de forma que el repositorio al que se suben los artefactos es el de gvSIG.
Como se comenta en el apartado de compilación, en gvSIG se genera, por defecto, tanto el archivo .jar con las clases compiladas como el archivo .jar con el código fuente, que también se subirá al repositorio.
Además, si estamos publicando una versión con cambios significativos, será conveniente publicar también el javadoc en un archivo .jar. Para ello activaremos el perfil release con el siguiente objetivo desde eclipse:
mvn deploy release
Desde consola, el uso de maven directo es el siguiente:
mvn -P release deploy
TODO
Note
estudiar para el futuro el uso del maven release plugin
Generación de documentación e informes
Maven permite la generación de documentación a partir de los fuentes de un proyecto, como por ejemplo el javadoc.
Para ello existen una serie de plugins especiales de maven para la generación de informes.
Por ejemplo, para generar el javadoc usaremos el plugin correspondiente de la siguiente forma:
mvn javadoc:javadoc
Además de la generación de informes individuales, maven permite la generación de lo que llaman el site. Este consiste en un conjunto de páginas de informes de maven enlazadas, con un menú que nos permite navegar por todos los documentos generados.
De hecho, este mini website generado con maven es lo que emplean muchos de los proyectos Java de apache como website del proyecto.
Para los proyectos de gvSIG, se ha preconfigurado una serie de plugins con las opciones adecuadas del proyecto. Además, existen una serie de páginas que muestran información extraída del archivo pom.xml del proyecto, por lo que será importante completar y mantener actualizada dicha información.
En los proyectos que se generen usando los arquetipos de maven, el archivo pom.xml ya lleva los atributos necesarios predefinidos, a falta de rellenar y completar con valores reales.
Para generar el site invocaremos el objetivo:
mvn site
Esto nos generará la documentación dentro de nuestro proyecto, en la carpeta:
target/site
TODO
- Links javadoc, la variable site-repository y referencias entre proyectos.
- Publicación del site en el servidor público de gvSIG.
Cómo añadir o actualizar una dependencia
Si vamos a añadir o actualizar una dependencia externa en un pom.xml en un proyecto de gvSIG, tendremos que hacer lo siguiente:
Primero, nos asegurarnos que la dependencia y la versión que nos interesa está ya disponible en algunos de los repositorios oficiales de maven. Para ello tenemos dos opciones:
- Realizar una búsqueda manual, mediante google o inspección directa de alguno de los repositorios alternativos de maven.
Si hemos encontrado la dependencia deseada, ya podemos modificar el pom.xml, pues ya sabemos que está disponible para todos.
Si no hemos encontrado la dependencia, habría que pedir al proyecto original que suban la dependencia al repositorio oficial de maven, proporcionándoles la información necesaria para ello para que les sea más sencillo:
Así, contribuiremos con la comunidad a facilitar el uso de la librería correspondiente a través de maven. En algún proyecto es posible incluso que nos propongan que nos encarguemos de actualizar nosotros el repositorio de maven con nuevas versiones de una librería.
Si desde el proyecto original no se quiere hacer o se tarda mucho, podemos subirla temporalmente al repositorio maven de gvSIG, quitándola cuando esté disponible en el repositorio oficial.
¿Cómo subir una libraría al repositorio maven de gvSIG?
Lo ideal sería que todas las librerías de las que depende un proyecto de gvSIG tuviesen un repositorio maven para poder descargarlas. Lamentablemente esto siempre no es así y a veces hay que subir una librería al repositorio maven de gvSIG.
En ese caso, para hacer pruebas lo primero que debemos hacer es incluir la dependencia en nuestro repositorio local de maven. Para ello usaremos el siguiente comando:
mvn deploy:deploy-file -Durl=REPO_URL -DrepositoryId=some.id -Dfile=your-artifact-1.0.jar [-DpomFile=your-pom.xml] [-DgroupId=org.some.group] [-DartifactId=your-artifact] [-Dversion=1.0] [-Dpackaging=jar] [-Dclassifier=test] [-DgeneratePom=true] [-DgeneratePom.description="My Project Description"] [-DrepositoryLayout=legacy] [-DuniqueVersion=false]
El comando admite muchas opciones, sobre las cuáles podemos encontrar más documentación en la web del proyecto maven, en el apartado del plugin deploy. Sin embargo, lo más habitual será emplear lo siguiente:
mvn deploy:deploy-file -DgroupId=$LIBRARY_GROUPID -DartifactId=$LIBRARY_ID -Dversion=$LIBRARY_VERSION [-Dclassifier=$LIBRARY_CLASSIFIER] -Dpackaging=jar -Dfile=$LIBRARY_JAR -Durl=$REPOSITORY_URL -DrepositoryId=gvsig-repository
Los valores de las variables (empiezan por $) deberemos sustituirlos por:
- LIBRARY_GROUPID:
- un valor típico suele ser el dominio principal del proyecto. Por ejemplo, para los proyectos gvSIG es org.gvsig, para los proyectos apache org.apache, etc.
- LIBRARY_ID:
- identificador o nombre de la librería. Suele ser un nombre único o bien un nombre con estilo de paquete java. En gvSIG los proyectos emplean este último formato (ej: org.gvsig.tools.lib).
- LIBRARY_VERSION:
- versión del jar que vamos a subir.
- LIBRARY_CLASSIFIER:
- para proyectos que generan varios jars, se emplea este valor para distinguir entre ellos. Un valor típico es tests, para el jar con los tests unitarios del proyecto. Es opcional y no suele ser necesario.
- LIBRARY_JAR:
- path absoluto al archivo .jar que vamos a subir, o bien relativo desde el directorio donde ejecutamos maven
- REPOSITORY_URL:
url del repositorio maven al que vamos a subir. En general usaremos dos opciones:
El repositorio local de maven: $USER_HOME/.m2/repository.
En este caso hay que tener en cuenta que la dependencia sólo estará disponible para nuestro usuario en local. Suele emplearse para pruebas antes de subir la dependencia al repositorio de gvSIG.
El repositorio maven de gvSIG: dav:https://devel.gvsig.org/m2repo/j2se
Una vez subido a este repositorio ya estará disponible para el resto de desarrolladores.
Note
Para que el deploy funcione se ha tenido que configurar previamente el fichero settings.xml tal y como se indica en el documento "Configuración inicial de maven" de la guía del desarrollador, apartado "Acceso de escritura al repositorio maven de gvSIG".
A modo de ejemplo, supongamos que tenemos un jar de la librería JEP en su versión 2.4.0 que queremos incluir como dependencia. La instrucción completa a emplear sería:
mvn deploy:deploy-file -DgroupId=org.nfunk \ -DartifactId=jep \ -Dversion=2.4.0 \ -Dpackaging=jar \ -Dfile=jep.jar \ -Durl=dav:https://devel.gvsig.org/m2repo/j2se \ -DrepositoryId=gvsig-repository