Como criar um Gerador de Relatórios para JasperReport no JSF

Gerar relat�rios � um processo comum a quase todos os tipos de sistemas, desde simples a complexos. Relat�rios s�o artefatos finais que podem prover ao usu�rio/cliente uma forma de saber se as informa��es que est�o sendo alimentadas no sistema est�o corretas, ou mesmo se o sistema est� realizando os procedimentos adequados.

As vezes a maior dificuldade em gerar relat�rios na Web n�o � sua constru��o, mas o processo para que este seja mostrado ao usu�rio da forma mais usual poss�vel.

Neste artigo iremos construir classes que ser�o respons�veis por tornar a gera��o do nosso relat�rio o mais simples poss�vel, isso significa que ao criar relat�rios n�o deveremos nos preocupar com a forma que ele ser� mostrado ao usu�rio, mas sim se seu conte�do est� correto.

Usaremos uma das bibliotecas mais conhecidas para gera��o de relat�rios, o JasperReport. Esta � inteiramente escrita em Java e pode usar dados provenientes de quase todo tipo de datasource (fonte de dados) que voc� imaginar. Isso faz dele um dos melhores, se n�o o melhor, engine de relat�rios open source para Java.

Vamos come�ar criando uma classe Helper chamada ReportHelper, conforme mostra a Listagem 1, que � respons�vel por realizar o processo principal, ou seja, gerar o relat�rio e enviar ao navegador.

Listagem 1. ReportHelper


  1 import java.io.File;
 2 import java.io.FileOutputStream;
 3 import java.io.IOException;
 4 import java.text.SimpleDateFormat;
 5 import java.util.Date;
 6 import java.util.HashMap;
 7 import java.util.List;
 8 import java.util.Map;
 9 
 10 import javax.faces.context.FacesContext;
 11 import javax.servlet.http.HttpServletRequest;
 12 
 13 import net.sf.jasperreports.engine.JREmptyDataSource;
 14 import net.sf.jasperreports.engine.JRException;
 15 import net.sf.jasperreports.engine.JRExporter;
 16 import net.sf.jasperreports.engine.JRExporterParameter;
 17 import net.sf.jasperreports.engine.JasperFillManager;
 18 import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource;
 19 import net.sf.jasperreports.engine.export.JRPdfExporter;
 20 import net.sf.jasperreports.engine.export.JRXlsExporter;
 21 
 22 import org.primefaces.context.RequestContext;
 23 import org.springframework.beans.factory.annotation.Autowired;
 24 import org.springframework.stereotype.Component;
 25 
 26 @Component(value = "reportHelper")
 27 public class ReportHelper {
 28 
 29 public enum FORMATO_RELATORIO{
 30 XLS, PDF;
 31 }
 32 
 33 private String gerarIdReport() {
 34 SimpleDateFormat simpleDateFormat = new SimpleDateFormat(
 35 "ddMMyyyyhhmmss");
 36 String id = simpleDateFormat.format(new Date());
 37 
 38 return id;
 39 }
 40 
 41 /**
 42 * Retorna caminho onde os relat�rios (.jasper e .jrxml e tmps) ficam
 43 * armazenados
 44 * */
 45 private String reportSourcePath() {
 46 
 47 return FacesContext.getCurrentInstance().getExternalContext()
 48 .getRealPath("/WEB-INF/report/")
 49 + "/";
 50 }
 51 
 52 /**
 53 * Retorna o caminho onde os relat�rios finais ficam no servidor (ex: .PDF)
 54 * */
 55 private String reportFile() {
 56 return FacesContext.getCurrentInstance().getExternalContext()
 57 .getInitParameter("reportDirectory");
 58 }
 59 
 60 /**
 61 * Abrir Janela com Arquivo (PDF, XLS, TXT e etc)
 62 * */
 63 public void abrirPoupUp(String fileName) {
 64 abrirPoupUp(fileName, null);
 65 }
 66 
 67 public void abrirPoupUp(String fileName, String nomeJanela){
 68 HttpServletRequest req = (HttpServletRequest) FacesContext
 69 .getCurrentInstance().getExternalContext().getRequest();
 70 String contextPath = req.getContextPath().replace("/", "");
 71 if (nomeJanela == null){
 72 nomeJanela = "Relat�rio";
 73 }
 74 
 75 RequestContext.getCurrentInstance().execute(
 76 "window.open("/" + contextPath + "/report/" + fileName
 77 + "",'"+nomeJanela+"','width=800px,height=800px')");
 78 }
 79 
 80 /**
 81 * Gera o relat�rio e retorna o nome do relat�rio gerado
 82 * */
 83 private String gerarRelatorio(String relatorio,
 84 List beans, Map<String, Object> params, FORMATO_RELATORIO formatoExportacao) {
 85 try {
 86 if (params == null) {
 87 params = new HashMap<String, Object>();
 88 }
 89 
 90 
 91 JRBeanCollectionDataSource beanCollectionDataSource = new JRBeanCollectionDataSource(
 92 beans);
 93 
 94 String relatorioFormated = relatorio.endsWith(".jasper") ? relatorio
 95 : (new StringBuilder()).append(relatorio).append(".jasper")
 96 .toString();
 97 net.sf.jasperreports.engine.JasperPrint jasperPrint = null;
 98 
 99 if (beans != null && beans.size() > 0) {
 100 jasperPrint = JasperFillManager
 101 .fillReport(reportSourcePath() + relatorioFormated, params,
 102 beanCollectionDataSource);
 103 } else {
 104 jasperPrint = JasperFillManager
 105 .fillReport(reportSourcePath() + relatorioFormated, params, new JREmptyDataSource());
 106 }
 107 
 108 
 109 StringBuilder nomeRelatorio = new StringBuilder();
 110 nomeRelatorio.append(reportFile() + relatorio + "_"
 111 + gerarIdReport());
 112 
 113 
 114 JRExporter exporter = null;
 115 
 116 if (formatoExportacao.equals(FORMATO_RELATORIO.PDF)){
 117 exporter = new JRPdfExporter();
 118 nomeRelatorio.append(".pdf");
 119 }else if (formatoExportacao.equals(FORMATO_RELATORIO.XLS)){
 120 exporter = new JRXlsExporter(); 
 121 nomeRelatorio.append(".xls");
 122 }
 123 
 124 File fTarget = new File(nomeRelatorio.toString());
 125 
 126 exporter.setParameter(JRExporterParameter.JASPER_PRINT, jasperPrint);
 127 exporter.setParameter(JRExporterParameter.OUTPUT_STREAM,
 128 new FileOutputStream(fTarget.getAbsolutePath()));
 129 exporter.exportReport();
 130 
 131 return fTarget.getName();
 132 } catch (JRException e) {
 133 e.printStackTrace();
 134 return null;
 135 } catch (IOException e) {
 136 // TODO Auto-generated catch block
 137 e.printStackTrace();
 138 return null;
 139 }
 140 }
 141 
 142 /**
 143 * Gera��o de Relat�rio em XLS
 144 */
 145 public String gerarRelatorioXLS(String relatorio,
 146 List beans, Map<String, Object> params){
 147 
 148 return gerarRelatorio(relatorio, beans, params, FORMATO_RELATORIO.XLS);
 149 
 150 }
 151 
 152 /**
 153 * Padr�o para Arquivos PDF 
 154 * */
 155 public String gerarRelatorio(String relatorio,
 156 List beans, Map<String, Object> params){
 157 
 158 return gerarRelatorio(relatorio, beans, params, FORMATO_RELATORIO.PDF);
 159 
 160 }
 161 
 162 }

Primeiramente � importante salientar alguns pontos importantes da nossa classe antes de explicar os blocos de c�digo-fonte importantes:

Utilizamos o Primefaces apenas para poder fazer chamada a uma fun��o em Javascript, por isso fizemos o import da classe org.primefaces.context.RequestContext;
O Spring Framework nos ajudar� a realizar a inje��o de depend�ncias em outros locais da nossa classe ReportHelper, mas voc� pode ficar � vontade para usar algum outro framework ou mesmo nem us�-lo. O nosso foco n�o � mostrar conceitos e pr�ticos sobre Inje��o de depend�ncia ent�o fique � vontade para usar algum outro se sentir necessidade.

Al�m disso, vamos entender como o c�digo se comporta:

Linha 26-27: Temos aqui a declara��o da classe em conjunto com o nome que ser� usado pela inje��o de depend�ncias do Spring, ou seja, se quisermos fazer refer�ncia a nossa classe atrav�s do Spring devemos cham�-la de �reportHelper�;
Linha 29-31: Em nosso caso vamos trabalhar apenas com dois formatos poss�veis: PDF e XLS, que s�o os mais utilizados. Criamos um ENUM para evitar que outros tipos, que n�o sejam esses, possam ser passados como par�metro para nosso m�todo de gera��o de relat�rios;
Linha 33-39: Nosso relat�rio precisa ter um nome �nico no servidor de aplica��o, isso porque o mesmo relat�rio pode ser gerado v�rias vezes e por usu�rios diferentes. Sendo assim garantimos que nunca um relat�rio ir� sobrescrever o outro. Claro que isso tem um impacto no futuro, pois haver� muitos relat�rios armazenados no servidor e eles dever�o ser limpos de tempos em tempos, mas esse � o menor dos problemas. A nossa solu��o para criar uma forma �nica de numera��o e ainda saber quando o relat�rio foi gerado � usar o SimpleDateFormat com o padr�o ddMMyyyyhhmmss, assim temos dia-m�s-ano-hora-minuto-segundo em cada arquivo. Raramente ser�o gerados dois arquivos no mesmo segundo, e mesmo se isto ocorrer ser� um caso muito peculiar e de pouca import�ncia agora;
Linha 45-50: E onde ficam nossos relat�rios? Optamos por usar a pasta WEB-INF/report/, � neste diret�rio que todos os nossos arquivos �.jasper� ficar�o. Para que o Java consiga mapear este diret�rio usamos o m�todo getRealPath() do JSF, assim ele consegue capturar o caminho real do diret�rio que passamos dentro da estrutura de todo o projeto. � importante que trabalhemos assim em vez de digitar o caminho completo, pois se amanh� precisarmos mudar o local onde o WEB-INF/report/ fica no projeto, o JSF automaticamente achar� ele e isso ser� transparente para nosso c�digo;
Linha 55-58: Atrav�s do FacesContext conseguimos capturar o diret�rio em que os arquivos gerados ficar�o. O m�todo getInitParameter() retornar o valor do par�metro que est� configurado no nosso web.xml como padr�o. Em nosso caso precisamos do �reportDirectory�;
Linha 75-79: Com o uso do Primefaces conseguimos fazer chamados ao JavaScript dentro da nossa classe Java. Para abrir um popup usamos o RequestContext passando um comando JavaScript de abertura de popup, o �window.open�. O contextpath � o caminho da nossa aplica��o, ex: localhost:8080/minhaaplicacao, ele � essencial para que o window.open consiga localizar onde encontra-se nosso relat�rio;
Linha 91: J� dentro do m�todo gerarRelatorio() criamos um objeto do tipo JRBeanCollectionDataSource para receber o datasource que nosso relat�rio ir� ler, em nosso caso temos uma lista de beans, que pode ser qualquer coisa que desejarmos. Ex: Uma lista de carros, pessoas e etc;
Linha 94: Precisamos certificar que o arquivo de relat�rio tenha o final ".jasper" para que a gera��o ocorra sem erros. Para isso usamos um if-tern�rio afim de adicionar o final ".jasper" caso ele n�o exista;
Linha 99-106: Caso haja algum registro na lista passada ent�o podemos preencher nosso JasperFillManager, por outro lado, caso n�o haja nenhum registro ent�o criamos o relat�rio com o JREmptyDataSource();
Linha 109: Criamos o nome do arquivo que ser� gerado, seja PDF ou EXCEL, usando nosso m�todo gerarIdReport() que garantir� que o nome n�o ir� se repetir;
Linha 116-122: Caso seja PDF ent�o usamos o JRPdfExporter() e adicionamos o ".pdf" ao final do nome gerado, caso contr�rio usamos o JRXlsExporter() e adicionamos o ".xls" ao final do arquivo;
Linha 126-129: O nosso JRExporter gravar� os par�metros que utilizaremos para exportar o relat�rio para PDF ou EXCEL. Usamos dois par�metros, onde o primeiro � um objeto jasperPrint que � exatamente o objeto do nosso relat�rio que preenchemos com o JasperFillManager e o segundo � o destino para onde nosso relat�rio ir�, em nosso caso enviamos para um arquivo. Por �ltimo usamos o exporterReport() para gerar o relat�rio no arquivo a qual apontamos anteriormente;
Linha 131: Nosso m�todo retorna o nome do relat�rio gerado para que seja poss�vel que o usu�rio fa�a o download do mesmo.

Os outros m�todos de gera��o de relat�rio s�o apenas sobrecargas do m�todo principal, para possibilitar a chamada ao mesmo de v�rias formas poss�veis.

Temos pronta nossa classe Helper que ir� fazer a parte mais dif�cil, que � gerar o relat�rio, vamos agora ver a nossa classe que ir� tratar do front-end, ou seja, ser� o Backing Bean respons�vel por cuidar dos filtros para gerar nosso relat�rio correto. Observe a Listagem 2.

Listagem 2. ReportItem


 1 import javax.faces.application.FacesMessage;
 2 import javax.faces.context.FacesContext;
 3 
 4 import br.com.projetoteste.helper.ReportHelper.FORMATO_RELATORIO;
 5 
 6 public abstract class ReportItem {
 7 
 8 private String nome;
 9 private String descricao;
 10 private String jasperName; 
 11 
 12 public ReportItem(String nome, String descricao, String jasperName) {
 13 this.nome = nome;
 14 this.descricao = descricao;
 15 this.jasperName = jasperName;
 16 }
 17 
 18 public ReportItem(String descricao) {
 19 this.nome = this.getClass().getSimpleName();
 20 this.descricao = descricao;
 21 this. jasperName = this.getClass().getSimpleName().toLowerCase();
 22 }
 23 
 24 public abstract void gerarRelatorio(FORMATO_RELATORIO formato);
 25 
 26 public String getNome() {
 27 return nome;
 28 }
 29 
 30 public void setNome(String nome) {
 31 this.nome = nome;
 32 }
 33 
 34 public String getDescricao() {
 35 return descricao;
 36 }
 37 
 38 public void setDescricao(String descricao) {
 39 this.descricao = descricao;
 40 }
 41 
 42 public String getJasperame() {
 43 return jasperName;
 44 }
 45 
 46 public void setJasperName(String jasperName) {
 47 this. jasperName = jasperName;
 48 }
 49 
 50 }

A ideia de criar uma classe ReportItem � para que todos os Backing Beans de relat�rios possam estender dela, criando assim uma padroniza��o para a gera��o de relat�rios. Ela � simples, mas eficaz. Vejamos:

Linha 6: Ela � abstrata pois ningu�m poder� criar uma inst�ncia desta, apenas estender da mesma;
Linha 8-10: Precisamos de tr�s propriedades, nome, descri��o e jasperName. Onde nome � o nome do relat�rio que ser� mostrado no XHTML, descri��o � um resumo sobre o que o relat�rio faz, geralmente usando no "title" dos atributos do HTML e por �ltimo o jasperName que � o nome do arquivo jasper para gera��o do relat�rio;
Linha 24: � obrigat�rio que todo Backing Bean que use o nosso ReportItem tenha o m�todo gerarRelatorio(), pois assim saberemos que todo gerarRelatorio() recebe um enum FORMATO_RELATORIO, que at� agora pode ser PDF ou XLS.

Vamos ver agora como usar o nosso ReportItem em conjunto com o ReportHelper. Digamos que nossos relat�rios tenham a seguinte nomenclatura: R001, R002 e assim por diante. Ent�o vamos criar um Backing Bean chamado R001, que estende de ReportItem. Isso j� caracteriza que nosso Backing Bean � um gerenciador de algum relat�rio espec�fico, como mostra a Listagem 3.

Listagem 3. R001 extends ReportItem


  1 import java.text.SimpleDateFormat;
 2 import java.util.Date;
 3 import java.util.HashMap;
 4 import java.util.List;
 5 import java.util.Map;
 6 
 7 import javax.annotation.PostConstruct;
 8 import javax.faces.bean.ManagedBean;
 9 import javax.faces.bean.ManagedProperty;
 10 import javax.faces.bean.ViewScoped;
 11 
 12 
 13 import br.com.projetoteste.helper.ReportHelper;
 14 import br.com.projetoteste.helper.ReportHelper.FORMATO_RELATORIO;
 15 import br.com.projetoteste.report.bean.ReportItem;
 16 
 17 @ManagedBean(name = "r001")
 18 @ViewScoped
 19 public class R001 extends ReportItem {
 20 
 21 
 22 @ManagedProperty(value = "#{reportHelper}")
 23 private ReportHelper reportHelper;
 24 
 25 private Date dataInicial, dataFinal;
 26 
 27 @PostConstruct
 28 public void init() {
 29 dataInicial = new Date();
 30 dataFinal = new Date();
 31 }
 32 
 33 public R001() {
 34 super("Listagem de Funcionarios da Empresa");
 35 }
 36 
 37 @Override
 38 public void gerarRelatorio(FORMATO_RELATORIO formato) {
 39 List<Funcionario> funcionarios = (List<Funcionario>) MeuServico.getListaFuncionario();
 40 Map<String, Object> params = new HashMap<String, Object>();
 41 params.put("titulo", getNome());
 42 
 43 SimpleDateFormat sdf = new SimpleDateFormat("dd/MM/yyyy");
 44 params.put("dataInicial", sdf.format(dataInicial));
 45 params.put("dataFinal", sdf.format(dataFinal));
 46 
 47 String fileName = reportHelper.gerarRelatorio("r001", funcionarios, params);
 48 reportHelper.abrirPoupUp(fileName);
 49 
 50 }
 51 
 52 public void gerarXLS() {
 53 gerarRelatorio(FORMATO_RELATORIO.XLS);
 54 }
 55 
 56 public void gerarPDF() {
 57 gerarRelatorio(FORMATO_RELATORIO.PDF);
 58 }
 59 
 60 public ReportHelper getReportHelper() {
 61 return reportHelper;
 62 }
 63 
 64 public void setReportHelper(ReportHelper reportHelper) {
 65 this.reportHelper = reportHelper;
 66 }
 67 
 68 public Date getDataInicial() {
 69 return dataInicial;
 70 }
 71 
 72 public void setDataInicial(Date dataInicial) {
 73 this.dataInicial = dataInicial;
 74 }
 75 
 76 public Date getDataFinal() {
 77 return dataFinal;
 78 }
 79 
 80 public void setDataFinal(Date dataFinal) {
 81 this.dataFinal = dataFinal;
 82 }
 83 
 84 }

Vamos entender o c�digo apresentado:

Linha 17: Nomeamos o nosso backing bean com o valor "r001", pois ser� este o valor que usaremos no XHTML;
Linha 22: Fizemos a inje��o do reportHelper atrav�s do ManagedProperty;
Linha 25: As duas propriedades para que o usu�rio diga qual per�odo ele deseja emitir o relat�rio;
Linha 28: Inicializamos as duas datas como sendo a data atual;
Linha 34: Nomeamos o relat�rio como �Listagem de Funcion�rios da Empresa� esse valor poder� ser usamos tanto em par�metros do relat�rio como no pr�prio XHTML para mostrar ao usu�rio, veremos como logo em seguida;
Linha 39: Aqui � onde realmente a �m�gica� acontece, no m�todo gerarRelatorio(), logo no in�cio j� capturamos a lista de funcionarios e colocamos em um List<Funcionario>. Abstraia a parte de como isso � feito, o importante � saber que a lista de funcion�rios foi capturada de algum local, seja um arquivo, banco, xml ou etc.;
Linha 40-45: Criamos um Map para armazenar os par�metros que nosso relat�rio precisar�. Adicionamos 3 par�metros, s�o eles: t�tulo do relat�rio, data inicial e data final;
Linha 47: Finalmente usamos o reportHelper.gerarRelatorio() onde passamos o nome do arquivo "r001", a lista de beans e os par�metros que ser�o usados. Lembrando que poder�amos mudar o "r001" para algo mais gen�rico como "getJaspername()";
Linha 48: Usamos ainda o reportHelper para abrir o popup com o relat�rio que foi gerado anteriormente.

Agora voc� pode utilizar o backing bean em qualquer XHTML, fazendo chamada sempre ao actionListener gerarRelatorio().

Com base neste artigo voc� ter� uma estrutura gen�rica para gera��o de relat�rios em JSF, abstraindo toda a complexidade para a gera��o do mesmo. A �nica coisa que voc� precisar� se preocupar � com o filtro do seu relat�rio e a cria��o propriamente dita do mesmo.

Espero que tenham gostado e at� a pr�xima.

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 2015

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

Como criar um Gerador de Relat�rios para JasperReport no JSF

Veja neste artigo como criar classes que sejam capazes de gerar qualquer relat�rio em JSF usando JasperReport.