Usando XML em Java com SAX e XStream

Com a quantidade imensa de linguagens de programaç�o dispon�veis atualmente no mercado, faz-se necess�rio criar uma ponte de comunicaç�o comum entre estas, uma forma de comunicaç�o comum que independa da linguagem e que torne essa comunicaç�o poss�vel.

Um caso comum seria a comunicaç�o de um Sistema Banc�rio desenvolvido em Java com o sistema de uma empresa de entrega de encomendas desenvolvido em .NET, onde o sistema banc�rio enviaria a remessa de cart�es que devem ser entregues e a empresa de entrega ir� se encarregar de realizar essa tarefa. Existem v�rias formas de concretizar essa comunicaç�o entre linguagens distintas, e algumas delas s�o:

1. Atrav�s de um arquivo XML;
2. Atrav�s de um WebService;
3. Atrav�s de requisiç�es HTTP;
4. Atrav�s de arquivo de texto puro.

Essas s�o apenas quatro formas poss�veis e muito utilizadas para comunicaç�o entre sistemas distintos, onde cada uma tem sua peculiaridade. No caso do WebService, os m�todos do outro sistema s�o acessados diretamente, com o HTTP s�o enviados par�metros via requisiç�o HTTP, geralmente por POST e o texto puro � o m�todo menos organizado para que isso seja feito, pois n�o possui nenhuma definiç�o padr�o, a n�o ser a definida pela pr�pria empresa.

Neste artigo estudaremos o XML em Java e veremos como funciona a sua estrutura, como cri�-lo e como fazer a leitura em Java.

Entendendo o XML

O XML foi formalizado pela W3C afim de padronizar a estrutura de um documento para que todo tipo de linguagem seja capaz de entender, tecnicamente falando, uma linguagem de marcaç�o.

Alguns dos princ�pios b�sicos do XML, regidos pela W3C s�o:

• Separaç�o de conte�do da formataç�o;
• Simplicidade e legibilidade;
• Possibilidade de criaç�o de tags novas;
• Criaç�o de arquivos para validaç�o (DTDs e schemas).

A vantagem em usar o XML est� no fato de que a interpretaç�o do mesmo � comum a todos, independente da linguagem utilizada. E a maior desvantagem est� no uso de existirem formatos mais simples como JSON, por exemplo, pois mesmo o XML parecendo simples para os mais experientes, ainda h� formatos mais simples ainda. Pois bem, vamos nos ater as funcionalidades provenientes do XML, como mostra a Listagem 1.

O cabeçalho acima �� � padr�o de todo XML e logo abaixo temos a descriç�o de nossas pr�prias tags e seus valores. Veja que ele segue uma estrutura hier�rquica de pai-filho:

A tag 'receita' � a nossa �tag pai� e possui internamente as tags titulo, ingredientes e instruç�es. A tag ingredientes possui a tag ingrediente e a tag instruç�es possui a tag passo. Temos ent�o a seguinte ordem:

1. � receita → titulo, ingredientes, instrucoes�
2. �ingredientes → ingrediente
3. �instrucoes → passo�

Poder�amos ter duas receitas no mesmo XML, bastando que a outra tag receita seja aberta no mesmo n�vel hier�rquico da primeira tag receita. O mesmo poderia ocorrer com as outras, como titulo, instruç�es, ingredientes, passo e etc.

XML em Java

H� pelo menos tr�s formas de realizar a leitura de XML em Java:

1. Utilizar regex do pacote java.util.regex e criar seu pr�prio algoritmo para realizar a leitura de XML, o que � bem pouco pr�tico e um tarefa nada trivial;
2. Usando a API SAX, que veremos mais adiante;
3. Usando o Xstream que tamb�m veremos mais adiante;

Usando SAX para ler XML em Java

O SAX � uma API para ler dados em XML e funciona como um Parser, pois ele analisa a estrutura de dados contida no XML. Este l� de forma sequencial n�o permitindo leituras aleat�rias ou voltar a um trecho j� lido, e a cada lido de um novo elemento � disparado um evento que veremos mais a seguir.

A vantagem da leitura sequencial � que torna o processo mais r�pido, visto que n�o h� necessidade de conhecer todo documento, apenas o trecho que est� sendo lido. O SAX � perfeito quando estamos trabalhando com a leitura de pequenos trechos de XML e n�o h� necessidade realizar leituras aleat�rias.

O SAX dispara um evento a cada trecho lido, s�o eles: no in�cio da leitura do documento, no final da leitura do documento, no in�cio de um elemento, no fim do elemento e na leitura dos valores.

Para que isso seja poss�vel temos que criar uma classe que estenda de DefaultHandler e que poder� sobreescrever os m�todos desejados com a l�gica que desejamos executar. Para entender como funciona o Handler, vamos primeiro mostrar o MyHandler, de acordo com a Listagem 2 e depois detalharemos m�todo a m�todo.

A Listagem 2 possui um Handler completo que ser� usado pelo SAX para monitorar os eventos ocorridos no decorrer da leitura do nosso XML. Ap�s a leitura da Listagem 2 e localizaç�o dos m�todos, n�s explicaremos nas listagens abaixo cada um destes m�todos e seu objetivo.

Veja que temos dois atributos: estruturaLida e valorAtual. A estruturaLida ir� armazenar tudo que foi lido at� o momento no XML, enquanto que o valorAtual ir� armazenar sempre o valor que est� sendo lido.

Optamos por usar StringBuffer por seu desempenho oferecido e n�o usamos a String por ser uma classe imut�vel, ou seja, seu valor n�o pode ser alterado ao contr�rio do que muitos pensam. Isso significa que ao concatenar um valor em uma String na verdade voc� est� criando uma nova String em mem�ria, mesmo que esteja atribuindo o resultado para ela mesma. Isso ocorre porque Strings s�o imut�veis. Fique atento a isso para n�o cometer este erro.

O m�todo startDocument() da Listagem 3 � um dos eventos que s�o chamados � no in�cio da leitura do XML, aqui poder�amos colocar qualquer l�gica que desej�ssemos quando a leitura do XML começasse. Por exemplo, suponha que na leitura de algum novo XML dev�ssemos enviar um Email notificando algu�m sobre essa leitura, poder�amos colocar essa l�gica no startDocument().

Assim como temos evento disparado no in�cio da leitura do XML, temos o eventos disparado no final da leitura do XML, como o apresentado na Listagem 4. Poder�amos colocar l�gicas que ser�o executadas quando a leitura terminar como, por exemplo, uma flag indicando se um determinado XML foi lido.

Para XML's extensos, esses dois eventos podem ser muito importantes, pois poder�amos evitar concorr�ncia de leituras colocando uma flag no in�cio da leitura indicando que o XML j� est� sendo lido e uma flag no final da leitura indicando que o XML j� foi lido, assim evitamos que dois leitores possam tentar abrir o mesmo arquivo.

O startElement() da Listagem 5 � chamado no in�cio de cada elemento. Na Listagem 1, por exemplo, o in�cio de um elemento poderia ser o <receita nome=�p�o�...>. Isso significa que no in�cio de cada elemento este evento ser� chamado.

A vari�vel tag armazena o nome da tag de in�cio do elemento e, neste exemplo que demos, seria o valor �receita�. A cada in�cio de um novo elemento n�s adicionamos dentro da vari�vel estruturaLida e logo em seguida mostramos a estruturaLida at� o momento com seus atributos, se houverem. Os atributos representados pela classe Attributes correspondem as propriedades das tags. Por exemplo, na Listagem 1 os atributos da tag receita s�o 'nome', 'tempo_de_preparo' e 'tempo_de_cozimento'.

O evento da Listagem 6 � chamado na leitura dos valores que as tags possuem. Por exemplo, na Listagem 1 o valor da tag titulo � �P�o Simples�. A cada chamada deste evento n�s colocamos o valor da tag dentro da vari�vel valorAtual, que ser� mostrado na finalizaç�o da tag, ou seja, no m�todo endDocument().

Agora iremos aplicar nosso MyHandler em um SAX e fazer a leitura do XML mostrado na Listagem 1, como mostra a Listagem 7.

O primeiro passo para usar o SAX � cri�-lo usando o Factory SAXParserFactory. Com essa classe n�s retornamos uma nova inst�ncia do objeto SAXParser e j� podemos utiliz�-lo para leitura do XML. O objeto �parser� possui um m�todo chamado �parser()� que recebe um InputSource e um DefaultHandler, onde o InputSource faz refer�ncia ao arquivo XML que iremos ler, e o DefaultHandler pode ser o nosso MyHandler que ir� manipular os eventos de leitura de XML.

Ao usar o �new InputSource()� n�s dizemos onde est� localizado nosso XML e passamos este objeto ao m�todo parser() logo abaixo. Quando o m�todo parser() � chamado, a leitura � iniciada e os eventos começam a serem disparados. Veja na Listagem 8 o resultado da Listagem 7 usando nosso receita.xml que � a Listagem 1.

Usando Xstream

Uma alternativa para o SAX � o Xstream, perfeito para trabalhar com beans e persist�ncia de dados, tornando essa tarefa muito mais simples e voc� j� entender� o porque.

Voc� deve ter percebido que o SAX � simples e possibilita uma infinidade de soluç�es, at� mesmo a escrita e leitura de beans, mas essa tarefa pode ser nada trivial quando tratamos de beans com propriedades complexas que possuem outros beans internos, ou seja, beans dentro de beans. O Xstream est� aqui para resolver este problema.

Em nosso caso queremos pegar um bean qualquer, com propriedades simples e queremos transform�-lo em um XML, como mostra a Listagem 9.

O bean acima � simples e cont�m apenas propriedades simples para que possamos ver de forma r�pida e f�cil o que o Xstream ir� criar.

Vamos entender o que foi feito na Listagem 10: criamos nosso objeto Cliente e configuramos todos os seus valores, depois criamos um objeto Xstream passando um outro objeto DomDriver, que n�o � nosso foco agora entrar a fundo sobre o DomDriver, mas precisamos saber que deveremos passar o driver desejado para fazer a geraç�o/leitura do nosso XML com as seguintes possibilidades dispon�veis: SAX, DOM, DOM4J e outros. Cada um possui sua peculiaridade, consumindo mais ou menos mem�ria, sendo mais r�pido ou mais lento e etc.

O importante � notar o qu�o simples � criar o Xstream e usando o m�todo toXML() passamos o objeto cliente que ser� convertido automaticamente para uma String em XML. Veja o nosso resultado na Listagem 11.

Assim como podemos converter um objeto para XML, podemos fazer o inverso atrav�s do m�todo fromXML(). Por isso, logo no in�cio dissemos que o Xstream � �timo para quem deseja trabalhar com convers�es de beans entre XML. Se voc� fosse implementar a mesma funcionalidade no SAX, com certeza levaria um bom tempo, afinal estamos falando aqui de qualquer bean e n�o apenas um bean espec�fico.

Na Listagem 12 temos o processo inverso do que foi mostrado no m�todo toXML(), convertemos um XML (String) em um objeto Cliente, que poderia ser qualquer outro objeto e n�o apenas o Cliente. Isso � muito comum na Nota Fiscal Eletr�nica, por exemplo, pois como j� � de praxe, s� pode ser enviado XML para validaç�o de notas fiscais e o Xstream pode ser um aliado muito �til nestas horas.

O Xstream n�o � uma biblioteca padr�o do JDK e para utiliz�-lo voc� ter� que importar um arquivo jar. Basta que voc� coloque o mesmo no classpath do seu projeto e comece a usar o Xstream.

O StAX � uma evoluç�o do SAX com algumas melhorias e ele n�o precisa de Handler. Ele usa uma t�cnica conhecida por Pull Parser, onde o cliente quem pega os dados do StAX e n�o o Handler como � no SAX, que usa a t�cnica Push Parsing.

Vimos neste artigo um review geral sobre XML quais as formas de utiliz�-lo em Java com os recursos: SAX e Xstream. Ambos s�o �timos em seus cen�rios, sendo o SAX para leituras r�pidas de XML pequenos e o Xstream quando estamos trabalhando com beans. Um objeto de NotaFiscal poderia facilmente ser convertido para XML para fins legais usando o Xstream.

O qu�o �til � cada recurso em um cen�rio espec�fico � voc� quem vai analisar. Por isso, � muito importante o entendimento de ambos para poder aplic�-los de forma correta. Apresentamos tamb�m um recurso conhecido como StAX para leitura/escrita de XML.