JasperReport: criando um Helper para gerar Relatório

Neste artigo veremos como construir uma classe gen�rica o suficiente para gerar relat�rios baseados no JasperReport em Java. Nossa classe ser� capaz de gerar um relat�rio em formato PDF atrav�s dos par�metros passados, tornando a tarefa simples e eficaz em qualquer parte do sistema.

Trabalharemos neste artigo com o ambiente totalmente web e partiremos do princ�pio que estamos trabalhando com um servidor que n�o possui um ambiente gr�fico, sendo assim, n�o podemos contar com recursos como o JasperView. A nossa l�gica ser� gerar o PDF no lado do servidor (Server-side) e apenas disponibilizar o mesmo para que o usu�rio possa baixar atrav�s do seu browser de prefer�ncia.

Usaremos JSF 2.0 e Primefaces para disponibilizar os recursos no lado do cliente e os relat�rios j� est�o prontos, pois n�o � foco deste artigo mostrar como constru�-los. Independente da ferramenta que voc� utilizar, o resultado final sempre ser� um �.jasper� que � o arquivo lido pelo JasperReport. No iReport, por exemplo, � gerado um �.jrxml� que cont�m todo o layout para que o iReport leia, e quando compilado, torna-se um �.jasper�. � muito importante que a diferen�a entre o JasperReport e as ferramentas que criam relat�rios fiquem bem definidas.

Importando as librarys necess�rias

Como gerenciador de depend�ncias estamos utilizando o Maven. Vamos mostrar quais as depend�ncias necess�rias para funcionamento correto do JasperReport e para isso elas devem estar no seu arquivo pom.xml. Observe a Listagem 1.


<!-- JASPER REPORT IMPORTS -->

   <dependency>
          <groupId>net.sourceforge.barbecue</groupId>
          <artifactId>barbecue</artifactId>
          <version>1.5-beta1</version>
   </dependency>


   <dependency>
          <groupId>net.sf.jasperreports</groupId>
          <artifactId>jasperreports</artifactId>
          <version>5.0.1</version>
   </dependency>

   <dependency>
          <groupId>net.sf.jasperreports</groupId>
          <artifactId>jasperreports-fonts</artifactId>
          <version>4.0.0</version>
   </dependency>

   <dependency>
          <groupId>xml-apis</groupId>
          <artifactId>xml-apis</artifactId>
          <version>1.4.01</version>
   </dependency>
   <dependency>
          <groupId>xerces</groupId>
          <artifactId>xercesImpl</artifactId>
          <version>2.10.0</version>
   </dependency>

   <!-- FIM JASPER RESPORT IMPORTS -->

Listagem 1. Depend�ncias inclusas no pom.xml

Constru��o da classe ReportHelper

Ap�s os imports necess�rios serem adicionados no nosso pom.xml, iremos come�ar a construir nossa classe gen�rica, que chamaremos de ReportHelper, pelo fato de ser um auxiliar na gera��o de nosso relat�rio. Precisamos antes entender alguns pontos importantes:

Em nosso caso, os relat�rios (.jasper) ficar�o sempre dentro do diret�rio �WEB-INF/report�. Ser� esse o caminho padr�o que utilizaremos ao gerar um relat�rio.
Em nosso arquivo web.xml criamos um �context-param� que ir� armazenar o diret�rio onde os relat�rios gerados ser�o armazenados, ou seja, onde os nossos �.pdf� ser�o armazenados para download ap�s gera��o do mesmo. Veja como ficou nosso web.xml na Listagem 2.
```
  <context-param>
    <param-name>reportDirectory</param-name>
    <param-value>${user.home}/meuprojeto/report/</param-value>
  </context-param>
```
Listagem 2. Context-param no web.xml
Em nosso caso utilizamos o ${user.home}, mas fique a vontade para mudar o caminho se sentir necessidade.
Toda vez que um relat�rio for gerado em PDF, optamos por criar um arquivo com um nome diferente, ex: pdf1,pdf2 e assim por diante. Desta forma, mantemos um hist�rico de tudo que foi gerado para futuras auditorias. Poder�amos, por exemplo, gerar um arquivo gen�rico chamado �report.pdf� e toda vez que um novo relat�rio for gerado ele ir� sobrescrever o antigo, mas como j� dissemos, queremos manter um hist�rico de relat�rios gerados, mesmo que isso exija mais espa�o em disco do nosso servidor. Para criamos um m�todo bem simples que retorna um ID �nico para nomear nosso PDF, usaremos o c�digo da Listagem 3.
```
  private static String gerarIdReport() {
     SimpleDateFormat simpleDateFormat = new SimpleDateFormat(
             "ddMMyyyyhhmmss");
     String id = simpleDateFormat.format(new Date());
    
     return id;
  }
```
Listagem 3. Gerador de ID para nosso PDF

Perceba que nosso m�todo retorna um ID baseado na data,hora,minuto e segundo atual. Garantimos assim que o nome dos relat�rios n�o ir�o se repetir.

Vamos ver agora o m�todo respons�vel por gerar o relat�rio (salvando no diret�rio definido no context-param do web.xml). Toda nossa classe da Listagem 4 est� comentada para ajudar a entender o funcionamento da mesma.


/*
 * Explica��o dos par�metros
 * String relatorio = Nome do relat�rio em formato .jasper, 
 * que ser� encontrado do diret�rio WEB-INF/report
 * List<? extends AbstractBean> beans = Lista de Beans que ser�o mostrados 
 * no relat�rio, ou seja, todo filtro j� foi feito
 * pela nossa aplica��o, apenas mostraremos os beans que foram passados pelo relat�rio.
 * Map<String, Object> params = Par�metros que ser�o usados em nosso relat�rio
 * Usuario usuario = Usu�rio que gerou o relat�rio, assim podemos imprimir 
 * no relat�rio que foi o respons�vel por gerar este relat�rio
 * boolean showHeaderAndFooter = Em nosso relat�rio temos a op��o de mostrar
 * ou n�o o cabe�alho e o rodap�. Quando o usu�rio
 * precisar aproveitar todo o espa�o do papel e desejar remover o cabe�alho
 * e rodap� que cont�m informa��es sobre a empresa,
 * ele dever� passar o valor "false" para este par�metro.
 * */
public static String gerarRelatorio(String relatorio,
       List<? extends AbstractBean> beans, Map<String, Object> params, 
       Usuario usuario, boolean showHeaderAndFooter) {
   try {

       //Capturamos o valor do context-param reportDirectory, 
      //que est� no web.xml
       String reportExportPath = FacesContext.getCurrentInstance().getExternalContext()
             .getInitParameter("reportDirectory");

       //Capturamos o caminho real de WEB-INF/report, para que possamos 
       //ler o relat�rio .jasper
       String pathRelatorio = FacesContext.getCurrentInstance()
             .getExternalContext().getRealPath("/WEB-INF/report/")
             + "/";

       if (params == null) {
         params = new HashMap<String, Object>();
       }
       
       //Temos aqui uma lista de par�metros que utilizamos em nosso relat�rio, 
       //se voc� tiver mais par�metros
       //basta adicion�-los nesta se��o
       params.put("endereco", Codigos.ENDERECO);
       params.put("razaoSocial", Codigos.RAZAO_SOCIAL);
       params.put("cidade", Codigos.CIDADE);
       params.put("estado", Codigos.ESTADO);
       params.put("cep", Codigos.CEP);
       params.put("pathLogomarca", pathRelatorio + "logo.jpg");
       params.put("pathSubreport", pathRelatorio);
       params.put("usuario", usuario.getLogin());
       params.put("base", usuario.getBase().getPessoaJuridica().getNome());
       params.put("showHeaderAndFooter", showHeaderAndFooter);
       
       //Criamos nosso DataSource baseado nos beans passados via par�metro
       JRBeanCollectionDataSource beanCollectionDataSource = 
         new JRBeanCollectionDataSource(beans);

       //Verificamos que o nome do relat�rio passado possui ou 
       //n�o o .jasper no fim, se n�o tiver
       //adicionamos o .jasper ao fim do nome, garantindo uma leitura correta.
       String relatorioFormated = relatorio.endsWith(".jasper") ? relatorio
             : (new StringBuilder()).append(relatorio).append(".jasper")
                     .toString();

       //Iniciamos a gera��o do relat�rio atrav�s do m�todo 
       //"fillReport" passando o nome do relat�rio .jasper,
       //os par�metros e a cole��o de beans, o restante � por conta do JasperReport
       net.sf.jasperreports.engine.JasperPrint jasperPrint = JasperFillManager
             .fillReport(pathRelatorio + relatorioFormated, params,
                     beanCollectionDataSource);

       //Preparamos o novo nome do nosso PDF
       String pdfFileName = reportExportPath + relatorio +"_"+ gerarIdReport() + ".pdf";
       
       //Come�amos a exportar o relat�rio armazeando na vari�vel jasperPrint
       // para o formato PDF
       JRExporter exporter = new JRPdfExporter();
       exporter.setParameter(JRExporterParameter.JASPER_PRINT, jasperPrint);
       exporter.setParameter(JRExporterParameter.OUTPUT_STREAM, 
        new FileOutputStream(pdfFileName));
       exporter.exportReport();

       return pdfFileName;
   } catch (JRException e) {
       e.printStackTrace();
       return null;
   } catch (IOException e) {
       // TODO Auto-generated catch block
       e.printStackTrace();
       return null;
   }
}

Listagem 4. M�todo para gerar relat�rio

O m�todo acima retorna uma String que cont�m nome do PDF gerado, assim podemos disponibiliz�-lo para download em nosso XHTML atrav�s do JSF. Utilizando o JSF + Primefaces podemos disponibilizar o download de nosso relat�rio usando o recurso da Listagem 5.


<p:commandButton id="downloadReport" value="Download"
     disabled="#{geradorRelatorioMB.reportDownload == null}"
     ajax="false" icon="ui-icon-arrowthichk-s" immediate="true">
     <p:fileDownload value="#{geradorRelatorioMB.reportDownload}" />
</p:commandButton>

Listagem 5. Primefaces fileDownload

Atrav�s de um ManagedBean chamado �GeradorRelatorioMB� conseguimos capturar o relat�rio. Veja o getReportDownload() da Listagem 6.


public StreamedContent getReportDownload() {
     if (relatorioGeradoPath == null)
         return null;
     else
         return ReportHelper.convertStringToStreamedContent(relatorioGeradoPath);
  }

Listagem 6. M�todo getReportDownload()

Perceba que atrav�s do relat�rio gerado em formato PDF, que est� no caminho �relatorioGeradoPath�, devemos converter para um �StreamedContent� para que o componente fileDownload consiga �ler�. Veja na Listagem 7 nosso m�todo de convers�o.


public static StreamedContent convertStringToStreamedContent(String pathRelatorio) {
     InputStream inputStream = null;
     try {
         File file = new File(pathRelatorio);           
         inputStream = new FileInputStream(file);

         return new DefaultStreamedContent(inputStream, "application/pdf", file.getName());

     } catch (FileNotFoundException e) {
         // TODO Auto-generated catch block
         e.printStackTrace();
         return null;
     }
  }

Listagem 7. Conversor de String para StreamedContent

Vamos agora entender como o mecanismo funciona, passo a passo:

O usu�rio solicita a gera��o do relat�rio atrav�s do m�todo �gerarRelat�rio()� mostrado na Listagem 4.
O relat�rio � gerado em formato PDF e armazenado no diret�rio especificado atrav�s do context-param do web.xml. Suponha que seja algo como �protocolo16022014232545.pdf�
Agora precisamos disponibilizar para download o arquivo acima, e para isso usamos o componente fileDownload do Primefaces. O problema � que este componente s� aceita um objeto do tipo StreamedContent, sendo assim, criamos um m�todo chamado �convertStringToStreamedContent� que recebe o caminho do PDF no servidor e retorna um StreamedContent.

Veja na Listagem 8 um exemplo do uso do m�todo gerarRelatorio() em um ManagedBean.


public void gerarProtocolos() {
   try {
       List<Protocolo> protocolos = new ArrayList<Protocolo>();

       for (int i = 0; i < 100; i++) {         
         protocolos.add(buscarProtocoloNaBase(i));
       }

       relatorioGeradoPath = ReportHelper.gerarRelatorio("protocolo", protocolos,
             new NamedParams("titulo", "Protocolo AR10",
             usuarioLogadoMB.getUsuarioLogado(), showHeaderAndFooter);
   } catch (BOException e) {
       addErrorMessage(e.getMessage());
       FacesContext.getCurrentInstance().validationFailed();
   }
}

Listagem 8. Exemplo de uso do m�todo gerarRelatorio()

No exemplo acima geramos um relat�rio e o valor retornado � salvo na vari�vel �relatorioGeradoPath�, assim podemos usar essa vari�vel para converter para um StreamedContent e disponibilizar atrav�s do fileDownload do primefaces.

Para voc� que sentiu-se um pouco perdido com todas listagens para constru��o de um Helper, na Listagem 9 disponibilizamos o Helper completo ap�s todas as explica��es acima.


package br.com.meuprojeto.helper;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.faces.context.FacesContext;

import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JRExporter;
import net.sf.jasperreports.engine.JRExporterParameter;
import net.sf.jasperreports.engine.JasperFillManager;
import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource;
import net.sf.jasperreports.engine.export.JRPdfExporter;

import org.primefaces.model.DefaultStreamedContent;
import org.primefaces.model.StreamedContent;

import br.com.meuprojeto.bean.AbstractBean;
import br.com.meuprojeto.security.bean.Usuario;
import br.com.meuprojeto.util.Codigos;

public class ReportHelper {

  private static String gerarIdReport() {
       SimpleDateFormat simpleDateFormat = new SimpleDateFormat(
               "ddMMyyyyhhmmss");
       String id = simpleDateFormat.format(new Date());
       
       return id;
  }

  public static StreamedContent convertStringToStreamedContent(String pathRelatorio) {
       InputStream inputStream = null;
       try {
           File file = new File(pathRelatorio);           
           inputStream = new FileInputStream(file);

           return new DefaultStreamedContent(inputStream, "application/pdf", 
            file.getName());

       } catch (FileNotFoundException e) {
           // TODO Auto-generated catch block
           e.printStackTrace();
           return null;
       }
  }

  // Gera relatorio retornando o caminho do PDF gerado para download
  public static String gerarRelatorio(String relatorio,
           List<? extends AbstractBean> beans, Map<String, Object> params,
             Usuario usuario, boolean showHeaderAndFooter) {
       try {

           String reportExportPath = FacesContext.getCurrentInstance().getExternalContext()
                     .getInitParameter("reportDirectory");

           String pathRelatorio = FacesContext.getCurrentInstance()
                     .getExternalContext().getRealPath("/WEB-INF/report/")
                     + "/";

           if (params == null) {
                 params = new HashMap<String, Object>();
           }

           params.put("endereco", Codigos.ENDERECO);
           params.put("razaoSocial", Codigos.RAZAO_SOCIAL);
           params.put("cidade", Codigos.CIDADE);
           params.put("estado", Codigos.ESTADO);
           params.put("cep", Codigos.CEP);
           params.put("pathLogomarca", pathRelatorio + "logo.jpg");
           params.put("pathSubreport", pathRelatorio);
           params.put("usuario", usuario.getLogin());
           params.put("base", usuario.getBase().getPessoaJuridica().getNome());
           params.put("showHeaderAndFooter", showHeaderAndFooter);

           JRBeanCollectionDataSource beanCollectionDataSource = 
             new JRBeanCollectionDataSource(beans);

           String relatorioFormated = relatorio.endsWith(".jasper") ? relatorio
                     : (new StringBuilder()).append(relatorio).append(".jasper")
                             .toString();

           net.sf.jasperreports.engine.JasperPrint jasperPrint = JasperFillManager
                     .fillReport(pathRelatorio + relatorioFormated, params,
                             beanCollectionDataSource);

           String pdfFileName = reportExportPath + relatorio +"_"+ gerarIdReport() + ".pdf";

           JRExporter exporter = new JRPdfExporter();
           exporter.setParameter(JRExporterParameter.JASPER_PRINT, jasperPrint);
           exporter.setParameter(JRExporterParameter.OUTPUT_STREAM, 
              new FileOutputStream(pdfFileName));
           exporter.exportReport();

           return pdfFileName;
       } catch (JRException e) {
           e.printStackTrace();
           return null;
       } catch (IOException e) {
           // TODO Auto-generated catch block
           e.printStackTrace();
           return null;
       }
  }
}

Listagem 9. ReportHelper

Voc� tamb�m pode melhorar um pouco mais nossa classe dando a possibilidade de gerar n�o s� PDF, mas outros formatos. Em nosso caso usamos apenas PDF, mas a biblioteca do JasperReport nos da possibilidade de gerar mais alguns formatos.

Um ponto importante que voc� pode questionar � porque o uso de um par�metro para subReport? Em nosso caso utilizamos um cabe�alho e rodap� atrav�s de subReport, sendo assim, quando mudamos algum valor do cabe�alho (header), todos os relat�rios que o utilizam tamb�m mudam, por isso que precisamos dizer explicitamente qual o caminho deste relat�rio (subreport). Optamos tamb�m por criar uma classe chamada �Codigos� que possuem valores padr�es para nosso sistema, como � o caso das informa��es da empresa, mas voc� pode optar por salvar essas informa��es no banco de dados caso elas possam ser alteradas futuramente.

Com isso, podemos concluir que o uso de relat�rios atualmente � algo essencial para qualquer sistema. E quando falamos em �relat�rio� n�o podemos considerar apenas um processo para realizar an�lise ou auditoria de informa��es, mas tamb�m qualquer tipo de impress�o realizada no sistema, seja a impress�o de uma etiqueta adesiva com c�digo de barras ou mesmo um relat�rio para an�lise de despesas mensais da empresa.

Sendo assim nossa classe serve para gerar qualquer tipo de impress�o necess�ria ao sistema, por exemplo, a Ficha de um funcion�rio em PDF, o crach� de um funcion�rio, relat�rio de entradas e sa�das do caixa, fotos e assim por diante.

Vale ressaltar que estamos trabalhando em um ambiente web onde n�o podemos contar com interface gr�fica (GUI), por isso optamos por usar o PDF que pode ser disponibilizado para download, diferente de um ambiente desktop, onde podemos usar diretamente o JasperViewer que mostrar� o relat�rio em real-time para o usu�rio, sem necessidade de download.

Tecnologias:

Confira outros conte�dos:

Introdu��o ao JDBC

Novidades do Java

Teste unit�rio com JUnit

Assista grátis a nossa aula inaugural

Perguntas frequentes

Quem somos?

Por que a programação se tornou a profissão mais promissora da atualidade?

Como faço para começar a estudar?

Em quanto tempo de estudo vou me tornar um programador?

Sim, você pode se tornar um programador e não precisa ter diploma de curso superior!

O que eu irei aprender estudando pela DevMedia?

Principais diferenciais da DevMedia

Qual o investimento financeiro que preciso fazer para me tornar um programador?

Como funciona a forma de pagamento da DevMedia?

Por Ronaldo Em 2014

Coment�rios nesta publica��o Escrever um coment�rio sobre conte�do

Daniel Fernandes

N�vel 15

como posso fazer para limitar a quantidade de casas decimais exibidas em um text field?

há +1 ano

Ver coment�rios anteriores (4)

Marcio Souza

DevMedia

Por nada Daniel.

t+

há +1 ano

Carlos Moraes

N�vel 1

Ronaldo, Tudo bem ? estou tentando criar uma classe Gen�rica sem usar algum par�metro de lista,
pois s� preciso passar os dados via par�metros e estou usando uma hash map para isso, mas vejo v�rios m�todos usando o JRBeanDataSourceCollection passando a conex�o com o banco de dados, gostaria que me passasse um exemplo que s� necessito chamar o m�todo passando minha hashmap populada com os dados e o caminho do arquivo do relat�rio a onde se encontra

há +1 ano

Ver coment�rios anteriores (4)

Rodolfo Gomes

DevMedia

Show Carlos!!

Mas no que precisar � s� compartilhar

Forte abra�o!

há +1 ano

Nossos casos de sucesso

Leonardo Carlos

Eu sabia pouqu�ssimas coisas de programa��o antes de come�ar a estudar com voc�s, fui me especializando em v�rias �reas e ferramentas que tinham na plataforma, e com essa bagagem consegui um est�gio logo no in�cio do meu primeiro per�odo na faculdade.

Lucas Rodrigues

Estudo aqui na Dev desde o meio do ano passado! Nesse per�odo a Dev me ajudou a crescer muito aqui no trampo.
Fui o primeiro desenvolvedor contratado pela minha empresa. Hoje eu lidero um time de desenvolvimento!
Minha meta � continuar estudando e praticando para ser um Full-Stack Dev!

Her�clito J�nior

Economizei 3 meses para assinar a plataforma e sendo sincero valeu muito a pena, pois a plataforma � bem intuitiva e muuuuito did�tica a metodologia de ensino. Sinto que estou EVOLUINDO a cada dia. Muito obrigado!

Julio Cablen

Nossa! Plataforma maravilhosa. To amando o curso de desenvolvimento front-end, tinha coisas que eu ainda n�o tinha visto. A did�tica � do jeito que qualquer pessoa consegue aprender. S�rio, to apaixonado, adorando demais.

Joelberth Sena

Adquiri o curso de voc�s e logo percebi que s�o os melhores do Brasil. � um passo a passo incr�vel. S� n�o aprende quem n�o quer. Foi o melhor investimento da minha vida!

Felipe Nunes

Foi um dos melhores investimentos que j� fiz na vida e tenho aprendido bastante com a plataforma. Voc�s est�o fazendo parte da minha jornada nesse mundo da programa��o, irei assinar meu contrato como programador gra�as a plataforma.

Wanderson Oliveira

Comprei a assinatura tem uma semana, aprendi mais do que 4 meses estudando outros cursos. Exerc�cios pr�ticos que n�o tem como n�o aprender, est�o de parab�ns!

Jos� Lucas

Obrigado DevMedia, nunca presenciei uma plataforma de ensino t�o presente na vida acad�mica de seus alunos, parab�ns!

Eduardo Dorneles

Aprendi React na plataforma da DevMedia h� cerca de 1 ano e meio... Hoje estou h� 1 ano empregado trabalhando 100% com React!

Adauto Junior

J� fiz alguns cursos na �rea e nenhum � t�o bom quanto o de voc�s. Estou aprendendo muito, muito obrigado por existirem. Est�o de parab�ns... Espero um dia conseguir um emprego na �rea.

Ver todos os casos de sucesso

JasperReport: criando um Helper para gerar Relat�rio

Veja neste artigo como criar uma Classe Helper em Java para gerar relat�rios com o JasperReport.

Importando as librarys necess�rias

Constru��o da classe ReportHelper

Confira outros conte�dos:

Introdu��o ao JDBC

Novidades do Java

Teste unit�rio com JUnit

Perguntas frequentes

Nossos casos de sucesso