Java Web Services: como criar um Web Service baseado em SOAP

Os Web Services podem ser baseados no protocolo SOAP ou no estilo REST (chamados de RESTful). Ambos funcionam sob o protocolo HTTP, que � o protocolo padr�o de transfer�ncia de documentos na Web.

SOAP � um dialeto XML utilizado para descrever mensagens que s�o trocadas entre componentes SOA (Service Oriented Architecture).

No restante do artigo veremos como criar um Web Service ao estilo SOAP.

Saiba mais sobre os Web Services REST x SOAP

Criando Web Services em SOAP

Em Java, os serviços Web s�o definidos por classes. Um Web Service pode oferecer v�rias operaç�es, representada por um m�todo de classe. Uma pr�tica muito importante de ser seguida � sempre dividirmos a interface de um serviço da sua implementaç�o. A interface de um serviço � chamada de SEI (Service Endpoint Interface) e a implementaç�o � chamada de SIB (Service Implementation Bean).

Neste exemplo usaremos o bloco de notas para entendermos melhor tudo o que acontece, diferente de utilizar um ambiente de desenvolvimento que muitas vezes abstraem diversos detalhes que deveriam ser implementados.

Curso Completo: Curso de Web Service em Java

Vamos iniciar a implementaç�o criando um Web Service simples separada em SEI e SIB que possui quatro operaç�es: �soma, subtracao, divisao, multiplicaç�o�. O objetivo deste serviço � retornar o calculo de uma das operaç�es invocadas pelo cliente. Segue abaixo o exemplo do SEI para o nosso serviço de calculadora. Salve o arquivo abaixo com o nome CalculadoraServer.java dentro de uma pasta "calc".

package calc;

import javax.jws.WebService;
import javax.jws.WebMethod;
import javax.jws.soap.SOAPBinding;
import javax.jws.soap.SOAPBinding.Style;

@WebService
@SOAPBinding(style = Style.RPC)
public interface CalculadoraServer {
  @WebMethod float soma(float num1, float num2);
  @WebMethod float subtracao(float num1, float num2);
  @WebMethod float multiplicacao(float num1, float num2);
  @WebMethod float divisao(float num1, float num2);
}

Listagem 1. Interface para o serviço de calculadora.

N�o h� nada de muito diferente em relaç�o a um c�digo qualquer normal de interface Java. Por�m notamos que as @WebService, @WebMethod e @SOAPBinding provavelmente s�o novidades para aqueles que ainda est�o aprendendo sobre Web Services. @Webservice � uma anotaç�o que avisa ao compilador Java que o arquivo atual corresponde � definiç�o SEI de um serviço Web.

@WebMethod indica que um determinado m�todo corresponde a uma operaç�o de serviço e assim pode ser invocado por um cliente. @SOAPBinding indica que o serviço utilizar� a abordagem SOAP e n�o Rest que � a outra abordagem suportada.

Agora que a interface est� criada e anotada corretamente vamos criar a implementaç�o da interface, ou seja, a nossa SEI onde ser�o implementados os m�todos definidos anteriormente. Para isso precisamos criar a classe CalculadoraServerImpl.java que estar� salvo dentro da pasta calc. Segue abaixo a implementaç�o:

package calc;

import java.util.Date;
import javax.jws.WebService;

@WebService(endpointInterface = "calc.CalculadoraServer")
public class CalculadoraServerImpl implements CalculadoraServer {
    
  public float soma(float num1, float num2) {
    return num1 + num2;
  }
  
  public float subtracao(float num1, float num2) {
    return num1 - num2;
  }

  public float multiplicacao(float num1, float num2) {
    return num1 * num2;
  }

  public float divisao(float num1, float num2) {
    return num1 / num2;
  }

}

Listagem 2. Implementaç�o da interface do serviço.

A listagem acima nada mais � do que uma implementaç�o de uma classe como outra qualquer com os m�todos da interface descritos e implementados. No entanto, neste c�digo temos uma novidade, a propriedade endpointInterface dentro da anotaç�o @WebService.

Essa propriedade faz com que a classe atual, a SIB, ligue-se com a SEI especificada anteriormente (calc.CalculadoraServer).

Agora tudo que nos resta � compilar este arquivo. Para isso podemos utilizar o terminal acessando o Prompt de Comando no menu de programas do Windows ou o Terminal do Linux. No Prompt entre na pasta onde os arquivos anteriores foram salvos (entre na pasta onde a pasta calc foi criada, ou seja, um n�vel acima da pasta calc), por exemplo:

cd "C:\Users\higor\Desktop\Exercicios"

e execute o comando:

javac calc/*.java

Se n�o ocorrer nenhum erro tudo foi corretamente criado e os .class relativo a cada um dos arquivos foi criado na pasta calc. Se ocorrer algum erro veja se n�o houve nenhum erro de digitaç�o e se a vari�vel JAVA_HOME foi corretamente especificada.

Agora estamos prontos para publicar o serviço e isso ser� discutido na pr�xima seç�o do artigo.

Publicando o Serviço

Agora que os arquivos j� foram compilados podemos public�-lo. Para isso precisamos gerar o arquivo abaixo CalculadoraServerPublisher.java dentro da pasta calc juntamente com os arquivo definidos anteriormente.

package calc;

import javax.xml.ws.Endpoint;

public class CalculadoraServerPublisher {

  public static void main(String[] args)
  {
    Endpoint.publish("http://127.0.0.1:9876/calc",
    new CalculadoraServerImpl());
  }
}

Listagem 3. Publicando o serviço.

Neste c�digo percebe-se o uso da classe Endpoint que est� dispon�vel na linguagem Java e que nos permite publicar um serviço em um servidor. Para que possamos usa-la deve-se passar como par�metro o endereço do servidor e a inst�ncia do SIB do serviço a ser publicado. Notamos que o serviço � publicado na porta 9876.

Agora basta compilar o arquivo anterior com o comando:

javac calc/CalculadoraServerPublisher.java

Por fim, podemos executa-lo atrav�s do comando:

java calc.CalculadoraServerPublisher

Para verificarmos se tudo foi publicado corretamente basta acessar no browser o link: http://127.0.0.1:9876/calc?wsdl

Se tudo ocorrer perfeitamente poderemos visualizar o WSDL do serviço publicado. Com isso estamos prontos para usar o serviço.

Usando o Serviço

Agora que o serviço est� publicando, executando e pronto para ser usado, vamos criar um cliente que acessar� o Web Service criado anteriormente. O c�digo abaixo demonstra um cliente para o nosso Web Service:

package calc;

import javax.xml.namespace.QName;
import javax.xml.ws.Service;
import java.net.URL;

class CalculadoraClient {

  public static void main(String args[]) throws Exception {
    URL url = new URL("http://127.0.0.1:9876/calc?wsdl");
    QName qname = new QName("http://calc/","CalculadoraServerImplService");
    Service ws = Service.create(url, qname);
    CalculadoraServer calc = ws.getPort(CalculadoraServer.class);

    System.out.println("Soma (5+1): " + calc.soma(5,1));
    System.out.println("Subtracao (5-1): " + calc.subtracao(5,1));
    System.out.println("Multiplicacao (5*1): " + calc.multiplicacao(5,1));
    System.out.println("Divisao (5/1): " + calc.divisao(5,1));

  }
}

Listagem 4. Cliente para o Web Service.

Neste c�digo pode-se observar que necessitamos passar o endereço do WSDL para a URL, indicando onde o WSDL do serviço poder� ser encontrado. Na segunda linha passamos um nome qualificado em XML para QName. Ele indica uma URI (namespace) e o nome do serviço. O namespace � fornecido pela WSDL do serviço, e o nome local � a classe SIB acrescida da palava �Service�. O nome local aparece na �ltima seç�o do documento WSDL (seç�o service).

Assista: Criando um serviço RESTful com Java

Por fim, na linha �Service ws = ws.create(url, qname)� temos como retorno uma refer�ncia a um objeto que pode invocar as operaç�es oferecidas pelo serviço (em portType) e na pr�xima linha finalmente acessamos a interface de ponto final (endpoint) do calc.CalculadoraServer, que � tipo SEI do serviço, sendo capaz de acessar seus m�todos.

Agora simplesmente compilamos este arquivo e executamos abrindo um novo Prompt de Comando, j� que no outro Prompt estamos com o arquivo de publicaç�o rodando.

Executando com o comando abaixo:

java calc.CalculadoraClient

Temos os resultados abaixo:

Soma (5+1): 6.0
Subtracao (5-1): 4.0
Multiplicacao (5*1): 5.0
Divisao (5/1): 5.0

Pode-se verificar que o cliente acessou o Web Service passando alguns par�metros e obteve determinados resultados. Lembramos que este cliente poderia ter sido implementado em qualquer linguagem de programaç�o como C, C++, PERL entre diversas outras.

Neste artigo estudamos como desenvolver um Web Service em Java e publicamos o serviço em um servidor Local. Verificamos cada uma das linhas de c�digo criadas e o que significa cada uma das anotaç�es utilizadas. Por fim, desenvolvemos um cliente em Java que utiliza o serviço que criamos anteriormente passando par�metros e recebendo os resultados esperados.

Curso relacionado: Java Web Service na Pr�tica

Saiu da DevMedia!

CDI 2.0: avanços no Java EE e al�m:
Injeç�o de depend�ncias � um pilar do desenvolvimento moderno; com CDI 2.0, esta ferramenta ser� dispon�vel para desenvolvedores Java SE. A nova vers�o de CDI tamb�m traz avanços para programaç�o ass�ncrona, que � um t�pico muito relevante para a performance de uma aplicaç�o.
O que � JWT?:
Voc� sabe o que � JWT? Talvez este seja um dos termos que voc� mais tenha escutado nos �ltimos meses, n�o � verdade? Mas, por que JWT? Qual a import�ncia dele no desenvolvimento de software hoje em dia? Onde o JWT � utilizado?
Vale a pena ver CSS de novo:
O programador est� sempre preocupado em utilizar bem o seu tempo. Com isso em mente, saiba que os recursos mais modernos do CSS3 podem nos ajudar a nos dedicarmos mais ao back-end da aplicaç�o, como veremos neste DevCast.

Saiba mais sobre Java ;)

REST e Java:
Devido a sua simplicidade, os Web Services RESTful t�m se tornado cada vez mais populares. Neste guia voc� encontrar� os conte�dos que precisa para dominar esse modelo que permite a construç�o de serviços menores a APIs completas.
JSF - JavaServer Faces:
Neste Guia de Refer�ncia voc� encontrar� todo o conte�do que precisa para conhecer o JSF, especificaç�o Java que traz conceitos do padr�o MVC e que facilita a construç�o de interfaces web utilizando componentes.
Spring Framework:
Neste Guia de Refer�ncia voc� encontrar� o conte�do que precisa para aprender a desenvolver aplicaç�es utilizando o Spring Framework e seus subprojetos.

Desenvolvendo e Usando Web Services em Java

Veja neste artigo como criar um Web Service em Java baseado em SOAP, como podemos publicá-lo em um servidor e como utilizar este Web Service.

Criando Web Services em SOAP

Publicando o Serviço

Usando o Serviço

Saiu da DevMedia!

Saiba mais sobre Java ;)

Artigos relacionados