Web Services Implementação

7/26/2019 Web Services Implementao

1/39

2015 Instituto Federal de Educao, Cincia e Tecnologia Sul-Rio-Grandense

Campus Sapucaia do Sul

Web Services REST JAX-RSProfessor: Ricardo Luis dos Santos

IFSUL Campus Sapucaia do Sul


2/39

Instituto Federal de Educao, Cincia e Tecnologia Sul-Rio-GrandenseCampus Sapucaia do Sul

2

Agenda

Principais tecnologias envolvidas

Testando os servios desenvolvidos

JAX-RS

Principais anotaes JAX-RS

Principais anotaes JAXB

Entendendo o Web Service

Configurar o ambiente

Exemplo de Web Services REST

Exerccio


3/39


3

Principais tecnologias envolvidas

JAX-RS uma especificao que permite criar RESTfulWeb services (anloga a JAX-WS para SOAP)

Jersey a principal implementao da especificao

JAX-RS JAXB (Java Architecture for XML Binding) permite

parsear objetos para arquivos XML ou JSON

Tomcat o servidor Web utilizado para executar asaplicaes Java


4/39


4


HttpRequester (Firefox)


5/39


5


DHC (Chrome)


6/39


6


Soap UI (Vrios SOs Linux, Windows e Mac OS)


7/39


7

JAX-RS

Objetivo Descrio

Foco em POJOsA API vai oferecer um conjunto de anotaes e classes/interfacesassociadas que possam ser usadas com POJOs para exp-loscomo recursos Web

Explorar bem o HTTPHTTP assumido como o protocolo de aplicao, permitindoutilizar os diferentes mtodos implementados no protocolo

Independncia deformato

A API permitir o uso de diversos content-types. O suporte aoscontent-types ser feito de uma forma plugvel que defina umaforma padro de extenso para o suporte a novos tipos decontedo

Independncia decontainer

Ser possvel o deploymentem qualquer servidor de aplicaesJava EE e tambm nos containers de Servlets


8/39


8


Para acessar recursos so definidas diversasanotaes correspondentes aos mtodos HTTP

@GET Implementa um WS para obter informaes de umrecurso

@POST Implementa um WS para criar um recurso

@PUT Implementa um WS para atualizar um recurso

@DELETE Implementa um WS para deletar um recurso

Elas devem ser atribudas a mtodos pblicos As principais anotaes esto presentes no pacotejavax.ws.rs


9/39


9


@Path(/repositorio/{id})

Pode ser colocada na declarao de classe ou de ummtodo e possui o elemento value obrigatrio

Por este elemento definimos o prefixo da URI que a classeou o mtodo ir atender

Aqui a URI relativa /repositorio/{id}, na qual {id} o valordo parmetro id, fornecido junto a URI

Geralmente includa na declarao de um mtodo quandoqueremos atribuir um caminho mais especfico para umrecurso, de forma a especializar nosso mtodo


10/39


10


@Produces

Especifica os tipos MIME que o mtodo produzir comoresposta para o cliente

@Consumes Especificas os tipos MIME que o mtodo pode receber do

cliente

Para ambos podemos utilizar

MediaType.APPLICATION_XML

MediaType.APPLICATION_JSON

MediaType.TEXT_PLAIN

MediaType.TEXT_HTML


11/39


11


Pequeno exemplo de Web Service REST


12/39


12


Extraindo Valores

Anotao Descrio

@PathParam Especifica que o valor do parmetro, ser extrado do valor de um

parmetro indicado na URI, colocado na anotao @Path({param})@QueryParam Extrai o valor do parmetro da URI Ex: ?idade=29&uf=RS

@FormParam Associa um parmetro a um campo de formulrio enviado pelocliente

@MatrixParam Extrai informaes do caminho de uma URI Ex: ;idade=29;uf=RS

@CookieParam Extrai os valores de cookies vinculados sesso

@HeaderParam Extrai dados do cabealho de uma requisio HTTP


13/39


13


Extraindo Valores


14/39


14


Algumas observaes:

Uma mesma varivel pode ser especificada mltiplas vezesem uma anotao @Path.

Exemplo: @Path("/users/{nome}/{nome}")

Neste caso, s sero aceitas requisies a URLs cujos dois ltimoscomponentes sejam iguais

Variveis podem ser vazias. Exemplo:

@Path("/users/{nome}/home")

Cliente acessa URL /users//home A varivel nome ganha o valor (String vazia)

Note ainda que a anotao @Path pode ser usada paramtodos especficos

Aquele mtodo ser mapeado para aquela URL


15/39


15


Podemos ainda definir valores padro com aanotao @DefaultValue

Usados em caso de omisso


16/39


16


H restries em relao aos tipos dos parmetros

S se pode usar tipos com as seguintes caractersticas:

Tipos primitivos, exceto char

Classes correspondentes a tipos primitivos, exceto Character

Qualquer classe com construtor que recebe um nico argumento dotipo String

Qualquer classe com um mtodo esttico valueOf(String)

List, Set, SortedSet, onde T cai em um dos casos

anteriores. Caso no seja possvel mapear o valor presente na URL para

o tipo do parmetro, gerado um erro 400

Exemplo: parmetro declarado como int, usurio especifica valorteste


17/39


17

Principais anotaes - JAXB

Java Architecture for XML Binding (JAXB) fornece aAPI, as ferramentas e um framework para mapeardocumentos (XML) e objetos Java

Realiza o marshalling (serializao JAVA -> XML) eunmarshalling (deserializao XML -> JAVA) docontedo de documentos para representaes Java

As anotaes esto presentes no pacote

javax.xml.bind.annotation So utilizadas normalmente nos POJOs


18/39


18


Classes

@XmlRootElement

Indica que a classe ser representada como um elemento XMLprincipal

Pode alterar o nome do elemento atravs do valor name=

@XmlAccessorType(XmlAccessType.FIELD)

Indica a localizao das anotaes, no caso esto nos campos doPOJO

@XmlType(propOrder = {"id", "nome", "email", "cpf","endereco", "nascimento"})

Indica que a classe mapeia informaes especficas

Permite determinar, por exemplo, a order que os elementos seroexibidos


19/39


19


Classes

@XmlEnum(String.class)

Permite mapear uma classe enum com as devidas anotaes emcada valor

Atributos

@XmlEnumValue(ACAO)

Mapeia um valor de um enum

@XmlElementWrapper Mapeia um objeto do tipo lista (com tags filhas)

@XmlElement(name = "contrato")

Utilizada tanto nos atributos quanto nos mtodos, indica que oatributo ser um atributo XML


20/39


20


Atributos

@XmlAttribute(name=num_cpf)

Mapeia o valor de um campo como atributo no arquivo XML

@XmlList Permite mapear atributos como listas dentro de uma nica tag XML

@XmlSchemaType(name = "date")

Permite definir o mapeamento de diferentes tipos em Java

@XmlTransient Permite definir que um atributo no ser utilizado nas aes de

serializao e deserializao de objetos


21/39


21

Entendendo o Web service

A implementao do mtodo OPTIONS interessante

Ela retorna (como esperado) o conjunto de requisies queso suportadas

Mas tambm retorna um documento WADL


22/39


22


WADL (Web Application Description Language)?

O WADL um formato de documento utilizado paradescrever aplicaes Web em geral

Hoje, o exemplo mais comum de uso com os RESTful Web Services

Prov informao sobre as operaes oferecidas

Parmetros esperados

Formato da entrada

Formato da resposta

o equivalente para RESTful Web Services do WSDL paraBig Web Services


23/39


23


Exemplo WADL


24/39


24


Configurao de um RESTful web service

ApplicationConfig.java


25/39


25



ApplicationConfig.java

Adicionar cada classe dos servios

desenvolvidos

Informar aqui o padro de URL

utilizada


26/39


26



Web.xml (precedncia)


27/39


27



Web.xml (precedncia)

Adicionar aqui o pacote que contenha os

servios desenvolvidos

Informar aqui o padro de URL

utilizada


28/39


28

Exemplo de Web Services - REST

Mtodo GET


29/39


29


Consumindo GET

Construtor do cliente

Consumo


30/39


30


Consumindo GET

Lista


31/39


31


Mtodo POST


32/39


32


Consumindo POST


33/39


33


Mtodo PUT


34/39


34


Consumindo PUT


35/39


35


Mtodo DELETE


36/39


36


Consumindo DELETE


37/39


37

Exerccio

Fazer download do projeto WSRest

Configurar o persistence.xml

Criar a base de dados apropriada

Observar os Web Services implementados

Testar os Web Services mais simples (GET)diretamente no navegador

Testar os Web Services atravs do clienteimplementado dentro do projeto


38/39


38

Exerccio

Gerar um POJO para Transporte conforme a classeabaixo, persistindo no BD

Gerar o DAO para cadastrar novos locais de entrega e

o valor atrelado a estes, por peso Gerar os devidos servios para as operaes CRUD

sobre essa entidade

Criar um cliente para acessar os servios

desenvolvidos

- estado: String

- valor: Int

- peso: Float

Transporte


39/39

Perguntas?

Web Services Implementação

Documents

Transcript of Web Services Implementação