Reportes dinámicos con PrimeFaces y JasperReports [Java]

Qué tal, bienvenido a esta nueva publicación, el día de hoy les mostraré como crear reportes dinámicos con Primefaces y JasperReports.

La historia comienza con una necesidad que tenía para mis proyectos de aplicación web, en los cuales tenía que mostrar reportes en ciertas secciones de una pantalla que constantemente cambiarían de información, es decir dependían de ciertos valores para su generación.

La idea inicial era que pudiera ser capaz de mostrar un pdf que a lo largo del ciclo de vida de la aplicación siempre estaría cambiando de forma, por lo que se me vino a la cabeza que podía generar un archivo .pdf y después mostrarlo en pantalla, pero, ¿cómo podría hacer esto?.

Después de investigar un poco me di cuenta que PrimeFaces nos proporciona un componente para mostrar todo tipo de contenidos entre estos un pdf, hablo del Componente Media que hablando en términos más técnicos de programación hace uso de un objeto StreamedContent para renderizar contenidos.

Ahora, la idea había evolucionado, si con el método exportReportToPdfStream de JasperExportManager puedo guardar el pdf generado en un OutputStream entonces este lo podría utilizar para crear un StreamedContent y aquí la prueba:

Country.java
package mx.edu.itshuatusco.model; import java.io.Serializable; /** * * @author Jesús Alberto Sánchez Tecalco */ public class Country implements Serializable { private String id; private String name; public Country() { } public Country(String id, String name) { this.id = id; this.name = name; } public String getId() { return id; } public void setId(String id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } }

Esta es la clase que utilizaré para mantener la información del reporte, el archivo .jasper ya te imaginarás que el diseño solo consta de 2 columnas id y name.

report.xhtml <p:panel header="Reporte Test"> <h:form id="frm-home"> <h:panelGrid columns="2"> <h:outputText value="Filtro 1" /> <p:inputText value="#{reportBean.number}"/> <p:commandButton value="Generar Reporte" update="@form" actionListener="#{reportBean.generateReport}" /> <p:commandButton value="Descargar" rendered="#{reportBean.media ne null}" ajax="false" actionListener="#{reportBean.downloadFile}" /> </h:panelGrid> <div class="column-center"> <p:media cache="false" rendered="#{reportBean.media ne null}" width="900" height="600" value="#{reportBean.media}" player="pdf"/> </div> </h:form> </p:panel>

Lo siento, solo mostraré lo necesario de este archivo, se conforma de un formulario que contiene un inputText, un commandButton que llama al método generateReport, el commandButton Descargar que llama al método downloadFile, el componente Media y algunas condiciones de renderizado.

Nota: el componente media debe tener en false la propiedad cache, de otra forma te dará un buen dolor de cabeza.

JasperReportUtil.java
package mx.edu.itshuatusco.controller.util; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.InputStream; import java.util.List; import java.util.Map; import net.sf.jasperreports.engine.JasperExportManager; import net.sf.jasperreports.engine.JasperFillManager; import net.sf.jasperreports.engine.JasperPrint; import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource; import org.primefaces.model.DefaultStreamedContent; import org.primefaces.model.StreamedContent; /** * * @author Jesús Alberto Sánchez Tecalco */ public class JasperReportUtil { public static ByteArrayOutputStream getOutputStreamFromReport(List list, Map map, String pathJasper) throws Exception { ByteArrayOutputStream os = new ByteArrayOutputStream(); JRBeanCollectionDataSource dataSource = new JRBeanCollectionDataSource(list); JasperPrint jp = JasperFillManager.fillReport(pathJasper, map, dataSource); JasperExportManager.exportReportToPdfStream(jp, os); os.flush(); os.close(); return os; } public static StreamedContent getStreamContentFromOutputStream(ByteArrayOutputStream os, String contentType, String nameFile) throws Exception { StreamedContent file = null; InputStream is = new ByteArrayInputStream(os.toByteArray()); file = new DefaultStreamedContent(is, contentType, nameFile); return file; } public static StreamedContent getStreamContentReport(List list, Map map, String pathJasper, String nameFilePdf) throws Exception { StreamedContent pdf = null; JRBeanCollectionDataSource dataSource = new JRBeanCollectionDataSource(list); JasperPrint jp = JasperFillManager.fillReport(pathJasper, map, dataSource); ByteArrayOutputStream os = new ByteArrayOutputStream(); JasperExportManager.exportReportToPdfStream(jp, os); os.flush(); os.close(); InputStream is = new ByteArrayInputStream(os.toByteArray()); pdf = new DefaultStreamedContent(is, "application/pdf", nameFilePdf); return pdf; } }

La clase de utilería JasperReportUtil contiene 3 métodos:

• getOutputStreamFromReport que retorna un ByteArrayOutputStream a partir de la lista de elementos que deseas renderizar en tu reporte, algún mapa con parámetros y el path del archivo .jasper,
• getStreamContentFromOutputStream que retorna un StreamedContent a partir de un objeto ByteArrayOutputStream, una cadena con el tipo de contenido a generar y el nombre del archivo. 
• getStreamContentReport este método es el camino corto (fusiona los 2 métodos anteriores [lo pensaba utilizar en un caso especial, no necesito explicarlo]).

ReportTestController.java

/* * To change this license header, choose License Headers in Project Properties. * To change this template file, choose Tools | Templates * and open the template in the editor. */ package com.arsis.corp.controller; import mx.edu.itshuatusco.controller.util.JasperReportUtil; import mx.edu.itshuatusco.model.Country; import java.io.ByteArrayOutputStream; import java.io.OutputStream; import java.io.Serializable; import java.util.ArrayList; import java.util.Calendar; import java.util.HashMap; import java.util.List; import java.util.Map; import javax.enterprise.context.SessionScoped; import javax.faces.context.FacesContext; import javax.inject.Named; import javax.servlet.http.HttpServletResponse; import org.primefaces.model.StreamedContent; import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** * * @author Jesús Alberto Sánchez Tecalco */ @SessionScoped @Named(value = "reportBean") public class ReportTestController implements Serializable { private static final Logger log = LoggerFactory.getLogger(ReportTestController.class); private StreamedContent media; private ByteArrayOutputStream outputStream; private String number; public void generateReport() { try { List<country> countries = getListCountriesDummy(); Map<String, Object> map = new HashMap<String, Object>(); map.put("fecha", Calendar.getInstance().getTime().toString()); outputStream = JasperReportUtil.getOutputStreamFromReport(countries, map, getPathFileJasper()); media = JasperReportUtil.getStreamContentFromOutputStream(outputStream, "application/pdf", getNameFilePdf()); } catch (Exception e) { log.error(e.getMessage(), e); } } public String getPathFileJasper() { return getFullPathResource("/report/paises.jasper"); } public String getNameFilePdf() { return "reporte_dummy.pdf"; } public void downloadFile() { try { FacesContext facesContext = FacesContext.getCurrentInstance(); HttpServletResponse response = (HttpServletResponse) facesContext.getExternalContext().getResponse(); response.reset(); response.setContentType("application/pdf"); response.setHeader("Content-disposition", "attachment; filename=" + getNameFilePdf()); OutputStream output = response.getOutputStream(); output.write(outputStream.toByteArray()); output.close(); facesContext.responseComplete(); } catch (Exception e) { log.error(e.getMessage(), e); } } private List<country> getListCountriesDummy() { List<country> countries = new ArrayList<country>(); int max = Integer.parseInt(number); for (int i = 1; i <= max; i++) { countries.add(new Country("ID" + i, "Pais " + i)); } return countries; } public StreamedContent getMedia() { return media; } public void setMedia(StreamedContent media) { this.media = media; } public String getNumber() { return number; } public void setNumber(String number) { this.number = number; } }

De esta clase seré breve, los 2 métodos que se llaman son generateReport y downloadFile.

El primero genera datos dummys y haciendo uso de la clase de utilería antes mencionada genera el StreamedContent  para que el componente media lo utilice y muestre el pdf.

El segundo método permite descargar el archivo pdf, observar que PrimeFaces ya provee un componente para descargar pero si intentas guardar el pdf o utilizar el componente FileDownload el archivo se descargar corrupto, desconozco la razón.

Una captura de lo que obtienes: