Implementando um Web Service com JEE e utiliza��o da API SAX

Neste artigo apresento o Marcos de Melo Siega, que pode ser contatado pelo e-mail�marcosmsiega@gmail.com. O Marcos foi meu aluno em algumas disciplinas de sua graduaç�o e est� concluindo o �ltimo per�odo do curso de Tecnologia em An�lise e Desenvolvimento de Sistemas da UTFPR campus Medianeira neste primeiro semestre de 2013. Trabalhou recentemente no setor de desenvolvimento de sistemas da empresa Itaipu Binacional.

1. Introduç�o

Um Web Service (Serviço Web) � um sistema de software projetado para suportar interaç�o m�quina-a-m�quina interoper�veis sobre uma rede. Ele tem uma interface descrita em um formato process�vel por m�quina (especificamente WSDL). Outros sistemas interagem com o Web Service de uma maneira prescrita por sua descriç�o usando mensagens SOAP, normalmente transmitidas por meio do protocolo HTTP com uma serializaç�o XML e em conjunto com outros padr�es relacionados � Web [W3C2004].

Este artigo apresenta detalhes da implementaç�o de um Web Service utilizando a plataforma JEE6, o uso da API SAX para realizar a interpretaç�o do descritor do serviço criado e a implementaç�o de duas diferentes aplicaç�es que far�o o consumo do serviço criado, uma aplicaç�o em C# e outra utilizando a tecnologia Java.

2. Implementaç�o

Esta seç�o apresenta as etapas sugeridas para a criaç�o de um Web Service sobre a plataforma JEE6, bem como a descriç�o dos recursos utilizados no processo de desenvolvimento.

2.1. Requisitos

A seguir est�o listados os recursos necess�rios para a composiç�o do ambiente de desenvolvimento:

2.2. Implementaç�o

Com o ambiente de desenvolvimento instalado e corretamente configurado ser� dado in�cio ao processo de implementaç�o do Web Service.

2.2.1 Criaç�o do Projeto

Para começar, criou-se um Novo Projeto no IDE NetBeans, e optou-se pelo tipo Aplicaç�o Enterprise, como demostrado na Figura 1.

Figura 1: Janela do wizard para criaç�o de um Novo Projeto na IDE NetBeans

Em seguida, faz-se necess�ria a especificaç�o do nome e da localizaç�o do projeto, conforme Figura 2.

Figura 2: Janela do wizard para definiç�o do nome e da localizaç�o do projeto criado

Para finalizar, � necess�rio realizar configuraç�es de caracter�sticas importantes do Novo Projeto. Definiu-se qual servidor de aplicaç�o hospedar� o projeto, a vers�o da plataforma Java utilizada, a ativaç�o da injeç�o de contextos e depend�ncias, o n�vel do c�digo-fonte para adaptar-se ao JEE 6 e optou-se pela criaç�o autom�tica de um m�dulo EJB, conforme Figura 3.

Figura 3: Janela do wizard para definiç�o das configuraç�es finais do Novo Projeto

2.2.2. Implementaç�o do Web Service

Tendo criado o projeto, inicia-se a implementaç�o do Serviço Web. Para começar, um novo Bean de Sess�o (EJB) deve ser gerado dentro do m�dulo criado automaticamente na definiç�o o Novo Projeto, conforme Figura 4, e este servir� de base para geraç�o autom�tica do Serviço Web.

Um nome para o novo EJB deve ser dado, a localizaç�o do Bean deve ser definida, e deve ser marcado como sendo Stateless, ou seja, destina-se a executar automaticamente operaç�es individuais, n�o mantendo o seu estado para cada invocaç�o de um m�todo.

Figura 4: Janela do wizard para configuraç�o do Novo EJB

Tendo gerado o EJB, faz-se a implementaç�o de um m�todo nele, de acordo com a Listagem 1, que estar� dispon�vel no serviço gerado posteriormente.

Listagem 1: Implementaç�o do EJB que servir� de base para a geraç�o do Web Service


package EJBs;
import javax.ejb.LocalBean;
import javax.ejb.Stateless;
//EJB que n�o preserva estado para cada invocaç�o de m�todo.
@Stateless
//EJB estar� dispon�vel somente no contexto do servidor de aplicaç�o
@LocalBean
public class Operacoes{
//M�todo que realiza a soma de dois valores reais 
public float soma(float numero, float outroNumero){
    return numero+outroNumero; 
};
}

Este EJB servir� de base para a geraç�o autom�tica do Web Service. Para tal, devem-se realizar os procedimentos apresentados nas Figuras 5 e 6.

Nesta etapa seleciona-se o tipo do arquivo criado. Na categoria Web Services encontra-se o tipo que deve ser criado, neste caso o tipo desejado � Web Service.

Figura 5: Janela do wizard para criaç�o de Novo Web Service

Figura 6: Janela do wizard para configuraç�o do Novo Web Service

Na etapa apresentada pela Figura 6, deve ser especificado um nome para o serviço Web, sua localizaç�o no projeto e a criaç�o do Web Service a partir de um Bean de sess�o existente. O Bean existente pode ser encontrado por meio da opç�o �Procurar�, dispon�vel na janela do wizard.

Ap�s realizar estas configuraç�es, basta selecionar a opç�o de finalizar. O resultado desta etapa � o serviço apresentado na Listagem 2.

Listagem 2: Web Service gerado automaticamente utilizando o EJB criado


package servicos
import EJBs.operacoes;
import javax.ejb.EJB;
import javax.ejb.Stateless;
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebService;
//Anotaç�o de definiç�o de um serviço, bem como sua nomeaç�o.
@WebService(serviceName = �ServicoOperacoes�)
//Anotaç�o que define que o EJB n�o preserva estado para cada invocaç�o de m�todo.
@Stateless
public class ServicoOperacoes{
 //Injeç�o do EJB que possui o m�todo que se deseja acessar.
@EJB
private  Operacoes ejbRef;
//@WebMethod � Serve para informar o nome do m�todo ao gerador do WSDL.
//@WebParam � Serve para informar o nome do par�metro ao gerador do WSDL.
@WebMethod(operationName = �soma�)
public float soma(@WebParam(name =�numero�) float numero, @WebParam(name = �outroNumero�) float outroNumero){
      return ejbRef.soma(numero, outroNumero);
}
}

Conclu�da a implementaç�o do Web Service, resta apenas realizar sua implantaç�o no servidor de aplicaç�o GlassFish.

A Figura 7 apresenta o resultado da bem sucedida implantaç�o do Web Service no servidor de aplicaç�o.

Figura 7: Resultado da implantaç�o do Web Service no servidor de aplicaç�o Glassfish

Neste momento o serviço est� dispon�vel para consumo, e para tal, este artigo demonstra, nas seç�es seguintes, a implementaç�o de dois clientes, um deles utilizando a tecnologia Java e outro C#.

Al�m dos clientes, utilizou-se a biblioteca SAX de processamento de XML para interpretar o descritor do serviço rec�m-criado.

3. Uso da API SAX (Simple API for XML)

SAX � uma API simples para manipulaç�o de arquivos XML dispon�vel para a plataforma Java. SAX foi a primeira API amplamente adotada para XML em Java, por este motivo � considerada padr�o. Sua vers�o atual � SAX 2.0.1, e h� vers�es para diversos ambientes de programaç�o diferentes do Java. [Megginson 1998].

Esta seç�o apresenta um programa Java que ilustra a utilizaç�o pr�tica da API SAX. O programa realiza o processamento do documento XML com informaç�es sobre a descriç�o do serviço criado na seç�o anterior, representado pela Figura 8.

O XML contendo a descriç�o completa do serviço estar� dispon�vel no endereço fornecido pelo servidor de aplicaç�o no momento em que a implantaç�o ocorre. No exemplo trabalhado o descritor estar� dispon�vel atrav�s do seguinte endereço:

http://localhost:8080/ServicoOperacoes/ServicoOperacoes?wsdl

Figura 8: Estrutura do XML descritor do serviço implementado neste artigo

O programa Java � apresentado na Listagem 3. A classe MyParser processa o documento XML com o uso da API SAX, recuperando informaç�es sobre as operaç�es dispon�veis. A explicaç�o sobre o funcionamento do programa � apresentada no interior do c�digo, em forma de coment�rio.

Listagem 3: Implementaç�o do Parser Java utilizando a API SAX


package parser;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
import java.util.Map.Entry;
import javax.xml.parsers.ParserConfigurationException;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;
 
public class MyParser extends DefaultHandler{
 static Map<String, String> operacoes = new HashMap<String, String>();
 private String tagAtual;
 private String siglaAtual;
//M�todo que far� o parsing do arquivo utilizado no argumento do m�todo
 public void parsing(String pathDoArquivo){
 //Criaç�o de uma inst�ncia da classe javax.xml.parsers.SAXParser, atrav�s da f�brica (factory) SAXParserFactory 
SAXParserFactory fabrica = SAXParserFactory.newInstance();
SAXParser parserSax;
try{
        parserSax = fabrica.newSAXParser();
//O �this� passado como argumento do m�todo seguinte indica que a pr�pria classe atuar� como gerenciadora de eventos SAX
         parserSax.parse(pathDoArquivo, this);
//Tratamento de exceç�es
}catch(ParserConfigurationException | SAXException | IOException e){
       StringBuffer msg =  new StringBuffer();
       msg.append(�Erro:\n�);
       msg.append(e.getMessage()+�\n�);
       msg.append(e.toString());
       System.out.println(msg);
}
}
 //M�todo startDocument do SAX. Disparado antes do processamento da primeira linha do arquivo XML.
public void startDocument(){
        System.out.println(�Iniciando o parsing...�);
}
//M�todo disparado ap�s o processamento da �ltima linha do arquivo XML
public void endDocument(){
        System.out.println(�Encerrando o parsing...�);
}
//M�todo invocado quando o processador SAX identifica a abertura de uma Tag
public void startElement(String uri, String localName,String qName, Attributes atts){
 //Recupera o nome da Tag atual
         tagAtual = qName;
//Adiciona ao mapa caso encontre a Tag �<operation>�
    if(qName.compareTo(�operation�) == 0){
         siglaAtual = atts.getValue(0);
         operacoes.put(siglaAtual,�operation�);
     }
}
//M�todo disparado quando encontrado o fechamento de uma Tag
public void endElement(String uri, String localName, String qName) throws SAXException{
          tagAtual = � �;
}
 
public static void main(String[] args) throws Exception{
    if(args.length != 1){
        System.err.println(�Erro! Exemplo de utilizaç�o �MyParser   nome_do_XML�);
        System.exit(1);
     }
      MyParser meuParser = new MyParser();
      meuParser.parsing(args[0]);
   for(Entry<String,String> entrada : operacoes.entrySet()){
       System.out.println(�Operaç�o = �+entrada.getKey() );
    }
}
}

A classe MyParser processa o documento XML com o uso da API SAX, recuperando as informaç�es sobre as operaç�es dispon�veis no serviço Web e as exibe na tela.

MyParser � uma subclasse de org.xml.sax.helpers.DefaultHandler, que faz com que ela ganhe automaticamente um processador SAX com o comportamento padr�o.

4. Aplicaç�es Clientes

Visto a criaç�o do Web Service, as pr�ximas seç�es apresentam a implementaç�o de duas aplicaç�es clientes que consumir�o as operaç�es oferecidas.

4.1 Java

Cria-se nesta seç�o uma aplicaç�o Java que far� o consumo do Web Service desenvolvido. Os passos para a criaç�o deste aplicativo podem ser vistos nas Figuras 9 e 10.

Figura 9: Janela do wizard para escolha do tipo da aplicaç�o cliente

Figura 10: Janela do wizard para configuraç�es do cliente Java

Tendo criado o projeto, d�-se in�cio ao desenvolvimento da classe que consumir� o serviço. A geraç�o dos componentes do projeto cliente, gerados a partir do serviço, e a estrutura da classe consumidora podem ser vistos na Figura 11 e na Listagem 4.

Figura 11: Janela do wizard para geraç�o dos componentes do projeto cliente

A Listagem 4 demonstra um exemplo de implementaç�o que faz uso da operaç�o de Soma dispon�vel no serviço criado.

Listagem 4: Implementaç�o da classe Java consumidora do serviço


package Application;
import AppClient.ServicoOperacoes;
import AppClient.ServicoOperacoes_Service;
 
public class Cliente {
public static void main(String[] args){
    ServicoOperacoes_Service service = new ServicoOperacoes_Service();
    ServicoOperacoes port = servisse.getServicoOperacoesPort();
    System.out.println(�Soma: �+port.soma(12,13));
}
}

A Figura 12 apresenta o resultado obtido ap�s a execuç�o da classe Java implementada, dispon�vel na Listagem 4.

Figura 12: Resultado obtido atrav�s da execuç�o da classe Java implementada

4.2 C#

Esta seç�o apresenta uma aplicaç�o C# que far� o consumo do Web Service desenvolvido. Os passos para a criaç�o deste aplicativo podem ser vistos nas Figuras 13, 14 e 15.

Figura 13: Janela do wizard para criaç�o do Novo Projeto C#

No passo apresentado na Figura 13, criou-se um novo projeto do tipo Console Application, que servir� para a criaç�o da classe que far� o consumo do Web Service.

Ap�s a criaç�o do projeto, deve ser adicionada a ele uma refer�ncia para o Web Service, como pode ser observado nas Figuras 14 e 15.

Figura 14: Adiç�o de refer�ncia para o Web Service no projeto consumidor do serviço

Figura 15: Janela do wizard para adiç�o de refer�ncia para o Web Service

Ap�s concluir a criaç�o do projeto e a adiç�o da refer�ncia para o Web Service, se inicia a implementaç�o da classe que utilizar� o serviço. A programaç�o desta classe pode ser vista na Listagem 5.

Listagem 5: Implementaç�o da classe em C# que far� o consumo do serviço


using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace ClienteWebService{
     class Program
    {
        Static void Main(String[] args)
       {
           Servico.ServicoOperacoesClient service =  new                     Servico.ServicoOperacoesClient();
           Console.WriteLine(�Soma: �+service.soma(14,15));
           Console.ReadKey();
        }
      }
}

5. Consideraç�es Finais

Este artigo apresentou exemplos de implementaç�o de Web Services utilizando a Plataforma JEE, bem como a aplicaç�o pr�tica da API SAX na interpretaç�o de XML, neste caso, bastante adequada, pois os arquivos descritores de serviços geralmente possuem tamanhos consider�veis.

Al�m deste How-to (Como fazer), este estudo buscou fornecer uma �receita de bolo'' para a criaç�o de aplicaç�es consumidoras de serviços Web em diferentes linguagens, o que demonstra o poder da tecnologia estudada na interaç�o de diferentes sistemas.