iReport Tutorial: Gerando relatórios com iReport

Por que eu devo ler este artigo:Neste artigo veremos os principais recursos do iReport para cria��o de relat�rios tendo como premissa a independ�ncia da fonte de dados.

Desenvolver relat�rios � muito comum em aplica��es corporativas. Atrav�s desse artigo veremos como criar relat�rios com JavaBeans, recursos de internacionaliza��o e sub-relat�rios.

O tema � �til quando h� necessidade de criar relat�rios de forma visual e que se integre facilmente a aplica��es Java para ambientes desktop e web.

Saiba mais: Guia Completo de Java

Neste artigo ser� mostrada de forma objetiva a elabora��o e o desenvolvimento de relat�rios em Java utilizando as ferramentas open source mais completas dispon�veis no mercado.

Apesar de existirem outras ferramentas de relat�rio open-source como o BIRT, o iReport � uma ferramenta em constante evolu��o, muito poderosa, flex�vel e que tem o maior suporte da comunidade de desenvolvedores. O JasperReports suporta scriptlets, tem integra��o com JFreeChart para renderizar gr�ficos e com o Barbecue para gerar c�digo de barras. Agora na vers�o 3.7 houve uma melhora significativa na interface gr�fica e na exporta��o para formatos do padr�o Office Open XML.

N�o interprete JasperReports e iReport como uma ferramenta �nica, o iReport � uma ferramenta de designer de relat�rios para o JasperReports. J� o JasperReports � uma biblioteca (engine) para gera��o de relat�rios que pode funcionar sem o iReport. Quando geramos os relat�rios em nossa aplica��o temos que adicionar apenas os arquivos jars do JasperReports ao classpath.

O exemplo que apresentaremos n�o far� uso de nenhum SGDB (Sistema de Gerenciamento de Banco de Dados) espec�fico para obten��o dos dados que alimentar� o relat�rio. O objetivo do artigo � ensinar a utilizar o iReport para criar relat�rios de forma a n�o depender da fonte de dados. Por isso, ser�o utilizadas apenas listas com JavaBeans.

Esta decis�o foi motivada pelo fato de que atualmente os sistemas das empresas s�o heterog�neos, podendo ter os dados provenientes de um banco de dados Oracle, de arquivos texto, de v�rios web services ou at� mesmo uma mescla de v�rios bancos de dados de diferentes fornecedores.

O modelo de classes a ser utilizado no exemplo � bastante simples e cl�ssico, sendo formado por apenas quatro entidades: a entidade Cliente cont�m os atributos b�sicos de um cliente; Pedido possui atributos referentes � data em que foi feito o pedido, a situa��o do pedido e uma lista de itens de pedido representado pela entidade ItemPedido; e Produto, que possui o c�digo, valor e descri��o do mesmo (Figura 1).

JavaBean: O JavaBean � uma classe Java simples que cont�m apenas atributos al�m dos respectivos m�todos de atribui��o de valores (setXxxx()) e de leitura (getXxxx()). Por isso s�o componentes de software altamente reutiliz�veis.N�o confunda com Entreprise JavaBeans (EJB), os EJBs s�o componentes espec�ficos da plataforma Java EE, e envolvem outros conceitos que os JavaBeans n�o possuem.

**Figura 1**. Diagrama de classes utilizado no exemplo do artigo.

Na Listagem 1 podemos observar a entidade Cliente codificada em Java. A Listagem 2 mostra a classe Pedido. Note que ela possui uma lista de ItemPedido (entidade implementada na Listagem 3). Al�m destas, como apresentado na Figura 1, um item de pedido deve estar obrigatoriamente associado a um Produto, cuja implementa��o � exibida na Listagem 4.

Listagem 1. C�digo da classe da entidade Cliente � Cliente.java.

package br.com.javamagazine.modelo;
 import java.io.Serializable;
  
  public class Cliente implements Serializable{
    private String nome;
    private String endereco;
    private String uf;
    // M�todos getters e setters omitidos
  }

Listagem 2. C�digo da classe da entidade Pedido � Pedido.java.

package br.com.javamagazine.modelo;
   
  import java.io.Serializable;
  import java.util.ArrayList;
  import java.util.Calendar;
  import java.util.List;
   
  public class Pedido implements Serializable{  
    private Cliente cliente;
    private List<ItemPedido> listaItensPedido;
    private Calendar data;
    private String situacao;
    // M�todos getters e setters omitidos
  }

Listagem 3. C�digo da classe da entidade ItemPedido � ItemPedido.java.

package br.com.javamagazine.modelo;
   
  import java.io.Serializable;
   
  public class ItemPedido implements Serializable {
   
    private Integer numeroItem;  
    private Produto produto; 
    private Double quantidade;  
    private Double valorTotalItem;
    // M�todos getters e setters omitidos
  }

Listagem 4. C�digo da classe da entidade Produto � Produto.java.

package br.com.javamagazine.modelo;
   
  import java.io.Serializable;
   
  public class Produto implements Serializable{ 
    private Long codigo;
    private String descricao; 
    private Double valor;
    // M�todos getters e setters omitidos
  }

Introdu��o ao iReport

Para que um relat�rio possa ser gerado � necess�rio uma fonte de dados (representada pela interface JRDataSource), os par�metros que podem ser necess�rios ao relat�rio e que s�o passados dentro de um HashMap (veja o quadro �Par�metros do JasperReports�) e o arquivo .jasper (o que � e como esse arquivo � criado ser� explicado logo mais).

O iReport � a principal ferramenta para cria��o visual dos arquivos .jrxml. Nestes arquivos encontramos as defini��es do relat�rio em formato XML. O arquivo .jasper � gerado automaticamente ap�s a compila��o do .jrxml pelo iReport.

� poss�vel criar o arquivo .jrxml usando apenas um editor de texto como o bloco de notas, por�m al�m da dif�cil tarefa de entender e escrever o XML no formato exigido pelo JasperReports, a dificuldade de posicionar os elementos de forma correta na p�gina � muito grande.

Ao criar um relat�rio no iReport temos dispon�veis v�rias se��es, conhecidas tamb�m por band. Elas s�o divis�es internas do relat�rio onde podemos inserir os elementos de texto e imagem. No iReport temos basicamente oito se��es:

Title: T�tulo do relat�rio. Pode ser impresso em uma p�gina separada;
Page Header: Cabe�alho de cada p�gina do relat�rio;
Column Header: Se��o exibida em cada p�gina que cont�m uma se��o Detail;
Detail: Nesta se��o ser� impresso todos os registros que o DataSource fornecer ao relat�rio. No nosso exemplo todos os pedidos da lista de JavaBeans ser�o mostrados aqui;
Column Footer: Exibido em cada p�gina que cont�m uma se��o Detail;
Page Footer: Rodap� de cada p�gina;
Summary: Se��o exibida no fim do relat�rio. Pode ser impresso em uma p�gina separada;
No Data: Se��o exibida quando n�o h� registros;
Background: Nesta se��o � poss�vel inserir uma imagem de fundo que ser� exibida em cada p�gina do relat�rio.

Na Figura 2 � poss�vel visualizar estas oito se��es em uma p�gina de um relat�rio em branco.

Par�metros do JasperReports

O JasperReports possui v�rios par�metros pr�-definidos que podem ser colocados no objeto Map passado como par�metro no m�todo fillReport() da classe JasperFillManager. Dessa forma substitu�mos os valores padr�es quando necessitamos usar um valor customizado para a execu��o do relat�rio.

Um exemplo de uso desses par�metros pr�-definidos pode ser visto na Listagem 8, mais precisamente no m�todo doProcess(), onde informamos no Map os par�metros SUBREPORT_DIR, REPORT_RESOURCE_BUNDLE e REPORT_LOCALE. Veja na Tabela Q1 qual a utilidade de cada um deles e de mais alguns par�metros.

Nome (Chave no Map)	Descri��o
REPORT_PARAMETERS_MAP	Inserir um objeto do tipo Map com os par�metros utilizados para preencher o relat�rio.
REPORT_LOCALE	Inserir um objeto do tipo java.util.Locale. Este par�metro � importante para que o JasperReports saiba corretamente qual o idioma utilizar no relat�rio.
REPORT_RESOURCE_BUNDLE	Inserir um objeto do tipo java.util.ResourceBundle contendo mensagens internacionalizadas.
REPORT_TIME_ZONE	Inserir um objeto do tipo java.util.TimeZone para formatar datas corretamente conforme o fuso hor�rio.
REPORT_CONNECTION	Inserir um objeto do tipo java.sql.Connection caso seu relat�rio necessite de uma conex�o com o banco de dados.
REPORT_FORMAT_FACTORY	Inserir um objeto do tipo FormatFactory para ser usado na formata��o de campos data e n�mero do relat�rio. Por exemplo, os n�meros podem ser exibidos com o separador decimal ponto ou o separador v�rgula, dependendo da localidade do usu�rio.
SUBREPORT_DIR	Informar neste par�metro o diret�rio onde est�(�o) armazenado(s) o(s) arquivo(s) jasper do(s) sub-relat�rio(s).

Tabela Q1. Lista de par�metros pr�-definidos.

O ambiente de programa��o

Neste artigo a IDE utilizada ser� o Eclipse Galileo, cujo instalador pode ser encontrado no endere�o http://eclipse.org/downloads/ � baixe a vers�o Eclipse for Java EE Developers. No site http://jasperforge.org/projects/ireport encontra-se o instalador do iReport 3.7.x para Windows. O Tomcat 6.0.26 ser� o container de JSP/Servlets utilizado para rodar o relat�rio na web e pode ser obtido em http://tomcat.apache.org/download-60.cgi.

A instala��o detalhada dos itens acima n�o faz parte do escopo deste artigo. Para instalar as ferramentas Eclipse e Tomcat, geralmente basta descompact�-los em um diret�rio, e o iReport para Windows fornece um instalador bem intuitivo. O leitor pode recorrer ao site do projeto caso ocorra algum problema no momento da instala��o.

Vale lembrar que no site da Java Magazine est� dispon�vel o c�digo do projeto desenvolvido neste artigo.

Desenhando o relat�rio

Depois que as classes foram criadas no Eclipse � necess�rio export�-las no formato de arquivo jar para que possam ser adicionadas ao classpath do iReport. Para isso, v� ao Eclipse e selecione a op��o File | Export, na janela que se abre selecione Java, depois Jar File e clique em Next. Na pr�xima janela selecione apenas o diret�rio src e informe no campo Jar File o nome do arquivo jar a ser criado (incluindo o diret�rio onde ele ser� gravado; no exemplo informaremos �D:\relatorios\Relatorio.jar�) e clique em Finish.

O relat�rio desenvolvido ter� um relat�rio principal para mostrar os pedidos e um relat�rio interno (sub-relat�rio) para listar os itens que est�o em cada pedido. O sub-relat�rio � constru�do de forma id�ntica ao relat�rio principal, por�m � feito pensando que ele estar� dentro de outro, geralmente sem as se��es Title, Page header, Page footer e summary.

Agora inicie o iReport, clique em New | File, selecione Report, depois clique em Blank A4 e clique em Open this template. Preencha os campos Report Name com valor �RelatorioPedidos� e Location com o diret�rio onde deseja gravar o arquivo jrxml, por exemplo �D:\relatorios�. Em seguida clique em Next e depois em Finish.

Feito isso, � necess�rio configurar o classpath para que o iReport consiga ler as nossas classes e seja poss�vel criar os campos. Ent�o acesse o menu Ferramentas | Op��es e na janela que ser� aberta selecione a aba Classpath (Figura 3). Clique no bot�o Add Jar para localiz�-lo, marque a op��o Reloadable e clique em OK.

**Figura 3**. Tela de configura��o do classpath no iReport.

Com as configura��es realizadas no classpath o iReport est� apto a ler os atributos das classes de modelo que foram criadas.

Agora precisamos criar os campos (fields) do relat�rio baseado nos atributos da classe Pedido, o que permitir� utiliz�-los em express�es. Eles ser�o usados no componente TextField para exibir os dados nas p�ginas dos relat�rios. A seguir veremos como esse procedimento � feito.

Clique no bot�o Report Query (), na janela que se abrir� v� � aba JavaBean Datasource e insira no campo Class name o nome completo da classe: br.com.javamagazine.modelo.Pedido, conforme a Figura 4. Depois clique no bot�o Read Attributes.

Adicionando
campos ao relat�rio com base na classe Pedido — **Figura 4**. Adicionando campos ao relat�rio com base na classe Pedido.

Ap�s a leitura dos atributos da classe devemos marcar os atributos que desejamos que se transformem em campos no relat�rio. Para este exemplo selecione: cliente, data, listaItensPedido e situacao. Clique em Add selected field(s) e depois em OK.

Com isso os campos adicionados ao relat�rio est�o prontos para serem utilizados e ficam dispon�veis no lado esquerdo do iReport.

Neste momento vamos come�ar a desenhar o nosso relat�rio. Selecione os campos: cliente, data e situa��o e arraste para dentro da se��o Detail, posicionando-os da forma que desejar. Ao fazer esse procedimento o iReport cria automaticamente TextFields com base nesses campos, preenchendo tamb�m de forma autom�tica a propriedade express�o dos TextFields.

Para que os dados sejam apresentados de forma correta no relat�rio, precisamos ajustar a propriedade Express�o de alguns TextFields. Isto � necess�rio pois o iReport coloca por padr�o na express�o o nome do campo. Podemos ter casos onde o campo representa um objeto JavaBean e o que queremos na verdade � mostrar o valor de atributo deste objeto. Neste artigo o campo cliente � um exemplo desse caso.

Siga os procedimentos a seguir para ajustar os campos do nosso relat�rio:

D� um duplo clique sobre o TextField do campo cliente e altere para $F{cliente}.getNome() para exibir no relat�rio o nome do cliente. Devemos utilizar a sintaxe $F{<nome do campo>} quando necessitamos acessar o valor de um campo do relat�rio;
Agora arraste mais um TextField da paleta de componentes e informe na propriedade Express�o $F{cliente}.getDocumento() para exibir no relat�rio o documento CPF/CNPJ do cliente;
Altere a express�o do campo data para $F{data}.getTime(), e tamb�m a propriedade pattern para dd/MM/yyyy para que a data saia nesse formato. Em seguida, mude na propriedade Classe de Express�o o valor para java.util.Date. Isto far� com que o TextField interprete de forma correta o retorno do m�todo getTime(). Sem essa altera��o o relat�rio n�o compilar�, pois o tipo do objeto que o m�todo ir� retornar � incompat�vel com o tipo que o campo espera;
Na se��o Detail adicione mais quatro TextFields que utilizaremos como label. Um ser� para o campo n�mero pedido, outro para a data do pedido, outro para o nome do cliente e um para o documento do cliente. Feito isso, altere a propriedade Express�o de cada TextField com os valores $R{rep.pedido}, $R{rep.data}, $R{rep.cliente} e $R{rep. documento}, respectivamente. Utilizamos a sintaxe $R{chave} para indicar ao JasperReports que � necess�rio buscar um valor no resource bundle;
Na se��o title adicione mais um componente TextField. Ele ser� usado para mostrar o t�tulo do relat�rio. Na propriedade Express�o informe o valor $R{rep.titulo};
Na se��o Page footer coloque um componente Page X of Y para mostrar a p�gina atual e a quantidade de p�ginas total. Uma curiosidade desse componente � que ele � composto por duas partes; em ambas encontramos a vari�vel $V{PAGE_NUMBER}. A primeira parte mostra o n�mero da p�gina atual e a outra o total de p�ginas do relat�rio. Mas se a vari�vel � a mesma, como s�o exibidos valores diferentes? A diferen�a entre as partes � o tempo de avalia��o da express�o. A primeira parte � avaliada no momento em que o JasperReports est� processando a p�gina, e a segunda � avaliada em tempo de relat�rio, ou seja, no momento em que todo o relat�rio j� estiver preenchido.

Resource Bundle: � um mecanismo utilizado quando o programa necessita de um recurso, uma String, por exemplo, que seja espec�fico da localidade do usu�rio. Dessa forma o programa poder� ser utilizado por pessoas que falam diversas l�nguas e de v�rios pa�ses do mundo.

Al�m do que foi apresentado, est�o dispon�veis na paleta de componentes do iReport algumas ferramentas para desenho de linhas, elipses, ret�ngulos e inser��o de imagens dentro do relat�rio. Estas ferramentas podem ser utilizadas para melhorar o layout do relat�rio.

Adicionando um sub-relat�rio

Nesta etapa vamos adicionar ao relat�rio um sub-relat�rio que ir� listar os produtos de cada pedido. Para isso, na paleta de componentes arraste o componente Subreport () para a se��o Detail. Logo em seguida o assistente para cria��o do sub-relat�rio ser� aberto; selecione uma p�gina A4 e prossiga clicando em pr�ximo aceitando os valores padr�o at� o passo seis, que requer uma aten��o especial. Precisamos preencher os campos dessa etapa conforme a Figura 5. � importante que o sub-relat�rio fique no mesmo diret�rio do relat�rio principal, no nosso exemplo em �D:\relatorios�.

Dados
do sub-relat�rio — **Figura 5**. Dados do sub-relat�rio.

O passo sete tamb�m � muito importante para o funcionamento correto do sub-relat�rio. Nesta tela � definida de que forma os dados ser�o passados do relat�rio principal para o sub-relat�rio; o nosso exemplo utilizar� uma express�o de fonte de dados. Ent�o selecione a op��o Use a JRDatasource expression e insira no campo o valor new net.sf.jasperreports.engine.data.JRBeanCollectionDataSource($F{listaItensPedido}). Esta express�o nos permite utilizar a lista de itens de pedido contido na classe Pedido como uma fonte de dados � neste caso uma fonte de dados de JavaBeans.

Para adicionar os campos referentes ao item de pedido, use a mesma t�cnica adotada para criar os campos da classe Pedido no relat�rio principal. Adicione ao sub-relat�rio os atributos da classe ItensPedido.

O layout final do sub-relat�rio ficar� como ilustrado na Figura 6. � normal que durante o desenho o relat�rio fique com um aspecto bagun�ado, com textos sobrepostos ou cortados. No entanto, em tempo de execu��o isso n�o acontecer�, pois iremos alimentar o relat�rio com valores compat�veis com o tamanho do campo.

i18N � Internacionalizando o relat�rio

Os relat�rios s�o facilmente internacionalizados, ou seja, apresentados de forma espec�fica ao pa�s e a l�ngua do usu�rio usando o recurso de resource bundle existente na plataforma Java. Para utilizar este recurso temos que colocar em um ou mais arquivos .properties um conjunto de chaves e valores de mensagens que ser�o utilizadas no relat�rio. O nome desse arquivo � formado pelo prefixo, idioma, sigla do pa�s e a extens�o .properties. Por exemplo, se quis�ssemos um arquivo para as mensagens em portugu�s do Brasil, ter�amos Mensagens_pt_BR.properties.

Para configurar os relat�rios (principal e sub-relat�rio) para ler estes arquivos, abra as propriedades do relat�rio clicando sobre a margem da p�gina do mesmo com o bot�o direito e selecione Propriedades. Na janela que se abre, preencha o campo Resource Bundle com o nome do pacote onde se encontrar� o arquivo mais o prefixo do nome do arquivo, neste exemplo o valor ser� br.com.javamagazine.resource.Mensagens.

Agora � necess�rio informar ao JasperReports um objeto do tipo java.util.ResourceBundle contendo os textos internacionalizados que o JasperReports ir� usar para montar o relat�rio.

O par�metro pr�-definido REPORT_RESOURCE_BUNDLE ser� colocado no HashMap de par�metros dessa forma:

parametros.put("REPORT_RESOURCE_BUNDLE", ResourceBundle
    .getBundle("br.com.javamagazine.resource.Mensagens"));

Para o desenvolvimento do relat�rio, coloque os arquivos .properties no mesmo diret�rio dos arquivos .jrxml para que o iReport possa l�-los e utiliz�-los no relat�rio. Caso contr�rio, ele ir� reclamar que n�o encontrou estes arquivos e a compila��o falhar�.

Para este exemplo crie dois arquivos de internacionaliza��o no Eclipse, acessando o menu File | New > File. Para o primeiro arquivo, que conter� as mensagens em portugu�s do Brasil, informe o nome Mensagens_pt_BR.properties; para o segundo, que conter� mensagens em ingl�s americano, informe o nome Mensagens_en_US.properties. Lembre-se de que letras mai�sculas e min�sculas fazem diferen�a. As Listagens 5 e 6 mostram trechos dos arquivos criados.

Listagem 5. Fragmento do arquivo Mensagens_pt_BR.properties.

rep.titulo=Relat�rio de Pedidos Pendentes
  subrep.numitem=Item
  subrep.desc=Descri��o
  subrep.valor=Valor
  subrep.qtd=Quantidade
  rep.pagina=P�gina 
  rep.de= de

Listagem 6. Fragmento do arquivo Mensagens_en_US.properties.

rep.titulo=Report of Pending Orders
  subrep.numitem=Item#
  subrep.desc=Description
  subrep.valor=Value
  subrep.qtd=Quantity
  rep.pagina=Page 
  rep.de= of

Para testar o relat�rio com outro idioma no iReport, acesse o menu Ferramentas | Op��es, v� na aba Compila��o e Execu��o e altere o campo Report Locale para outro de sua prefer�ncia. Para efetuar a altera��o no programa, coloque no HashMap de par�metros o par�metro pr�-definido REPORT_LOCALE e um objeto java.util.Locale. A seguir apresentamos um exemplo para criar um objeto Locale representando o idioma ingl�s americano:

parametros.put("REPORT_LOCALE", new Locale("en", "US"));

Na Figura 7 vemos a vers�o final do relat�rio principal ap�s todos os ajustes.

**Figura 7**. Layout do relat�rio de pedidos.

Visualizando o relat�rio

Para verificar como ficou o layout do relat�rio clique em Preview � localizado ao lado dos bot�es Designer e XML. Certifique-se que no menu Preview a op��o PDF esteja selecionada para que o relat�rio seja aberto no leitor de PDF instalado em seu computador.

No momento que estamos desenhando o relat�rio � poss�vel visualizar apenas os labels dos campos, pois nos lugares dos valores que seriam preenchidos atrav�s da lista de objetos Pedido ser� impresso null. A seguir veremos como alimentar o relat�rio utilizando o JRBeanCollectionDataSource.

Executando o relat�rio em uma aplica��o desktop

J� temos o relat�rio desenhado e os dois arquivos .jasper criados no diret�rio D:\relatorios (um do relat�rio principal e outro do sub-relat�rio), dessa forma podemos utiliz�-los dentro de uma aplica��o Java. Para isso, crie no Eclipse um novo projeto Java, acessando o menu File | New > Java Project e informando o nome �Relatorio�.

Antes de escrevermos o c�digo � necess�rio incluir no classpath do projeto os jars do JasperReports e o jar que cont�m as classes de modelo. Para resolver esta pend�ncia, acesse as propriedades do projeto teclando Alt+Enter com o projeto selecionado, clique na op��o Java build path e v� na aba Libraries. Clique no bot�o Add External JARs, selecione em <Diret�rio_Instala��o_Ireport>/ireport/modules todos os arquivos jar e clique em Ok. Depois adicione o jar com as classes de modelo, que no nosso exemplo foi criado em D:\relatorios\Relatorio.jar.

Descreveremos abaixo os seis passos necess�rios para rodar o relat�rio criado em nossa aplica��o:

1. Obter um InputStream do arquivo .jasper do relat�rio principal. Caso o caminho informado esteja errado, o InputStream vai ficar com valor null e na chamada do m�todo fillReport() um NullPointerException ser� lan�ado;

2. Obter uma lista de objetos Pedido. Neste exemplo usaremos uma classe chamada PedidoDAO que cria um ArrayList de Pedidos fict�cios. As classes DAO (Data Access Object) representam um padr�o de projeto que visa separar as regras de neg�cios do acesso a dados. Neste padr�o, as classes possuem a responsabilidade de tratar a entrada e a sa�da dos dados do sistema;

3. Criar um objeto JRBeanCollectionDataSource. Este ser� o datasource do relat�rio;

4. Instanciar um HashMap e preench�-lo com os par�metros necess�rios para nossa aplica��o (veja o quadro �Par�metros do JasperReports�);

5. Utilizar o m�todo fillReport() da classe JasperFillManager para preencher o relat�rio. Esse m�todo devolve um objeto do tipo JasperPrint que pode ser usado, entre outras coisas, para visualiza��o no JasperViewer (utilit�rio nativo do JasperReports para apresenta��o de relat�rios) ou para exportar o relat�rio em PDF, como veremos mais adiante;

6. No �ltimo passo vamos exibir o relat�rio na tela utilizando o JasperViewer.

A Listagem 7 mostra em c�digo os seis passos citados acima.

Listagem 7. C�digo para gerar o relat�rio e exibir em modo desktop.

// Primeiro passo: Obter InputStream do arquivo jasper
  String caminhoRelJasper = "D:\\relatorios\\RelatorioPedidos.jasper";
      
  InputStream relJasper = EmissorRelatorios.class
    .getResourceAsStream(caminhoRelJasper);
   
  // Segundo passo: Obter lista com objetos Pedido. Para este exemplo foi criado um PedidoDAO
  List<Pedido> dadosRelatorio = emissorRelatorios.obterDadosRelatorio();
          
  // Terceiro passo: Criar o data source
  JRBeanCollectionDataSource ds = new JRBeanCollectionDataSource(dadosRelatorio);
   
  // Quarto passo: criar HashMap com os par�metros dos relat�rios
  Map<String, Object> parametros = new HashMap<String, Object>();
   
  // Caminho do diret�rio onde est� o jasper do sub-relat�rio
  parametros.put("SUBREPORT_DIR", "D:\\relatorios\\");
  parametros.put("REPORT_RESOURCE_BUNDLE", ResourceBundle
    .getBundle("br.com.javamagazine.resource.Mensagens"));
  parametros.put("REPORT_LOCALE", Locale.US);
   
  JasperPrint impressao = null;
  try {
    // Quinto passo: preencher o relat�rio
    impressao = JasperFillManager.fillReport(caminhoRelJasper, parametros, ds);
    // Sexto passo: mostrar o relat�rio
    JasperViewer viewer = new JasperViewer(impressao, true);
    viewer.setVisible(true);
  }
  catch (JRException e) {
    System.out.println(e.getMessage());
  }

A Figura 8 mostra o resultado do nosso trabalho: o relat�rio devidamente preenchido com os dados da lista de objetos de pedido.

**Figura 8**. Visualiza��o do relat�rio com JasperViewer.

Exibindo o relat�rio na web

At� esta etapa o relat�rio foi executado somente em modo desktop. Agora vamos executar esse mesmo relat�rio em uma aplica��o web. Para isso, crie no Eclipse um projeto web acessando o menu File | New > Dynamic Web Project e informando o nome �RelatorioWeb�. Como este � um novo projeto, � necess�rio fazer os mesmos ajustes realizados no classpath do projeto desktop.

Feito isso, vamos criar um servlet pressionando Ctrl+N no Eclipse. Na janela que se abrir, selecione a op��o Servlet e clique em Next. Informe no campo Java package br.com.javamagazine.servlet e no campo Class name EmissorRelatorioServlet.

Na Listagem 8 podemos observar o c�digo do servlet que usaremos para gerar o relat�rio em PDF, e envi�-lo � atrav�s do HttpServletResponse � para o navegador.

A principal diferen�a do relat�rio web para o desktop � que ao inv�s de usar a classe JasperViewer, foi utilizada a classe JasperExportManager para escrever os bytes no OutputStream do HttpServletResponse.

Listagem 8. Servlet para gerar o relat�rio na web.

package br.com.javamagazine.servlet;
   
  // Imports da classes foram omitidos
   
  public class EmissorRelatorioServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;
   
    public EmissorRelatorioServlet() {
      super();
    }
   
    protected void doProcess(HttpServletRequest request,
        HttpServletResponse response) throws ServletException, IOException {
      PedidoDAO pedidoDAO = new PedidoDAO();
   
      ServletOutputStream outputStream = response.getOutputStream();
      
      // Obtem o caminho para o diret�rio jasper
      String realPath = request.getSession().getServletContext().getRealPath(
        "/WEB-INF/jasper")
        + System.getProperty("file.separator");
      // Caminho do .jasper do relatorio
      String caminhoRelJasper = realPath + "RelatorioPedidos.jasper";
      // Lista com java beans    
      List<Pedido> dadosRelatorio = pedidoDAO.obterDadosRelatorio();
      
      // Stream com o .jasper
      InputStream relJasper = EmissorRelatorios.class
        .getResourceAsStream(caminhoRelJasper);
   
      // Cria o DataSource
      JRBeanCollectionDataSource ds = new JRBeanCollectionDataSource(
        dadosRelatorio);
   
      // Par�metros dos relat�rios
      Map<String, Object> parametros = new HashMap<String, Object>();
      // Caminho do diret�rio onde est� o jasper do sub-relat�rio
      parametros.put("SUBREPORT_DIR", realPath);
      parametros.put("REPORT_RESOURCE_BUNDLE", ResourceBundle
        .getBundle("br.com.javamagazine.resource.Mensagens"));
      parametros.put("REPORT_LOCALE", request.getLocale());
   
      JasperPrint impressao = null;
      try {
        // Ajusta o response
        response.setHeader("Content-Disposition", "inline; filename=\""
          + "RelatorioPedidos.pdf" + "\"");
        response.setHeader("Cache-Control", "no-cache");
        response.setContentType("application/pdf");
        
        // Gera o relat�rio
        impressao = JasperFillManager
          .fillReport(caminhoRelJasper, parametros, ds);
        // Escreve no OutputStream do response
        JasperExportManager.exportReportToPdfStream(impressao, outputStream);
        outputStream.close();
      }
      catch (JRException e) {
        System.out.println(e.getMessage());
      }
    }
   
    protected void doGet(HttpServletRequest request, HttpServletResponse response)
      throws ServletException, IOException {
      doProcess(request, response);
    }
   
    protected void doPost(HttpServletRequest request, HttpServletResponse response)
      throws ServletException, IOException {
      doProcess(request, response);
    }
  }

Ap�s a cria��o da servlet, localize no projeto RelatorioWeb o diret�rio WEB-INF e crie um diret�rio chamado jasper para armazenar os dois arquivos .jasper que criamos. Copie os arquivos RelatorioPedidos.jasper e RelatorioPedidos_ItensPedido.jasper para este diret�rio, desta forma a servlet conseguir� encontr�-los.

Para testarmos a servlet e visualizar o relat�rio, � necess�rio colocar o Tomcat no ar. Para isso, localize a aba Servers na parte inferior do Eclipse e clique no bot�o Start the Server (). Em seguida, abra um navegador web, e acesse a URL http://localhost/RelatorioWeb/EmissorRelatorioServlet para chamar a servlet que gera o PDF. O resultado desta execu��o pode ser visto na Figura 9.

**Figura 9**. Visualiza��o do relat�rio pela web.

Dependendo das configura��es do navegador, o PDF poder� ser apresentado dentro dele. Se isso n�o ocorrer ser� solicitado que o usu�rio baixe o arquivo. Se o leitor desejar for�ar o download do arquivo, substitua no par�metro Content-Disposition do m�todo setHeader() � da classe HttpServletResponse � a diretiva inline para attachment. Como n�o podemos garantir que o computador do usu�rio tenha um leitor de PDF instalado para que o browser apenas exiba o relat�rio, o efeito inverso n�o � poss�vel.

Conclus�o

Como vimos, o iReport � uma ferramenta que oferece �tima produtividade e flexibilidade para o desenvolvimento de relat�rios bastante sofisticados. Ele aceita diversas fontes de dados para gera��o de relat�rios que podem ser executados tanto em ambientes desktop quanto web.

O iReport � muito vers�til, por isso n�o se limita apenas a cria��o de relat�rios tradicionais como o do exemplo. Muitas empresas adotaram esta ferramenta para cria��o e emiss�o de segunda via de faturas, etiquetas, recibos e termos de contratos para que os pr�prios clientes possam obter estes documentos em PDF nos sites de autoatendimento.

Neste artigo exploramos apenas os dois recursos mais utilizados, o sub-relat�rio e a internacionaliza��o. Fica como sugest�o ao leitor aprender a criar relat�rios de tabula��o cruzada e relat�rios com gr�ficos.

Links

Confira outros conte�dos:

Introdu��o ao JDBC

Novidades do Java

Teste unit�rio com JUnit

Por Roberto Em 2010

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

Paulo Lima

N�vel 2

boa tarde, eu estou com um problema em um relatorio, eu tenho uma classe Paciente que dentro dela tem o objeto Sexo, eu preciso acessar um atributo que tem dentro do objeto sexo, como fa�o para o acessar ? lembrando que estou trabalhando com uma collection e n�o com sql

há +1 ano

Ver coment�rio anterior

Marcio Souza

DevMedia

Ol� Paulo.

L� no Dataset onde voc� seleciona qual a cole��o que vai popular o relat�rio, voc� tem que selecionar os campos da cole��o que v�o aparecer no relat�rio.

Entre esses campos ter� o objeto "sexo" do tipo xxx.xxx.Sexo. O que vai fazer � criar nesse dataset um novo campo, "sexo.tipo" e adicionar o tipo de dado dele como java.lang.String. E no relat�rio voc� adiciona o "sexo.tipo" ao inv�s de "sexo".

D� uma olhada nessa imagem: https://ibb.co/H7Xj6Jh

há +1 ano

Thiago Silva

N�vel 0

Ol�, o artigo � bom, porem apenas funciona passando um lista, como poder�amos passar um paramentro, tipo buscar por (id) e retorna apenas um item da lista?

há +1 ano

Marcio Souza

DevMedia

Ol� Thiago.
Nesse caso basta retornar para o relat�rio uma cole��o com apenas 1 resultado. Por exemplo, essa opera��o:

List<Pedido> dadosRelatorio = pedidoDAO.obterDadosRelatorio();

retorna uma lista, n�o importa quantos registros tem na lista, todos ser�o apresentados no relat�rio. Se quer apenas um item, crie no seu DAO um m�todo que retorne apenas 1 item na lista.

há +1 ano

Respondido em tempo real

Maxwell Kaiser

N�vel

Artigo muito bom! Me ajudou a solucionar e entender melhor como funciona a cria��o de relat�rios de maneira simples.

há +1 ano

Black November

Desconto exclusivo para as primeiras 200 matrículas!

Pagamento integral

12x no cartão

De: R$ 69,00

Por: R$ 59,00

Total: R$ 708,00

Garanta o desconto

Formação FullStack Completa
Carreira Front-end I e II, Algoritmo e Javascript, Back-end e Mobile
+10.000 exercícios gamificados
+50 projetos reais
Comunidade com + 200 mil alunos
Estude pelo Aplicativo (Android e iOS)
Suporte online
12 meses de acesso

Pagamento facilitado

Cobrado mensalmente no cartão

De: R$ 79,00

Por: R$ 64,00 /mês

Tempo mínimo: 12 messes

Garanta o desconto

Formação FullStack Completa
Carreira Front-end I e II, Algoritmo e Javascript, Back-end e Mobile
+10.000 exercícios gamificados
+50 projetos reais
Comunidade com + 200 mil alunos
Estude pelo Aplicativo (Android e iOS)
Suporte online
Não compromete o limite do seu cartão

<Perguntas frequentes>

Carreira

Metodologia

Assinatura e Pagamentos

Cadastro

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

Gerando relat�rios com iReport - Java Magazine 84

Neste artigo veremos os principais recursos do iReport para cria��o de relat�rios tendo como premissa a independ�ncia da fonte de dados.

Introdu��o ao iReport

Par�metros do JasperReports

O ambiente de programa��o

Desenhando o relat�rio

Adicionando um sub-relat�rio

i18N � Internacionalizando o relat�rio

Visualizando o relat�rio

Executando o relat�rio em uma aplica��o desktop

Exibindo o relat�rio na web

Conclus�o

Confira outros conte�dos:

Introdu��o ao JDBC

Novidades do Java

Teste unit�rio com JUnit

<Perguntas frequentes>

Nossos casos de sucesso