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/ 的請求將由此資源類處理。
@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 對象的 Exception Mapper 類。該類應該具有 @Provider 標註。此類應位於 web.xml 中為資源類提供的套件中。 toResponse() 方法的實現生成 ErrorResponse 對象並將其設置為具有狀態為 INTERNAL_SERVER_ERROR 的 Response 對象的實體。

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 以獲取正確的回應
		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 網路服務。我們還瞭解了如何通過 Java 程式呼叫我們的 REST API 以及 Jersey 客戶端。

您可以從我們的 GitHub 存儲庫檢查完整的項目代碼。

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