Jersey Java 教程

教程
Java

欢迎来到Java Jersey教程。最近，我开始使用JAX-RS Jersey框架在一个Restful web服务项目上进行工作。

什么是Java Jersey框架？

Java Jersey项目跟踪JAX-RS API，该API用于在Java中创建Restful web服务。

1. 谁应该使用这个教程？

这个教程适用于对使用JAX-RS API和JAXB开发和部署Restful Web服务感兴趣的Java程序员。

2. 先决条件

本教程的范围是使用Jersey API创建Restful web服务，使用Java客户端程序调用web服务，并使用工具测试web服务。为了更轻松地理解本教程，需要基本了解Java、Web服务、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 中创建“Dynamic Web Project”，然后将其转换为 Maven 项目。这将为我们提供一个基于 Maven 的 Web 应用程序基本项目。我已将 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：在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：Web服务的部署描述符。因此，任何以URI https://<HOST>:<PORT>/My-Jersey-Project/rest/* 发送的请求将由Jersey ServletContainer servlet处理。传递给“com.sun.jersey.config.property.packages”的init-param值定义了Jersey将查找Web服务类的包。此属性必须指向您的资源类。它还会查找子包中的资源类。

<?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/ 发送的请求将由此资源类处理。
  • @路径(“/getEmp”) – 所有带有URI https://<HOST>:<PORT>/My-Jersey-Project/rest/emp/getEmp 的请求将由此方法处理。
  • @发布 – 此注释定义了使用的HTTP方法应为POST。其他可能的值包括 @获取、@放置、@删除
  • @消费(MediaType.APPLICATION_XML) – 该方法接受XML元素
  • @生成(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对象的异常映射器类。该类应具有@提供者注释。此类应位于web.xml中为资源类提供的包中。 toResponse() 方法的实现生成ErrorResponse对象，并将其设置为带有状态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();

	}

}

我们的Web服务已准备就绪，只需构建它以创建WAR文件并将其部署到应用程序服务器中。

Jersey客户端示例

我们可以使用Jersey客户端来调用我们的网络服务并以编程方式获取响应。EmpClient.java：这是一个示例Java程序，通过它我们调用我们的网络服务。我们使用Jersey客户端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以获取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());
		}
	}

}

成功响应 错误响应

摘要

在本篇文章中，我们学习了如何使用Jersey API创建REST网络服务。我们还深入了解了Jersey客户端，通过Java程序调用我们的REST API。

您可以从我们的GitHub存储库中查看完整的项目代码。

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