Configurar JasperReports en Spring 3.0

Cada vez es más sencillo realizar las configuraciones en Spring.  A pesar de que la configuración se puede seguir usando de diferentes maneras, en la documentación de referencia de spring 3 indica lo siguiente de forma general:

1. Agregar dependencias a tu proyecto
2. Configurar el ViewResolver
3. Crear el template con iReports
4. Configurar las vistas
5. Crear el controller

Ahora vamos a los detalles.

1. Las dependencias que nos dice debemos tener son las siguientes:

Obviamente el Jasper

        <dependency>
            <groupId>jasperreports</groupId>
            <artifactId>jasperreports</artifactId>
            <version>3.5.3</version>
        </dependency>

• BeanShell (esta no la ocupe)

• Commons BeanUtils (esta no la ocupe)

• Commons Collections (esta es requerida)

        <dependency>
            <groupId>commons-collections</groupId>
            <artifactId>commons-collections</artifactId>
            <version>3.2.1</version>
        </dependency>

• Commons Digester (esta no la ocupe)

• Commons Logging (esta es para logear, si ya usas otra, puedes omitirla)

• iText (esta es por si generas PDF pero yo no la ocupe)

• POI (esta es para generar archivox XLS)

        <dependency>
            <groupId>org.apache.poi</groupId>
            <artifactId>poi</artifactId>
            <version>3.2-FINAL</version>
        </dependency>

2. Configurar el ViewResolver via un properties

Antes ya lo había hecho mediante la clase de spring XmlViewResolver para configurar las vistas en un archivo xml (views.xml) pero me pareció más sencillo mediante un archivo properties y por eso difundo esta alternativa.

<bean id="viewResolver" class="org.springframework.web.servlet.view.ResourceBundleViewResolver">
<property name="basename" value="views"/>
</bean>

Se esta configurando una instancia de ResourceBundleViewResolver que busca por los mapeos de las vistas en un archivo properties con el nombre indicado por la propiedad basename, en este caso views.properties.  Donde colocarlo? en el classpath de la aplicación.

El contenido del archivo views.properties se explica en el punto 4.

3. Crear el Template con iReports (yo trabajé con la version 3.5.3)

Una cosa que se debe tomar en cuenta es que se debe usar la misma version de iReports que la que se esta usando en el jar como dependencia.

Descarga la aplicacion iReports desde la pagina.  Luego instalala y cuando la abras basta con que crees un proyecto en blanco. Este se guarda como un archivo .jrxml que básicamente es un xml plano.

Puedes encontrar un buen manual de uso de iReports aqui.

Cuando se compila un archivo jrxml, se genera otro con el mismo nombre .jasper, el cual es necesario indicar en la configuración de spring para que se genere el reporte en el formato deseado.

4. Configurar las vistas en el archivo properties.

El framework de spring contiene 5 diferentes implementaciones para crear reportes con Jasper, cuatro de ellas corresponden a formatos específios (csv, pdf, html y xls) y una que permite determinar una de las anteriores en tiempo de ejecución (JasperReportsMultiFormatView).

Para generar un reporte en pdf, por ejemplo, vamos usar el siguiente contenido en nuestro archivo views.properties:

reciboPago.(class)=org.springframework.web.servlet.view.jasperreports.JasperReportsPdfView
reciboPago.url=/WEB-INF/jasperTemplates/recibo.jasper
reciboPago.reportDataKey=reciboKey

El nombre de la vista es "reciboPago", su propiedad class define la clase de jasper que la mapea, en este caso es la clase que genera PDFs.  Es importante que esta propiedad esté configurada como .(class) y no .class debido a que spring busca este valor vía la propiedad y no usando el acostumbrado getter/setter.  De esta manera se entiende que si no usamos los paréntesis, spring lo interpreta como el hecho que debe usar el getter/setter de dicha propiedad para acceder a su valor.

La propiedad url se utiliza para definir la ruta de acceso al archivo compilado por el programa iReports, en este caso se esta colocando dentro de la carpeta WEB-INF de la aplicación.

Finalmente reportDataKey define el nombre llave para obtener de un mapa el POJO o DTO que contiene cada valor a mostrar en el reporte. En este caso, se le esta diciendo a spring que su fuente de datos se encuentra en la llave "reciboKey" del mapa a recibir (ver punto 5, sobre el controller).

5. Crear el controller.

Es sumamente sencillo generar un controller en spring mediante las anotaciones:

@Controller
@RequestMapping("/pago")
public class PagoController {
    @RequestMapping(value="/recibo", method=RequestMethod.GET)
    public String generarReciboPago(ModelMap modelMap, HttpServletResponse response) {
        List<ReciboDTO> lista = new ArrayList<ReciboDTO>(1);
        ReciboPagoJasperDTO dto = new ReciboDTO();
        dto.setMonto("6789.0");
        dto.setNombre("Pedro Romero");
        lista.add(dto);
        response.setHeader("Content-type", "application/pdf");
        response.setHeader("Content-Disposition","attachment; filename=\"recibo.pdf\"");
        JRBeanCollectionDataSource jrbean = new JRBeanCollectionDataSource(lista, false);
        modelMap.put("reciboKey", jrbean);
        return("reciboPago");
    }
}

@Controller define a la clase como un controller y @RequestMapping define una uri desde la cual se puede acceder a nuestro controller cuando nuesta aplicación ya está montada en un server.  Si la aplicacion levanta en un contexto "proyecto" y el servidor levanta en un puerto local 8080, podriamos acceder a nuestro controller anterior como: "http://localhost:8080/proyecto/pago/recibo", aunque esto es asunto de otro tema, basta con observar como se concatenan los valores del contexto de la aplicación, y de las anotaciones @RequestMapping de clase y método usado.  

En este caso ReciboDTO es el pojo usado para portar los valores que alimentaran el reporte, se inserta en una instancia de JRBeanCollectionDataSource y luego se agrega al mapa del modelo con el key: reciboKey (observa que es el mismo metodo que usamos en el properties.

Finalmente se devuelve una cadena que indica el nombre de la vista configurada en el properties, la cual esta mapeada a la clase jasper: JasperReportsPdfView.

Notas importantes:

Spring nos provee de la capacidad de agregar elementos dentro de una Collection, dado que internamente Spring los envuelve dentro de un objeto JRBeanCollecionDataSource (implementa interface JRDataSource), también nos da la capacidad de agregar mas beans al modelo en diferentes llaves del mapa, ejemplo:

modelMap.put("reciboKey", jrbean);
modelMap.put("myKey1", jrbean1);
modelMap.put("personal2", jrbean2);

El punto está en que si la vista no esta apuntando a uno de estas llaves en particular (mediante la propiedad de la vista: reportDataKey), usará la primera instancia de JRDataSource que encuentre.