Empaquetamiento de aplicaciones de escritorio (standalone) con Maven

Introducción

Actualmente he tenido la necesidad de empaquetar una aplicación de escritorio construida con Maven y me he dado cuenta de que ninguna de las alternativas de empaquetamiento que este me ofrece era la que se ajustaba a mis necesidades.

Más concretamente, lo que no se ajustaba a mis necesidades es el modo en que Maven coloca las dependencias de tu proyecto a la hora de crear el paquete a distribuir.
Maven, mete todos los .class de las dependencias de tu proyecto dentro del propio Jar de tu aplicación. (assembly jar-with-dependencies).

Que queréis que os diga, a mi eso no me gusta. Prefiero tener mi jar (con el método main) por un lado con el MANIFEST modificado de tal forma que haga referencia los jars que necesita para ejecutarse.

Más concretamente, me gusta tener un directorio dist en donde dentro está mi jar (con el método main) y las dependencias en un directorio dist/lib.

Pues bien, en este ejemplo vamos a ver como conseguir ese método, siendo fácilmente adaptable a otro tipo de necesidades que tengáis.

Ejemplo, Aplicación básica de escritorio con dependencias:

A continuación vamos a ver como conseguir lo anteriormente expuesto, para ello nuestra aplicación de escritorio será muy básica y tendrá dos dependencias.

Eso si, el esfuerzo para una aplicación con miles de clases y decenas dependencias sería practicamente igual.. quizás sería necesario algún pequeño reajuste, pero vamos poco más.

El código fuente de este tutorial puede ser descargado desde aquí (proyecto Eclipse con Maven 2).

Entorno

El siguiente ejemplo está construido en el siguiente entorno:

• HP Pavilion.
• Windows Vista Home Premium.
• Eclipse Ganymede.
• Java 6.
• Maven 2.
• Plugin Maven 4QE para Eclipse.

Mi aplicación de escritorio con su bonito método main:

Está autocomentada, pero bueno, resalto que usa las librerías commons-lang y commons-io de Apache.

package com.autentia.tutoriales.maven.standalone;

import java.io.File;
import org.apache.commons.lang.WordUtils;
import org.apache.commons.io.FileUtils;

public class MavenStandaloneExample {
	/**
	 * Dado un archivo de texto imprime su contenido capitalizado, es decir, la primera letra de 
	 * cada palabra en mayúsculas.
	 * @param args Un sólo parámetro con la ruta completa al archivo de texto a capitalizar.
	 */
	public static void main(String[] args) {
		try {
			File	 file   = new File(args[0]);
			String fileContent = FileUtils.readFileToString(file);
			
			System.out.println(WordUtils.capitalizeFully(fileContent));
		} catch (java.lang.ArrayIndexOutOfBoundsException ex){
			System.out.println("Debe especificar el nombre de un archivo");
		} catch (java.io.IOException ex){
			System.out.println("Se ha producido un error al tratar el archivo especificado.");
			System.out.println("Verique que exista y que tenga permisos de lectura.");
		}
	}
}

Archivo de configuración de Maven 2: pom.xml:

A continuación exponemos el archivo de configuración de Maven, se presupone que el lector ya tiene nociones de Maven.

	4.0.0
	com.autentia.tutoriales
	maven_standalone_app_example
	jar
	1.0-SNAPSHOT
	maven_standalone_app_example
	http://www.adictosaltrabajo.com

	
		
		mavenStandaloneExample

		
			
			
				maven-compiler-plugin
				
					1.5
					1.5
					UTF-8
				
			

			
			
				org.apache.maven.plugins
				maven-jar-plugin
				
					
						
							
							com.autentia.tutoriales.maven.standalone.MavenStandaloneExample

							
							true

							
							lib
						

						
						
							Carlos García Pérez
							Autentia Real Business Solutions
							http://www.autentia.com
						
					
				
			

			
			
				org.apache.maven.plugins
				maven-assembly-plugin
				
					
						maven_assembly_conf.xml
					
				
				
				
					
						package
						
							single
						
					
				
			
		
	

	
		
			commons-lang
			commons-lang
			2.3
		

		
			commons-io
			commons-io
			1.4
		
	

Archivo de configuración del assembly (maven_assembly_conf.xml):

El archivo está autocomentado.

	
	standaloneapp-dist-format

	
	
		
		dir
	

	
	../../dist

	
		
		
			target
			.
			
				*.jar
			
		
	

	
		
			
			lib

			
			false

			
			runtime

			
			
				${groupId}:${artifactId}
			
		
	

El archivo /META-INF/MANIFEST generado:

Si abrimos el JAR veremos que nos ha generado el siguiente archivo MANIFEST:

Manifest-Version: 1.0
Archiver-Version: Plexus Archiver
Created-By: Apache Maven
Built-By: cgarcia
Build-Jdk: 1.6.0_11
Main-Class: com.autentia.tutoriales.maven.standalone.MavenStandaloneExample
Autor: Carlos García Pérez
Empresa: Autentia Real Business Solutions
url: http://www.autentia.com
Class-Path: lib/commons-lang-2.3.jar lib/commons-io-1.4.jar

Invocando la aplicación:

Y para terminar, vamos a ver como ejecutariamos la aplicación anterior:

java -jar mavenStandaloneExample.jar <Ruta completa a un archivo de texto>

Referencias

• http://maven.apache.org/plugins/maven-jar-plugin/
• http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html

Conclusiones

Si os gusta mi forma de organizar el proyecto teneis un esqueleto fácilmente adaptable a vuestras necesidades.

En Autentia llevamos años trabajando con Maven para gestionar nuestros proyectos, si algún día necesitais ayuda o formación al respecto espero nos tengáis en cuenta.

Un saludo, espero que os haya parecido útil este tutorial.

Carlos García Pérez. Creador de MobileTest, un complemento educativo para los profesores y sus alumnos.

cgpcosmad@gmail.com