Crysfel’s Blog

En estos últimos días he estado jugando un poco con JasperReports, y de verdad que es muy sencillo hacer reportes, lo más dificultoso, es el encontrar documentación, los ejemplos que hay en Internet no están muy claros, y no abarcan todo lo que uno necesita saber, es por eso que me dediqué a realizar una búsqueda exhaustiva con respecto al tema.

En esta entrada, voy a explicar los conceptos básicos para hacer reportes, no voy a profundizar en todas las opciones, pretendo hacerlo más adelante, quiero presentar a grandes rasgos el proceso para generar un reporte en pdf.

Para comenzar es necesario descargar la última versión de esta herramienta, directamente desde la página del proyecto http://www.jasperforge.org/ para poder descargar es necesario registrarse en el sitio, así que regístrate rápidamente, luego en la página principal encontrarás varios proyectos, el primero de la lista es JasperReports, da clic sobre el link que dice downloads, descarga la última versión (1.3.4 es la actual), luego de esto aparecen archivos, algunos JARS, y un zip, el que tienes que descargar es el *-proyect.zip, de aproximadamente 35 MG.

Una vez que termine la descarga, descomprime el archivo, aquí hay varias carpetas, la que nos interesa es la que dice lib y dist, de la carpeta dist, sacamos el jar de jasperReport, creas un proyecto nuevo, en eclipse, netbeans, etc. creas una carpeta lib en tu nuevo proyecto, y pegas el jar, ahora copia los siguientes jars de la carpeta lib de jasperReports a la carpeta lib de tu proyecto.

bsh-1.x.x.jar
itext-1.x.x.jar
commons-digester.jar
commons-collections.jar
commons-login-1.x.x.jar
commons-beanutils.jar
commons-javaflow-20060411.jar

Es de suma importancia que copies todas estas librerías, y las agregues al classpath, de lo contrario el compilador te marcará errores pidiendo las librerías.

Una vez ya tengas en el classpath todas las librerías, vamos a crear nuestro primer reporte, uno muy sencillo, todavía no voy a mostrar como pasarle datos ni parámetros, el ejemplo de hoy solo imprimirá el hola mundo.

Para crear reportes el procedimiento es el siguiente, primero necesitas diseñar el reporte, esto lo haces con XML, es muy sencillo pues es semejante a diseñar una página XHTML, funciona manera semejante, una vez tengas listo el diseño del reporte lo guardas con extensión .jrxml, después necesitas compilar el XML y generar un archivo *.jasper, la compilación se hace una sola vez, luego ya que tienes el fichero.jasper, este lo cargas a memoria y le mandas los parámetros e información que quieres desplegar (Si es necesario), lo exportas al formato deseado y lo escribes en el disco.

Pues bien, eso es todo el procedimiento, sencillo no? la verdad es que en unas pocas líneas de código Java, haces todo el proceso. Una vez teniendo en mente el procedimiento completo, comencemos con el primer paso, el cual es diseñar el reporte en XML. Primero creamos un archivo llamado primerReporte.jrxml, luego escribes el siguiente código.

Esta es la cabecera del documento, aquí no hay mucho que explicar, simplemente que todos los reportes que diseñemos tienen que llevar esta cabecera.

Este es el nodo principal del documento y es obligatorio, dentro de este va toda la información que queramos desplegar, dividido en las siguiente secciones.

<background> - En esta seccion se puede poner cualquier cosa que quieras que aparesca por debajo de todas las otras seccion, esta sección es el fondo del documento.
<title> - El contenido de esta sección será impreso solo una vez al principio del reporte, como su nombre lo dice es el título que el reporte tendrá.
<pageHeader> - Esta sección será impresa en cada página que el reporte contenga, es la cabecera del reporte.
<columnHeader> - Esta sección se utiliza para poner la cabecera de la sección “detail”, en otras palabras el titulo de la información desplegada en el “detail”.
<detail> - En esta sección es donde se colocan la información a desplegar del reporte, es el cuerpo principal del reporte, generalmente en esta sección se despliegan tablas.
<pageFooter> - Esta sección el pie de página y es impresa al final de cada página del reporte, aquí puedes poner el número de página o alguna otra información.

Dentro de estas secciones es que se ponen etiquetas estáticas, dinámicas, líneas, imágenes, etc. es importante mencionar que todas estas secciones contienen la etiqueta <band>, que es donde la información está contenida, es obligatoria solo cuando necesitas ponerle contenidos a cualquiera de las cuatro secciones anteriores.

Suficiente teoría por ahora, es hora de seguir diseñando el reporte, para este caso dije que sólo imprimiría “Hola mundo” en el reporte, así que sólo voy a ocupar la sección detail, poner un texto estático especificándole las medidas y posición donde estará, el código final quedará así.

Aquí no hay mucho que comentar, excepto que el band debe tener especificado el alto que será, en este caso 20 (Las medidas son en píxeles), y que los objetos que contenga dentro de este, no deben superar esta medida, de lo contrario el compilador nos marcará un error, hasta este punto solo esta imprimiendo un texto estático, puedes hacer pruebas agregándole más textos y posicionándoles en lugares diferentes, no olvides que el height de los objetos, no deben superar los 20px que declaramos al band.

Una vez esta listo el diseño del reporte y guardado como primerReporte.jrxml es necesario crear una clase que continué con el procedimiento, el código de dicha clase es el siguiente.

Como puedes ver, el procedimiento es muy sencillo, primero compilamos el jrxml, para aplicaciones reales, esto lo haces solo una vez, y generas un archivo jasper, en esta ocasión no lo estoy generando, eso lo explicaré mas a detalle en futuras entradas, por ahora en el paso 1 se compila y se mantiene en memoria, en el paso 2 se le pasan tres parámetros a la función fillReport, el cual es el reporte, un HashMap con los parámetros y no se le pasa información, por ahora no le estamos pasando nada, en futuras entradas hablaré al respecto, este es solo una introducción, por último, en el paso 3 se exporta a pdf y se guarda en disco como holaMundo.pdf.

Solo basta correr la aplicación y ver los resultados, si has seguido los pasos al pie de la letra, no tendrás errores, al compilar el jrxml tarda un poco, pero es normal, es por eso que repito otra vez, que solo se hace una sola vez y se guarda el archivo compilado con extensión .jasper, en este caso no lo hacemos, pero sigue pendiente en este blog pues hablaré al respecto en un futuro no muy lejano.

Update 17 Enero 2008
Para facilitar el tutorial, ahora voy a proporcionar el código fuente para que lo puedas ver funcionando, es un proyecto configurado para eclipse.