Tutorial Java Jersey

Tutoriais

Java

Bem-vindo ao Tutorial Java Jersey. Recentemente, comecei a trabalhar em um projeto de serviço web Restful usando o framework JAX-RS Jersey.

O que é o Framework Java Jersey?

O projeto Java Jersey acompanha a API JAX-RS, que é utilizada para criar serviços web Restful em Java.

1. Quem deve utilizar este tutorial?

Este tutorial é destinado a programadores Java interessados em desenvolver e implantar Serviços Web Restful usando a API JAX-RS e JAXB.

2. Pré-requisitos

O escopo deste tutorial é usar a API Jersey para criar serviços web Restful, invocar o serviço web usando um programa cliente Java e testar o serviço web usando a ferramenta. É necessário ter uma compreensão básica de Java, Serviços Web, XML, Maven e qualquer servidor de aplicação (JBoss/Tomcat) para entender o tutorial com facilidade.

3. Softwares e Ferramentas

Versão do JDK 1.8.0_131
Apache Maven 3.5.3
Mac OS X 10.13.4
Tomcat 8.5.16
Eclipse Java EE IDE Oxygen 4.7.3

Criando Projeto Maven Jersey no Eclipse

Crie um “Projeto Web Dinâmico” no Eclipse e em seguida converta-o para um projeto Maven. Isso nos fornecerá um projeto básico de aplicativo web baseado no Maven. Eu defini o GroupId como com.journaldev.jersey e o artifactID como meu-projeto-jersey, mas você pode especificar o que preferir. Após completarmos o desenvolvimento do nosso projeto, a estrutura do projeto se parecerá com a imagem abaixo.

Explicação do Projeto de Serviço Web Restful Java Jersey

1. pom.xml: Detalhes de configuração do projeto, observe as dependências do jersey fornecidas, outros detalhes são comuns para qualquer projeto Maven similar.

<project xmlns="https://maven.apache.org/POM/4.0.0"
	xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.journaldev.jersey</groupId>
	<artifactId>my-jersey-project</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>war</packaging>

	<dependencies>
		<dependency>
			<groupId>com.sun.jersey</groupId>
			<artifactId>jersey-server</artifactId>
			<version>1.14</version>
		</dependency>
		<dependency>
			<groupId>com.sun.jersey</groupId>
			<artifactId>jersey-servlet</artifactId>
			<version>1.14</version>
		</dependency>
		<dependency>
			<groupId>com.sun.jersey</groupId>
			<artifactId>jersey-client</artifactId>
			<version>1.14</version>
		</dependency>
	</dependencies>

	<build>
		<finalName>My-Jersey-Project</finalName>
		<plugins>
			<plugin>
				<artifactId>maven-compiler-plugin</artifactId>
				<version>3.7.0</version>
				<configuration>
					<source>1.8</source>
					<target>1.8</target>
				</configuration>
			</plugin>
			<plugin>
				<artifactId>maven-war-plugin</artifactId>
				<version>3.0.0</version>
				<configuration>
					<warSourceDirectory>WebContent</warSourceDirectory>
				</configuration>
			</plugin>
		</plugins>
	</build>
</project>

2. EmpRequest.java: Bean Java para o objeto de requisição. O importante a ser observado aqui é a anotação @XmlRootElement para mapear a classe a um elemento XML.

package com.journaldev.model;

import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement(name = "empRequest")
public class EmpRequest {
	private int id;
	private String name;

	public int getId() {
		return id;
	}

	public void setId(int id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}
}

3. EmpResponse.java: Bean Java para o objeto de resposta.

package com.journaldev.model;

import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement(name = "empResponse")
public class EmpResponse {
	private int id;
	private String name;

	public int getId() {
		return id;
	}

	public void setId(int id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

}

4. ErrorResponse.java: Bean Java que será enviado como resposta em caso de exceção.

package com.journaldev.model;

import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement(name = "errorResponse")
public class ErrorResponse {

	private String errorCode;
	private int errorId;

	public String getErrorCode() {
		return errorCode;
	}

	public void setErrorCode(String errorCode) {
		this.errorCode = errorCode;
	}

	public int getErrorId() {
		return errorId;
	}

	public void setErrorId(int errorId) {
		this.errorId = errorId;
	}

}

5. EmpNotFoundException.java: Uma classe de exceção normal lançada no serviço da web.

package com.journaldev.exception;

public class EmpNotFoundException extends Exception {

	private static final long serialVersionUID = 4351720088030656859L;
	private int errorId;

	public int getErrorId() {
		return errorId;
	}

	public EmpNotFoundException(String msg, int errorId) {
		super(msg);
		this.errorId = errorId;
	}

	public EmpNotFoundException(String msg, Throwable cause) {
		super(msg, cause);
	}
}

6. web.xml: Descritor de implantação para o serviço da web. Portanto, qualquer requisição com URI https://<HOST>:<PORT>/Meu-Projeto-Jersey/rest/* será processada pelo servlet Jersey ServletContainer. O valor init-param passado para “com.sun.jersey.config.property.packages” define o pacote que o Jersey procurará pelas classes de serviço da web. Esta propriedade deve apontar para suas classes de recursos. Ele também procura as classes de recursos nos subpacotes.

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
	xmlns="https://java.sun.com/xml/ns/javaee"
	xsi:schemaLocation="https://java.sun.com/xml/ns/javaee https://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
	id="WebApp_ID" version="3.0">
	<display-name>My Jersey Project</display-name>

	<!-- Jersey Servlet configurations -->
	<servlet>
		<servlet-name>Jersey REST Service</servlet-name>
		<servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
		<init-param>
			<param-name>com.sun.jersey.config.property.packages</param-name>
			<param-value>com.journaldev</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
	</servlet>
	<servlet-mapping>
		<servlet-name>Jersey REST Service</servlet-name>
		<url-pattern>/rest/*</url-pattern>
	</servlet-mapping>
	<!-- Jersey Servlet configurations -->

</web-app>

7. EmpRouter.java: Classe de recurso que manipula diferentes tipos de requisições.

@Path(“/emp”) – Todas as requisições com URI https://<HOST>:<PORT>/Meu-Projeto-Jersey/rest/emp/ serão processadas por esta classe de recurso.
@Caminho(“/getEmp”) – Todas as solicitações com URI https://<HOST>:<PORT>/My-Jersey-Project/rest/emp/getEmp serão processadas por este método.
@POST – Esta anotação define que o método HTTP usado deve ser POST. Alguns outros valores possíveis são @GET, @PUT, @DELETE
@Consumes(MediaType.APPLICATION_XML) – O método aceita elemento XML
@Produces(MediaType.APPLICATION_XML) – O método retorna elemento XML

package com.journaldev.router;

import com.journaldev.exception.EmpNotFoundException;
import com.journaldev.model.*;

import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.xml.bind.JAXBElement;

@Path("/emp")
public class EmpRouter {

	@POST
	@Path("/getEmp")
	@Consumes(MediaType.APPLICATION_XML)
	@Produces(MediaType.APPLICATION_XML)
	public Response getEmp(JAXBElement<EmpRequest> empRequest)
			throws EmpNotFoundException {
		EmpResponse empResponse = new EmpResponse();
		if (empRequest.getValue().getId() == 1) {
			empResponse.setId(empRequest.getValue().getId());
			empResponse.setName(empRequest.getValue().getName());
		} else {
			throw new EmpNotFoundException("Wrong ID", empRequest.getValue()
					.getId());
		}
		return Response.ok(empResponse).build();
	}
}

8. EmpNotFoundExceptionMapper.java: Classe Mapper de Exceção que mapeia EmpNotFoundException para objeto de Resposta. A classe deve ter a anotação @Provider. Esta classe deve estar no pacote fornecido para as classes de recurso em web.xml. A implementação do método toResponse() gera o objeto ErrorResponse e o define como Entidade no objeto de Resposta com status como INTERNAL_SERVER_ERROR.

package com.journaldev.exceptionmapper;

import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.ext.ExceptionMapper;
import javax.ws.rs.ext.Provider;

import com.journaldev.exception.EmpNotFoundException;
import com.journaldev.model.ErrorResponse;

@Provider
public class EmpNotFoundExceptionMapper implements
		ExceptionMapper<EmpNotFoundException> {

	public EmpNotFoundExceptionMapper() {
	}
	
	public Response toResponse(
			EmpNotFoundException empNotFoundException) {
		ErrorResponse errorResponse = new ErrorResponse();
		errorResponse.setErrorId(empNotFoundException.getErrorId());
		errorResponse.setErrorCode(empNotFoundException.getMessage());
		return Response.status(Response.Status.INTERNAL_SERVER_ERROR).entity(
				errorResponse).type(
				MediaType.APPLICATION_XML).build();

	}

}

Nosso serviço da web está pronto, basta construí-lo para criar o arquivo WAR e implantá-lo no servidor de aplicativos.

Exemplo de Cliente Jersey

Podemos usar o Cliente Jersey para chamar nosso serviço da web e obter uma resposta programaticamente. EmpClient.java: Este é um programa Java de exemplo através do qual estamos invocando nosso serviço da web. Estamos usando a API do Cliente Jersey para invocar o serviço e, com base no status da resposta, estamos analisando a entidade da resposta para a classe EmpResponse ou ErrorResponse.

package com.journaldev.client;

import javax.ws.rs.core.MediaType;

import com.journaldev.model.EmpRequest;
import com.journaldev.model.EmpResponse;
import com.journaldev.model.ErrorResponse;
import com.sun.jersey.api.client.Client;
import com.sun.jersey.api.client.ClientResponse;
import com.sun.jersey.api.client.WebResource;

public class EmpClient {

	/**
	 * @param args
	 */
	public static void main(String[] args) {
		String uri = "https://localhost:8080/My-Jersey-Project/rest/emp/getEmp";
		EmpRequest request = new EmpRequest();
		// definir id como 1 para resposta OK
		request.setId(2);
		request.setName("PK");
		try {
			Client client = Client.create();
			WebResource r = client.resource(uri);
			ClientResponse response = r.type(MediaType.APPLICATION_XML).post(ClientResponse.class, request);
			System.out.println(response.getStatus());
			if (response.getStatus() == 200) {
				EmpResponse empResponse = response.getEntity(EmpResponse.class);
				System.out.println(empResponse.getId() + "::" + empResponse.getName());
			} else {
				ErrorResponse exc = response.getEntity(ErrorResponse.class);
				System.out.println(exc.getErrorCode());
				System.out.println(exc.getErrorId());
			}
		} catch (Exception e) {
			System.out.println(e.getMessage());
		}
	}

}

Resposta de Sucesso Resposta de Erro

Resumo

Neste post, aprendemos como criar um serviço da web REST usando a API Jersey. Também investigamos o Cliente Jersey para invocar nossas APIs REST por meio de programa Java.

Você pode verificar o código do projeto completo em nosso Repositório GitHub.

Source:
https://www.digitalocean.com/community/tutorials/jersey-java-tutorial