Prática da Disciplina de Sistemas Distribuídos Serviços Web IFMA DAI Professor Mauro Lopes C. Silva

Transcrição

1 1. O que são Serviços Web (Web Services)? Prática da Disciplina de Sistemas Distribuídos Serviços Web IFMA DAI Professor Mauro Lopes C. Silva A ideia central dos Web Services parte da antiga necessidade de integrar os diversos sistemas de uma empresa através da exposição das funcionalidades dos sistemas de uma forma não intrusiva, desacoplada, independente de linguagem de programação. No cenário atual, é raro existir uma aplicação corporativa que possua uma interface apenas interna. É comum que aplicações deste tipo necessitem de integração com outros sistemas. Sendo assim, os web services são uma excelente opção para promover esta integração. Aplicações empresariais normalmente possuem ricos domínios que encapsulam complexas regras de negócio. Boa parte destas regras é representada sob a forma de serviços. Mas o que são estes serviços? Se fizermos uma análise apenas em um modelo de domínio, os serviços são classes que encapsulam funcionalidades oferecidas para outros objetos que vivem dentro da mesma aplicação. Por exemplo, em uma aplicação bancária, pode existir um serviço de domínio responsável por realizar transferências de valores entre objetos do tipo ContaCorrente. Neste cenário, o serviço está restrito ao sistema em questão e pode ser acessado sem maiores problemas através de chamadas entre objetos presentes nas camadas da aplicação. Mas o que acontece se outros departamentos, da mesma empresa, estiverem interessados em reaproveitar o serviço de transferência no contexto de aplicações próprias? Ou seja, fazer uso de uma funcionalidade que se encontra fora das fronteiras de suas aplicações? Se estivermos falando apenas de sistemas desenvolvidos na plataforma Java, novamente, não teríamos muitos problemas. O serviço poderia ser disponibilizado na forma de um arquivo JAR, no classpath dos projetos clientes. Ou ainda, poderia ser permitido acesso remoto através de uma interface remota de um componente EJB. Sendo assim, onde está o problema? O problema aparece quando o conceito de serviço transcende o domínio e a plataforma. Isto é, quando aplicações desenvolvidas por equipes distintas, em plataformas diferentes, precisam de alguma forma de integração. Por exemplo, um sistema criado em.net querendo consumir o serviço de transferência de valores, feito na plataforma Java. Para permitir tal integração, podemos fazer uso de web services. A Figura 1 apresenta um exemplo de integração entre vários sistemas baseados em vários serviços. Figura 1: Exemplo de integração entre vários Sistemas 1

2 Os Web Services são ideais para integração de sistemas, principalmente aqueles desenvolvidos com tecnologias heterogêneas, pois garantem independência de plataforma e linguagem. Isso se deve ao fato de se basearem na linguagem XML e no protocolo HTTP. A linguagem XML é amplamente difundida entre as diversas plataformas existentes no mercado. Portanto, é fácil trabalhar com este formato para efetuar trocas de mensagens entre diferentes aplicações. Além disso, o protocolo HTTP é o mais utilizado na web. Figura 2: Relembrando a Arquitetura dos Web Services A Figura 2 apresenta um resumo da arquitetura de um Web Service padrão W3C para que possamos perceber o uso intenso do XML e da Internet. 2. JAX-WS (Java API for XML-Based Web Services) No contexto da plataforma Java, uma das maneiras de se disponibilizar funcionalidades de uma aplicação sob a forma de Web Services ou realizar chamadas a eles, é fazer uso da especificação JAX-WS (Java API for XML Web- Based Services). JAX-WS é um conjunto de APIs para criar Web Services em XML (SOAP). JAX-WS fornece uma série de anotações que facilitam o desenvolvimento e o deploy tanto de clientes de Web Services quanto de servidores (endpoints). A especificação JAX-WS pode ser conferida em 3. Anotações JAX-WS A JAX-WS depende do uso de anotações para especificar metadados 1 associados às implementações de Web Services e para simplificar o desenvolvimento destes. As anotações descrevem como uma implementação de serviço do lado do servidor (Web Service) é acessada ou como uma classe Java do lado do cliente acessa estes serviços. Com suporte a anotações, o JAX-WS simplifica o desenvolvimento dos Web Services e reduz o tamanho de arquivos JAR do run-time. Desta forma, a criação dos Web Services torna-se mais simples. Ou seja, boa parte do trabalho fica com o servidor de aplicação e o desenvolvedor se concentra na lógica da aplicação. As anotações mais utilizadas são: 1 Metadados podem ser basicamente definidos como "dados que descrevem os dados", ou seja, são informações úteis para identificar, localizar, compreender e gerenciar os dados. 2

3 Classe de anotação javax.jws.webservice javax.jws.webmethod javax.jws.webparam javax.jws.webresult Anotação A marca uma classe Java como uma implementação de um Serviço Web ou marca uma Service Endpoint Interface (SEI 2 ) como uma implementação de uma interface de serviço da Web. A expõe um método de uma classe como um método de um Web Service, ou seja, esta anotação denota um método que é uma operação de um Serviço Web. Aplique esta anotação aos métodos em um SEI ou em uma classe de implementação de Web Service. A customiza o mapeamento de um parâmetro individual para uma parte de mensagem para um elemento XML do Web Service. Ao colocar a nos parâmetros, você tem uma forma de dizer ao JAX-WS o deve ser feito com cada um. Aplique esta anotação aos métodos em um SEI ou em uma classe de implementação de Web Service. A customiza o mapeamento de um valor de retorno para uma parte WSDL ou um elemento XML. Aplique esta anotação aos métodos em um SEI ou em uma classe de implementação de Web Service. Para entendermos melhor como usar a JAX-WS e as suas anotações, iremos criar uma aplicação extremamente simples que proverá um serviço para somar dois números. O que o serviço deverá fazer é receber dois números inteiros e calcular o resultado da adição. Porém, ao invés de retornar um tipo primitivo int, o método irá retornar um valor baseado em um objeto do tipo Resultado, que será uma classe do domínio da aplicação. Após, iremos criar uma aplicação cliente que irá consumir este serviço. 4. Criando um Web Service usando JBoss AS 7.1 e o JBoss Tools Para criar nosso Web Service iremos usar as mesmas ferramentas que usamos na prática de EJB: Eclipse Luna JEE JBoss AS 7.1 (Uma alternativa a quem tiver problemas com o JBoss AS 7.1 é usar o WildFly 8) JBoss Tools O ponto de início para construir um web service com JAX-WS é uma classe Java anotada com javax.jws.webservice. A define a classe como uma provedora (web service endpoint). Figura 3: JAX-WS e a comunicação entre o Web Service e o cliente 2 SEI ou Service Endpoint Interface é uma interface Java que declara os métodos que um cliente pode invocar em um Web Service. 3

4 Uma service endpoint interface ou service endpoint implementation (SEI) é uma interface ou classe Java, respectivamente, que declaram os métodos que um cliente pode chamar no serviço. Uma interface não é necessária quando construímos um Web Service com JAX-WS, a implementação (SEI) JAX-WS implicitamente define uma interface. Você pode definir explicitamente uma interface utilizando o elemento endpointinterface na na classe de implementação (SEI). Dessa forma, você deverá prover uma classe concreta (SEI) que defina os métodos públicos que serão disponibilizados no Web Service. Os passos básicos para a construção de um Web Service e um cliente são: 1. Codificar a classe do Web Service; 2. Compilar a classe do Web Service; 3. Fazer o deploy do Web Service; 4. Codificar a classe cliente usando o WSDL gerado através de alguma ferramenta de suporte; 5. Executar o cliente; O JAX-WS endpoints devem seguir as seguintes regras: A classe do Web Service deverá ser anotada por uma das seguintes anotações: javax.jws.webservice ou javax.jws.webserviceprovider. A classe do Web Service poderá explicitar uma referência a uma SEI por meio do elemento endpointinterface da Os métodos de negócios da classe do Web Service devem ser públicos e não devem ser declarados static ou final. Métodos de negócios que são expostos aos clientes do Web Service devem ser anotados com javax.jws.webmethod. Métodos de negócios que são expostos aos clientes do Web Service devem ter parâmetros e tipos de retorno compatíveis. A classe do Web Service não deve ser declarada final e não deve ser abstract. A classe do Web Service deve ter um construtor padrão público. A classe do Web Service não deve definir o método finalize. Iremos agora criar o Serviço Web e logo após iremos criar o nosso cliente que irá consumir este serviço. Vamos iniciar criando um Projeto Dynamic Web Project no Eclipse. Chamaremos este projeto de CalculadoraWS. A Figura 4 apresenta como deverá estar a sua Tela. Tenha atenção quanto a configuração do uso do JBoss como Servidor de Aplicação (Target Runtime e Configuration). 4

5 Figura 4: Criação de um Dynamic Web Project no Eclipse Após a criação do nosso projeto, vamos seguir os seguintes passos: 1. Criar um pacote denominado aula.pratica.dominio; 2. Neste pacote iremos criar uma classe de domínio denominada ResultadoSoma (Figura 5); 3. Criar um pacote denominado aula.pratica.servicoweb; 4. Neste pacote iremos criar uma classe que implementa o nosso serviço, denominada CalculadoraSomaService (Figura 6); A Figura 5 apresenta o código-fonte da classe ResultadoSoma. Figura 5: Classe ResultadoSoma. 5

6 A Figura 6 apresenta o código-fonte da interface CalculadoraSomaService. Figura 6: Classe CalculadoraSomaService. A define e identifica a classe que implementa um Web Service, ou seja, a classe que será responsável por fornecer um serviço. Ela também pode ser utilizada para definir, no cliente, uma interface Java como um SEI (Service Endpoint Interface). A expõe o método como uma operação oferecida pelo Web Service, ou seja um serviço em si. Após a conclusão do nosso projeto vamos fazer o deploy do nosso serviço. Vamos subí-lo para o nosso servidor de aplicação JBoss AS 7.1. Para fazer isso basta arrastar o projeto para o Servidor que se encontra na aba Servers que o mesmo será publicado. Nesta ação algumas coisas aconteceram automaticamente. Após a publicação será gerado o documento WSDL para nosso Serviço Web. Acesse o documento WSDL através do endereço do serviço. O endereço pode ser obtido pelo log do JBoss AS 7.1, visualizado através do console. Geralmente este endereço tem a seguinte estrutura: Muito provavelmente ao colar este endereço no Browser ele não apresentará nada. Para visualizar o WSDL você deverá mandar exibir o código-fonte da página. Com o nosso serviço criado vamos nos dedicar a criação do Cliente que irá consumir este serviço. Crie um projeto Java normal, um Java Project. Chame este projeto de ClienteCalculadora. A Figura 7 apresenta a definição do projeto. 6

7 Figura 7: Projeto ClienteCalculadora. Após a criação do nosso projeto, vamos seguir os seguintes passos: 1. Criar um pacote denominado aula.pratica.cliente; 2. Clique com o botão direito no projeto ClienteCalculadora e escolha a opção Web Service Client. Caso você não localize esta opção, basta escolher New/Other/Web Services/Web Service Client, conforme Figura 8. Figura 8: Criação do Web Service Client. 3. Clicando em [Next] na tela apresentada na Figura 8, iremos para a tela apresentada na Figura 9. 7

8 Figura 9: Criação do Web Service Client através do WSDL. 4. Na opção Service definition cole o endereço do WSDL do serviço que foi gerado anteriormente no momento da criação do serviço. Após esta ação clique em [Finish]. 5. O resultado poderá ser observado na Figura 10. Figura 10: Resultado da criação do Web Service Client através do WSDL. 6. Criar um pacote denominado aula.pratica.cliente; 7. Neste pacote iremos criar uma classe denominada ClienteWS (Figura 11). Esta é uma classe Java comum com um método main. 8

9 Figura 11: Classe ClienteWS. Agora para fazer uso do nosso Web Service basta executar o ClienteWS como uma aplicação Java (Java Application). 9