Home > Artigos > Ambiente WEB >

Introdução prática a REST Web Services com Java usando RESTEasy

Publicado por jesuino em 27/03/2012 - 36.204 visualizações

Artigo Beta! Por favor, poste no fórum qualquer erro encontrado

Nesse presente artigo vamos falar rapidamente de REST no mundo Java usando a especificação JAX-RS e a implementação RESTEasy. Esse texto é ?mão na massa", não vamos a fundo aos príncipios REST e no funcionamento do JAX-RS. Se quiser saber mais você deve ler a tese de Roy Fielding ou ler os livros recomendados no final do capítulo.

Muito blá blá né? Vamos ao que interessa!

Ambiente

Você vai precisar de um ambiente de desenvolvimento comum a desenvolvedores Java:

- Ambiente Java 1.5+
- Eclipse Helius ou Indigo
- Algum servlet container, de preferência Tomcat 6
- Aproveite e já baixe o RESTEasy 2.3.2.

Olá Mundo!

Provavelmente você já sabe que tudo que vamos aprender no mundo da programação começamos com um ?Hello World" ou, no bom português, ?Olá Mundo!". O que vamos fazer agora é um mega simples Web Service (WS) que simplesmente diz ?Olá Mundo!". Pode parecer idiota, mas dele vamos aprender o básico de um REST WS usando Java.
Para construir WS baseados nos príncipios REST usamos alguma implementação da especificação JAX-RS. Essas especificação é uma das mais simples de ser lida e entendida e ela simplesmente vai te ajudar a direcionar requests HTTPs(lembre-se que com HTTP é possível seguir todos os príncipios REST) para suas classes POJO devidamente anotadas. A especificação também prevê diversos outros detalhes como parse do corpo da request HTTP diretamente para POJO entre muitos outros.
O que vamos fazer agora é simplesmente criar um Olá Mundo para servir de base para futuros projetos que usam JAX-RS e também entender o básico do básico de toda a especificação.
Conforme falamos algumas linhas acima, JAX-RS ajuda você a direcionar requests HTTP para suas classes. Para você fazer uma request você deve saber a URL de destino e o recurso que quer acessar dessa URL, a URI do recurso. JAX-RS permite, através de anotações Java, que você escolha a URI de cada um de seus recursos e o método HTTP desejado.
Resumo: Você cria um POJO(classes Java simples), anota, deploy e os métodos dessa classe irão responder à requests HTTP após o deploy em um servlet container.

Determinando o projeto

Antes de codificar vamos definir qual URI irá responder ?Olá Mundo!". Que tal ?ola-mundo"? Ok, vamos usar ola-mundo. E qual o método HTTP? GET. GET usamos para pegar coisas do servidor(PUT ou POST para criar, DELETE para apagar, veremos mais a frente...). Então, nosso primeiro WS REST responde como abaixo:

Método HTTP: GET
URI: /ola-mundo
Tipo de retorno: Texto Plano

Uma coisa nova que você deve ter notado é o tipo de retorno. REST WS respondem em qualquer formato de dado que você quiser: XML, JSON, Texto Plano, YAML, JPG, etc. Basta você ter o MessageBodyWriter para aquele tipo. Mas para nós isso não importa ainda, pois com texto plano não precisamos nos preocupar com isso.

Configurando

Vamos a parte mais legal que é programar. Tem muitas partes chatas que não vamos falar aqui, mas vamos dar link na medida do necessário. Assim evitamos entediar os sabidinhos, mas não deixamos os novatos na mão :-).
Uma aplicação JAX-RS é uma aplicação WEB simples que usa empacotamento WAR, logo podemos criar um projeto no Eclipse do tipo ?Dynamic Web Project":

- Abra o Eclipse, vá em File->New-> Dynamic Web Project
- Dê o nome ?OlaREST"(ou outro que você quiser) e configure a versão 2.5 no campo ?Dynamic Web Module Version";
- Mais detalhes na doc do Eclipse.

Esse seu projeto, por padrão, não reconhece nada de JAX-RS. Se tentar usar vai ter só erro e dor de cabeça e vai fechar o Eclipse e vai ir ver sua timeline do facebook ou o trending do 9gag :-(. Para evitar isso, siga os passos abaixo para adicionar o RESTEasy no ?buildpath" do seu projeto. Assim o Eclipse reconhecerá tudo que você usar de JAX-RS:

- Após baixar o RESTEasy, ?unzip" o arquivo baixado em algum lugar;
- Da pasta resultante de ter ?deszipado" o resteasy, vá pasta lib e copie todos os arquivos JAR ali e cole eles lá na pasta do seu projeto em OlaREST/WebContent/WEB-INF/LIB. Você colar usando a própria interface do eclipse(pela IDE ir na pasta e apertar ?CTRL+V") ou colar na pasta pelo seu sistema operacional...
- No Eclipse, selecione os JARs da pasta lib do seu projeto (os que você acabou de colar), clique com o botão direito e selecione o menu ?Build Path" -> ?Add to Build Path". Agora o Eclipse irá reconhecer todas as classes relacionados ao RESTEasy.

Observe que colar todos os JAR no seu projeto WEB não é recomendado, você não vai usar todos nesse exemplo! As maiores desvantagens são maior tamanho em disco do projeto, possíveis conflitos de classloading quando for feito o deploy em servidores de aplicação, como o JBoss 5 e 6 e espalhamento desnecessário de diversos JARs por diversos projetos. Lembre-se disso quando for colocar aplicações em produção!

Estamos a um passo de deixar o ambiente no jeito para o desenvolvimento. Agora falta adicionar nosso servlet container ao Eclipse. O processo é melhor descrito nesse vídeo, mas abaixo vão os passos que segui na escrita desse texto:

http://localhost:8080

404

boas vindas

Programando

Perceba que estamos falando de URI, mas a URL final dependerá do contexto da sua aplicação no servidor:
{servidor}/{contexto da aplicação}/{URI do seu recurso}

página

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
   xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
   id="WebApp_ID" version="2.5">
   <display-name>OlaMundo</display-name>

<context-param>
      <param-name>resteasy.scan</param-name>
      <param-value>true</param-value>
   </context-param>

<servlet>
      <servlet-name>Resteasy</servlet-name>
      <servlet-class>org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher</servlet-class>
   </servlet>

<servlet-mapping>
      <servlet-name>Resteasy</servlet-name>
      <url-pattern>/*</url-pattern>
   </servlet-mapping>
</web-app>

- Clique em cima do seu servidor tomcat que você criou anteriormente na aba Server;
- Clique em iniciar ou segure CTRL+ALT e aperte R

INFO: Server startup in 503 ms

http://localhost:8080/OlaREST/ola-mundo

Pegando parâmetros da requisição HTTP

{url}?parametro=valor

pessoa/{id}

/ola-mundo

digaOla

/ola-mundo/qualquer%20texto%20aqui

digaOlaPath

/ola-mundo?parametro=algum%20valor

http://localhost:8080/OlaREST/ola-mundo/ESTE%20%C3%89%20UM%20TESTE

Olá Mundo!
O parâmetro de "URI" enviado foi: ESTE É UM TESTE

http://localhost:8080/OlaREST/ola-mundo/?parametro=ESTE%20%C3%89%20OUTRO%20TESTE!

Olá Mundo!
O parâmetro de "Query"enviado foi: ESTE É OUTRO TESTE!

Retornando suas classes nos recursos JAX-RS

?JavaBeans"

Você deve estar se perguntando por que criar uma classe se podíamos lidar com OlaMundo diretamente na classe JAX-RS. Estamos criar um Web Service REST aqui, em uma aplicação comumente não temos só os serviços WEB, mas também, por exemplo, páginas JSP, JSF, um cliente JavaFX que fazem parte da aplicação. Se você joga toda a lógica no REST ws, ela não será reaproveitada em outras partes!.

package servicos;

import java.util.ArrayList;
import java.util.List;

import modelo.OlaMundo;

/**
 * @author William Antônio
 * 
 */
public class ServicoOlaMundo {

public List<OlaMundo> buscaTodos() {
      return OlaMundoBD.buscaTodos();
   }

public OlaMundo buscaPorIdioma(String idioma) {
      return OlaMundoBD.buscaPorIdioma(idioma);
   }

/**
    * Essa class estática simula um banco de dados de OlaMundo's
    * 
    * @author William Antônio
    * 
    */
   public static class OlaMundoBD {
      private static List<OlaMundo> mensagens;

static {
         mensagens = new ArrayList<OlaMundo>();
         mensagens.add(new OlaMundo("PT", "Olá Mundo!"));
         mensagens.add(new OlaMundo("EN", "Hello World!"));
         mensagens.add(new OlaMundo("ES", "¡Hola Mundo!"));
         mensagens.add(new OlaMundo("DE", "Hallo Welt!"));
      }

/**
       * Todas as mensagens
       * 
       * @return
       */
      public static List<OlaMundo> buscaTodos() {
         return mensagens;
      }

/**
       * Tenta buscar por idioma, retorna nulo se não encontrada a mensagem no
       * idioma que pedimos
       * 
       * @param idioma
       * @return
       */
      public static OlaMundo buscaPorIdioma(String idioma) {
         for (OlaMundo olaMundo : mensagens) {
            if (olaMundo.getIdioma().equals(idioma))
               return olaMundo;
         }
         return null;
      }

}
}

package recursos;

import java.util.List;

import javax.ws.rs.DefaultValue;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response.Status;

import org.jboss.resteasy.annotations.providers.jaxb.Wrapped;

import modelo.OlaMundo;
import servicos.ServicoOlaMundo;

@Path("ola-mundo")
public class RecursoOla {

private ServicoOlaMundo servicoOlaMundo;

public RecursoOla() {
      //1
      servicoOlaMundo = new ServicoOlaMundo();
   }

@GET
   //2
   @Wrapped(element = "mensagensOlaMundo")
   //3
   @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
   public List<OlaMundo> buscaTodos() {
      return servicoOlaMundo.buscaTodos();
   }

//4
   @Path("/{idioma: [A-Z][A-Z]}")
   @GET
   @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })
   public OlaMundo buscaPorIdioma(@PathParam("idioma") String idioma) {
      OlaMundo res = servicoOlaMundo.buscaPorIdioma(idioma);
      //5
      if (res == null)
         throw new WebApplicationException(Status.NOT_FOUND);
      return res;
   }

@Path("/{idioma: [A-Z][A-Z]}")
   @GET
   //6
   @Produces({ MediaType.TEXT_HTML })
   public String buscaPorIdiomaHTML(@PathParam("idioma") String idioma,
         @QueryParam("cor") @DefaultValue("red") String cor,
         @QueryParam("tamanho") @DefaultValue("12") int tamanho) {
      OlaMundo res = servicoOlaMundo.buscaPorIdioma(idioma);
      if (res == null)
         throw new WebApplicationException(Status.NOT_FOUND);
      StringBuffer sb = new StringBuffer();
      sb.append("<span style='");
      sb.append("color:" + cor + ";");
      sb.append("font-size:" + tamanho + "px;");
      sb.append("'>");
      sb.append(res.getMensagem());
      sb.append("</strong>");
      return sb.toString();
   }
}

REGEX

http://localhost:8080/OlaREST/ola-mundo/ES?cor=RED&tamanho=300

http://localhost:8080/OlaREST/ola-mundo/

Conclusão

RESTful with JAX-RS

artigo

Utilize o fórum para perguntar coisas, estou observando essa thread.

Download:	RS_2.jpg
Size:	114 KB

Download:	RS.jpg
Size:	89 KB

Download:	tabela.png
Size:	11 KB

Download:	RS_4.jpg
Size:	164 KB

Download:	projetos-eclipse.zip
Size:	12 KB

comentários: 2