Добро пожаловать на учебник по Java Jersey. Недавно я начал работать над проектом веб-сервиса Restful, используя фреймворк JAX-RS Jersey.
Что такое фреймворк Java Jersey?
Проект Java Jersey отслеживает API JAX-RS, который используется для создания Restful веб-сервисов на Java. 
1. Кому следует использовать этот учебник?
Этот учебник предназначен для программистов Java, заинтересованных в разработке и развертывании Restful веб-сервисов с использованием API JAX-RS и JAXB.
2. Предварительные требования
Цель этого учебника – использование API Jersey для создания Restful веб-сервисов, вызова веб-сервиса с помощью Java-клиентской программы и тестирование веб-сервиса с использованием инструмента. Базовое понимание Java, веб-сервисов, XML, Maven и любого сервера приложений (JBoss/Tomcat) требуется для легкого понимания учебника.
3. Программное обеспечение и инструменты
- Версия 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
Создание проекта Jersey Eclipse Maven
Создайте “Динамический веб-проект” в Eclipse, а затем преобразуйте его в проект Maven. Это предоставит нам базовый проект веб-приложения на основе Maven. Я указал GroupId как com.journaldev.jersey и artifactID как my-jersey-project, но вы можете указать что угодно. После завершения разработки нашего проекта структура проекта будет выглядеть как на изображении ниже. 
Объяснение проекта Java Jersey Restful Web Service
1. pom.xml: Детали конфигурации проекта, обратите внимание на предоставленные зависимости jersey, другие детали обычны для любого аналогичного проекта maven.
<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: Java Bean для объекта запроса. Важно отметить здесь аннотацию @XmlRootElement для отображения класса в 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: Java Bean для объекта ответа.
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: Java Bean, который будет отправлен в ответе в случае исключения.
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: Обычный класс исключения, выбрасываемый в веб-сервисе.
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: Файл развёртывания для веб-сервиса. Таким образом, любой запрос с URI https://<HOST>:<PORT>/My-Jersey-Project/rest/* будет обрабатываться сервлетом Jersey ServletContainer. Значение init-param, переданное для “com.sun.jersey.config.property.packages”, определяет пакет, в котором jersey будет искать классы веб-сервиса. Это свойство должно указывать на ваши классы ресурсов. Он также ищет классы ресурсов в подпакетах.
<?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: Класс ресурса, обрабатывающий различные виды запросов.
- @Path(“/emp”) – Все запросы с URI
https://<HOST>:<PORT>/My-Jersey-Project/rest/emp/будут обрабатываться этим классом ресурса. - @Path(“/getEmp”) – Все запросы с URI
https://<HOST>:<PORT>/My-Jersey-Project/rest/emp/getEmpбудут обрабатываться этим методом. - @POST – Эта аннотация определяет, что используемый HTTP-метод должен быть POST. Некоторые другие возможные значения: @GET, @PUT, @DELETE
- @Consumes(MediaType.APPLICATION_XML) – Метод принимает XML-элемент
- @Produces(MediaType.APPLICATION_XML) – Метод возвращает 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: Класс-обработчик исключений, который отображает EmpNotFoundException на объект Response. Класс должен иметь аннотацию @Provider. Этот класс должен находиться в пакете, предоставленном для классов ресурсов в файле web.xml. Реализация метода toResponse() генерирует объект ErrorResponse и устанавливает его как Entity в объекте Response со статусом 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();
}
}
Наш веб-сервис готов, просто соберите его, чтобы создать файл WAR и развернуть его на сервере приложений.
Пример клиента Jersey
Мы можем использовать Jersey Client для вызова нашего веб-сервиса и получения ответа программным образом. EmpClient.java: Это образец java-программы, через которую мы вызываем наш веб-сервис. Мы используем Jersey Client API для вызова сервиса и на основе статуса ответа мы разбираем сущность ответа на класс EmpResponse или 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();
// установка id как 1 для успешного ответа
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());
}
}
}
Успешный ответ 
Ошибка ответа 
Сводка
В этом посте мы узнали, как создать веб-сервис REST с помощью Jersey API. Мы также рассмотрели Jersey Client для вызова наших REST API через java-программу.
Вы можете проверить полный код проекта в нашем репозитории GitHub.
Source:
https://www.digitalocean.com/community/tutorials/jersey-java-tutorial