JasperReport: Relatórios em Java com iReport

Se analisarmos um ponto importante na maioria dos sistemas, sejam eles complexos ou simples, o objetivo final � quase sempre disponibilizar ao usu�rio/cliente um grande leque de relat�rios para que este possa ent�o tomar a decis�o correta, vamos a alguns exemplos:

Um sistema de preven��o de desastres naturais captura dados geogr�ficos para ent�o gerar relat�rios peri�dicos que possam dizer aos meteorologistas prov�veis cat�strofes que venham a ocorrer em um futuro pr�ximo, cabe a estes analisar e tomar a decis�o para tal fato.
Um sistema de vendas (PDV) aparentemente s� tem a fun��o de vender e emitir documentos fiscais e n�o fiscais atrav�s de uma ECF (Emissor de Cupom Fiscal), mas vai muito al�m disso, o simples ato de emitir um documento seja em uma Impressora Fiscal (ECF) ou em uma Impressora comum (jato de tinta) j� caracteriza a emiss�o de um relat�rio.
Existem sistemas especializados em apenas coletar dados de outros sistemas e gerar relat�rios. Alguns relat�rios chegam a apresentar propostas t�o complexas que s�o necess�rios Sistemas a parte para o controle destes.

Vejamos o significado da palavra relat�rio no dicion�rio: �Um relat�rio � uma exposi��o escrita, minuciosa e circunstanciada relativa a um assunto ou fato ocorrido. O objetivo de um relat�rio � comunicar uma atividade desenvolvida ou ainda em desenvolvimento durante uma miss�o. Deve fornecer o relato permanente de um estudo ou de uma pesquisa e a informa��o necess�ria, que deve ser global e coerente, capaz de permitir tomadas corretas de decis�es.�

Conhe�a a forma��o programador Java da DevMedia, o seu �ndice de aprendizado em Java

Conseguiu assimilar? Relat�rio � qualquer exposi��o escrita e isso nos remete a qualquer tipo de impress�o realizada no Sistema A,B ou C.

Agora que j� estamos familiarizados com o conceito de relat�rio, podemos prosseguir a assuntos mais t�cnicos que dizem respeito a tecnologias especificas utilizadas para gera��o de tal artefato t�o importante em nosso dia a dia.

Relat�rios em Java

Tratando-se de relat�rios em Java, JasperReport � o nome da nossa solu��o. Este � um poderoso framework open-source escrito em Java que permite a gera��o de relat�rios em diversos formatos e com muitos recursos (PDF, HTML, XLS, CSV e XML). Assim como Java tem frameworks para outras tarefas como: Banco de Dados (Hibernate), Inje��o de Depend�ncia (CDI, Spring Framework), Controle de Bibliotecas e suas depend�ncias (Maven) e muitos outros, o Java tamb�m tem um framework para gera��o de relat�rios.

Os arquivos de relat�rios gerados pelo JasperReport tem o formato �.jasper� e seu conte�do � em XML, � nele que todas as dimens�es, campos, e todas as as caracter�sticas do relat�rio s�o postas.

Agora imagine se voc� tivesse que criar todo o relat�rio apenas com c�digo XML, sem nenhuma ferramenta para desenhar, seria muito complexo e pouco produtivo. Para isso usaremos o iReport que � uma IDE para �desenharmos� o relat�rio que ser� gerado em formato �jasper�.

Para quem est� um pouco mais habituado a constru��o de formul�rios em Java, iremos fazer uma analogia com estes para que voc� possa assimilar melhor a diferen�a entre o JasperReport e o iReport (que muito se confunde entre os profissionais da �rea).

Quando voc� vai construir formul�rios em Java provavelmente usa AWT, Swing ou SWT, certo? Acontece que raramente ou quase nunca voc� vai direto no c�digo e come�a a criar os componentes e dispor eles em determinadas coordenadas, seria muito dif�cil e complexo, al�m muito muito pouco produtivo. Normalmente voc� abre uma IDE e constr�i todo seu formul�rio com uma ferramenta �drag-and-drop�, netbeans ou eclipse por exemplo.

Depois que voc� constr�i todo seu formul�rio facilmente com uma IDE que tem o recurso �drag-and-drop� � gerado um classe no formato �.java� com todo aquele c�digo que voc� teria que digitar na m�o, sua tarefa agora � colocar a��es nos bot�es e dar vida aquela tela que antes n�o tinha fun��o alguma.

Enfim, o processo de constru��o de relat�rio em Java � similar ao que foi explicado acima, onde o JasperReport seria nosso AWT, Swing ou SWT e o Netbeans ou Eclipse seria nosso iReport.

Lembra que falamos que o JasperReport gera um arquivo �jasper� certo? O iReport tamb�m gera seu pr�prio arquivo, um �.jrxml�. Novamente fazendo uma analogia, assim como o netbeans gera nosso �.form� o iReport gera o �.jrxml� para que possamos alterar o �desenho� do relat�rio a qualquer momento, mas independente da IDE que voc� use para fazer o �desenho� do relat�rio o objeto sempre ser� o mesmo, um arquivo �jasper�.

Instalando o JasperReport no seu Projeto

Partindo do princ�pio que voc� est� utilizando um gerenciador de depend�ncias/bibliotecas necess�rias, em nosso caso o Maven, iremos mostrar os arquivos necess�rios para funcionamento e uso do JasperReport em nosso projeto. Observe a Listagem 1.

Listagem 1. pom.xml para JasperReport


  <dependency>
        <groupId>org.apache.poi</groupId>
         <artifactId>poi</artifactId>
         <version>3.10-FINAL</version>
  </dependency>
   
  <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>xerces</groupId>
        <artifactId>xercesImpl</artifactId>
        <version>2.10.0</version>
  </dependency>

Se voc� n�o usa o Maven, pode optar por baixar os �.jars� sem importa-los no classparth do seu projeto. Vamos explicar para que serve cada uma das bibliotecas acima:

Apache POI: Usado para exportar seus relat�rios para formatos suportados pelo �Microsoft Office�, tais como excel, word e powerpoint.
Barbecue: Usado para cria��o de c�digo de barras, muito usado em relat�rios que ser�o lidos com leitores de c�digo de barras.
JasperReport: Como sendo nossa principal biblioteca, � respons�vel por gerar o relat�rio em si, utilizando as ferramentas auxiliares apresentadas em nosso pom.xml.
JasperReport-fonts: Como o pr�prio nome sugere, fontes para o JasperReport.
xerces: � um conjunto de bibliotecas para valida��o, serializa��o e manipula��o de XML.

Com as importa��es necess�rias realizadas voc� j� pode fazer uso do JasperReport e suas bibliotecas auxiliares afim de gerar um relat�rio completo e repleto de informa��es.

Entendendo o JasperReport

� importante entender o funcionamento do JasperReport antes de iniciar o desenho de um relat�rio com o iReport, isso porque pode ser que em algum momento seja necess�rio alterar diretamente informa��es no XML, e conhecer sua estrutura � essencial.

Campos, Par�metros e Vari�veis

No JasperReport voc� ir� se deparar com tr�s conceitos bases, que s�o: Campos (field), Par�metros(parameter) e Vari�veis (variable).

Os campos/fields s�o utilizados para mapear dados diretamente a colunas no banco de dados ou a classes Java, se voc� estiver trabalhando com um mapeamento, eles surgem atrav�s da sua fonte de dados. Vejamos a Listagem 2.

Listagem 2. Exemplo de field


  <field name=�nomeCompleto� class=�java.lang.String�/>

O que temos acima � a cria��o do campo �nomeCompleto�, que provavelmente � um m�todo �getNomeCompleto()� na nossa classe Java.

Os par�metros/parameter, ao contr�rio dos campos, n�o vem de uma fonte de dados. Estes s�o passados para preencher algum valor no relat�rio, tal como: t�tulo do relat�rio, endere�o da empresa e etc. Vejamos um exemplo na Listagem 3.

Listagem 3. Exemplo de parameter


  <parameter name=�NomeDoRelatorio� class=�java.lang.String�/>

Em Java, podemos fazer o uso da classe Map para realizar a passagem de par�metros ao Jasper. Observe um exemplo na Listagem 4.

Listagem 4. Passando par�metros ao Jasper via Java


  Map parametros = new HashMap( );
  parametros.put( �NomeDoRelatorio�, �REL001 � DESPESAS MENSAIS� );

As vari�veis/variables s�o usadas internamente no relat�rio, diferente dos campos e par�metros que vem de uma fonte externa. As vari�veis s�o utilizadas para c�lculos como: contagem (count), soma (sum), m�dia (average), menor (lowest), maior (highest) e etc. S�o valores tempor�rios apenas para cumprir determinada tarefa espec�fica no relat�rio. Observe um exemplo na Listagem 5.

Listagem 5. Exemplo de variable


  <variable name=�totalVendido� class=�java.lang.Double�    calculation=�Sum�>
         <variable expression> ${valorVenda} </variable expression>
  </variable>

No exemplo acima estamos somando os valores de ${valorVenda} de cada registro e armazenando na vari�vel �totalVendido�.

O pr�prio JasperReport j� conta com algumas vari�veis internas para evitar retrabalho, s�o elas: PAGE_NUMBER, COLUMN_NUMBER, REPORT_COUNT, PAGE_COUNT e COLUMN_COUNT. Todas s�o bem explicativas e dispensam coment�rios.

Al�m disso, o recurso de vari�veis ainda tem algumas peculiaridades. Podemos, por exemplo, definir o valor de inicializa��o da vari�vel e quando ela ser� inicializada, como podemos ver na Listagem 6.

Listagem 6. Inicializando vari�vel


  <variable name=totalVendido class=�java.lang.Double� resetType=�Page� calculation=�Sum�>
         <variable expression> ${valorVenda} </variable expression>
         <initialValueExpression> new Double( 0 ) </initialValueExpression>
  </variable>

Acima estamos definindo que a vari�vel ir� ser inicializada com o valor �0�, mas quando ela ser� inicializada? Em nosso caso definimos o valor �Page� que diz ao JasperReport para inicializar a vari�vel a cada p�gina.

Express�es / Expressions

As express�es s�o utilizadas para formatar o conte�do de um campo de texto (est�tico) de forma que este possa possuir valores din�micos, s�o utilizadas express�es Java para montar tal conte�do, o que torna mais f�cil a utiliza��o deste. Vejamos um exemplo na Listagem 7.

Listagem 7. Usando expressions


  <textFieldExpression>
      "A Nota foi emitida em "+(new SimpleDateFormat("dd/MM/yyyy")).format($F{dataEmissao})+ " pelo usu�rio "+$F{nomeUsuario}+
      " no valor total de "+$V{totalVendido}
  </textFieldExpression>

Perceba acima que usamos fields ($F{}) e variables ($V{}) para montar nossa mensagem din�mica, de forma a mostrar informa��es mais relevantes ao usu�rio. Voc� perceber� ao longo da constru��o de um relat�rio que as express�es s�o usadas demasiadamente para tornar o relat�rio mais apresent�vel ao usu�rio final.

Layout

Estudamos acima a utiliza��o de dados no JasperReport (campos, par�metros, vari�veis e express�es). Precisamos agora entender como o Jasper organiza/disp�e tais dados na sua p�gina.

H� uma divis�o de �reas no relat�rio, que s�o chamadas de �se��es�, s�o elas: background, title, pageHeader, columnHeader, detail, columnFooter, pageFooter, lastPageFooter e summary. Cada uma dessas se��es tem suas especificidade, como por exemplo a �detail� � onde colocamos nossa fonte de dados.

API do JasperReport

Veremos agora algumas das classes utilizadas para gera��o de relat�rio com o Jasper e qual sua utilidade.

De acordo com a UFCG (Universidade Federal de Campina Grande) s�o listadas abaixo as classes e suas determinadas funcionalidades:

Classe dori.jasper.engine.design.JasperDesign: Inst�ncias dessa classe representam o relat�rio no seu formato mais primitivo. S�o resultados de um processamento sobre o arquivo XML.
Classe dori.jasper.engine.JasperReport: Inst�ncias dessa classe representam relat�rios compilados. Nesse est�gio, toda a an�lise sint�tica nas express�es existentes no XML j� foram realizadas. Objetos dessa classe podem ser armazenados em arquivos �.jasper�.
Classe dori.jasper.engine.JasperCompileManager: Respons�vel por criar inst�ncias das classes JasperReport e JasperDesign.
Classe dori.jasper.engine.JasperPrint: Consiste no JasperReport com todos os campos preenchidos. Um objeto dessa classe pode ser visualizado diretamente utilizando visualizadores internos do JasperReport, como tamb�m pode ser transformado em formatos mais populares como HTML, XML ou PDF.
Interface dori.jasper.engine.JRDataSource: Essa interface padroniza o comportamento das classes que manipulam as fontes de dados necess�rias durante o preenchimento dos campos existentes no JasperReport. Dessa forma, v�rias fontes podem ser utilizadas, seja um banco de dados, ou mesmo um arquivo XML.
Entre as classes que implementam essa interface; podemos citar:
� dori.jasper.engine.JRResultSetDataSource (acessa um banco de dados);
� dori.jasper.engine.data.JRTableModelDataSource (acessa tabelas j� carregadas em interfaces swing);
� dori.jasper.engine.JREmptyDataSource (n�o acessa nenhuma fonte de dados, utilizada quando se deseja criar um JasperPrint sem acessar nenhuma fonte de dados).
Classe dori.jasper.engine.JasperFillManager: Essa classe � utilizada para gerar inst�ncias da classe JasperPrint. Em seu processamento, ela utiliza uma fonte de dados (JRDataSource) e uma inst�ncia da classe JasperReport.
Classe dori.jasper.engine.JasperPrintManager: Permite imprimir o relat�rio (o conte�do do relat�rio � enviado para impressora, uma janela de requisi��o de impress�o � aberta). Tanto � poss�vel imprimir todo o relat�rio como tamb�m p�ginas do mesmo.
Al�m disso, � poss�vel imprimir o relat�rio como uma imagem (utilizando o m�todo printPageToImage)
Classe dori.jasper.engine.JasperExportManager: Permite gerar documentos nos formatos PDF, HTML e XML (vers�o 1.0). Com o tempo, novos formatos ser�o incorporados.

Listagem 8. Exemplo completo de JasperReport


 import java.sql.Connection;
 import java.sql.DriverManager;
 import java.sql.ResultSet;
 import java.sql.SQLException;
 import java.sql.Statement;
 import java.util.HashMap;
 import java.util.Map;
 import net.sf.jasperreports.engine.JRException;
 import net.sf.jasperreports.engine.JRResultSetDataSource;
 import net.sf.jasperreports.engine.JasperCompileManager;
 import net.sf.jasperreports.engine.JasperFillManager;
 import net.sf.jasperreports.engine.JasperPrint;
 import net.sf.jasperreports.engine.JasperReport;
 import net.sf.jasperreports.engine.design.JasperDesign;
 import net.sf.jasperreports.engine.xml.JRXmlLoader;
 import net.sf.jasperreports.view.JasperViewer;
 
 public class JasperReportExemple {
 
 private static final String url = "jdbc:mysql://127.0.0.1/teste";
 private static final String driver = "com.mysql.jdbc.Driver";
 private static final String login = "";
 private static final String pwd = "";
 
 public JasperReportExemple() {
 }
 
 public void gerar( String layout ) throws JRException , SQLException, ClassNotFoundException {
 //gerando o jasper design
 JasperDesign desenho = JRXmlLoader.load( layout );
 
 //compila o relat�rio
 JasperReport relatorio = JasperCompileManager.compileReport( desenho );
 
 //estabelece conex�o
 Class.forName( driver );
 Connection con = DriverManager.getConnection( url , login , pwd );
 Statement stm = con.createStatement();
 String query = "select * from turma";
 ResultSet rs = stm.executeQuery( query );
 
 //implementa��o da interface JRDataSource para DataSource ResultSet
 JRResultSetDataSource jrRS = new JRResultSetDataSource( rs );
 
 //executa o relat�rio
 Map parametros = new HashMap();
 parametros.put("nota", new Double(10));
 JasperPrint impressao = JasperFillManager.fillReport( relatorio , parametros, jrRS );
 
 //exibe o resultado
 JasperViewer viewer = new JasperViewer( impressao , true );
 viewer.show();
 }
 
 public static void main(String[] args) {
 try {
 new JasperReportExemple().gerar( "report.jrxml" );
 } catch (Exception e) {
 e.printStackTrace();
 }
 }
 }

O que temos na Listagem 8 � a gera��o de um relat�rio salvo no arquivo �report.jrxml�, j� desenhado atrav�s do iReport.

Agora que temos conhecimento do principal, que � o uso do JasperReport em Java, podemos come�ar a apresentar a ferramenta iReport para que voc� possa desejar seu relat�rio. Voc� ir� perceber que ela � bem intuitiva e de f�cil utiliza��o, vamos apresentar algumas de suas principais caracter�sticas.

Introdu��o ao iReport

Utilizamos para demonstra��o o iReport vers�o 5.5.0, como mostra a Figura 1.

Apresenta��o do iReport

Figura 1. Apresenta��o do iReport

Temos na Figura 1 tr�s �reas primordiais para constru��o do seu relat�rio. A �rea 1 possui o conte�do do relat�rio em si, ou seja, campos, par�metros, vari�veis, se��es, estilos e etc. Quando voc� adiciona um field no seu relat�rio, � nesta �rea que voc� poder� encontr�-lo para realizar as configura��es necess�rias. Quando voc� deseja ocultar, adicionar ou deletar uma se��o (detail, title, summary e etc) � nesta �rea que voc� o faz.

Na �rea 2 temos o desenho do relat�rio, ou seja, a convers�o do arquivo JRXML para um ambiente gr�fico, de forma que possamos ter uma melhor perspectiva de como ser� o resultado final do nosso relat�rio.

Por fim, na �rea 3 temos as sa�das (mensagens) do iReport ao realizar a compila��o do nosso relat�rio: Erros, Informa��es e etc.

Segunda parte iReport

Figura 2. Segunda parte iReport

Para finalizar, temos a �rea 1 na Figura 2 que corresponde a paleta de elementos que iReport disponibiliza, com ela n�s podemos utilizar o famoso recurso �drag-and-drop� evitando ter que codificar em XML.

Na �rea 2 da Figura 2 temos as propriedades do elemento selecionado, em nosso caso selecionamos o elemento �StaticText� com o conte�do �Ola Mundo� e podemos agora configurar suas propriedades como altura, largura, cor, fonte e etc.

Com isso conclu�mos esse artigo, onde tivemos uma vis�o geral do uso do JasperReport em Java com seus detalhes e peculiaridades e por fim vimos como usar o iReport para desenhar nosso relat�rio de forma r�pida e f�cil. Vale ressaltar que o uso do iReport � opcional, por ser apenas uma IDE para constru��o do relat�rio, assim como o Eclipse esta para o Java.

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

Paulo Lima

N�vel 2

Tem como fazer o relatorio ser aberto automaticamente no browser ap�s o pdf ser gerado ?

há +1 ano

Ver coment�rios anteriores (7)

Marcio Souza

DevMedia

Show Paulo, legal que deu certo ao alterar o cabe�alho.
Boa sorte com seu projeto.
At� mais.

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: Relat�rios em Java com iReport

Veja neste artigo as principais caracter�sticas do JasperReport em Java, al�m de uma introdu��o ao iReport para desenhar seus relat�rios.