休息使用Jersey –包含JAXB，異常處理和客戶端程序的完整教程

最近，我開始使用Jersey API開發一個Restful Web服務項目。在線提供了一些教程，但是我遇到了異常處理方面的一些問題，而且在使用JaxB和提供異常處理方法的完整項目中找不到任何地方。因此，一旦我能夠使用帶有異常處理和客戶端程序的Jersey API創建一個Restful Web服務，我決定編寫本教程來幫助每個人都開始使用Jersey。

誰應該使用本教程

本教程適用于對使用Jersey API和JaxB開發和部署Restful Web Services感興趣的Java程序員。

先決條件

本教程的范圍是使用Jersey API來創建Restful Web服務以及使用Java客戶端程序調用Web服務以及使用工具測試Web服務。為了輕松理解本教程，需要對Java，Web服務，XML，Maven和任何應用程序服務器（JBoss / Tomcat）有基本的了解。

使用的軟件和工具

JDK版本1.6.0_37
Apache Maven 3.0.3
Mac OS X 10.8.2
JBoss 4.2.2（您可以使用任何應用程序服務器，例如Tomcat，Glassfish等）
Eclipse Indigo（任何支持Maven的Java IDE）

在Eclipse和Jersey中創建Maven項目

在Eclipse中創建一個Maven項目，它將為您提供基本的項目結構。我已經將GroupId設置為“ JD”，將artifactID設置為“ my-jersey-project”，但是您可以提供任何您喜歡的東西。一旦完成項目的開發，圖像將如下圖所示。

Jersey Web服務項目說明

pom.xml ：項目配置詳細信息，請注意提供的jersey依賴項，其他詳細信息對于任何Maven項目都是通用的。

<project xmlns='http://maven.apache.org/POM/4.0.0' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xsi:schemaLocation='http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd'><modelVersion>4.0.0</modelVersion><groupId>JD</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>${artifactId}-${version}</finalName><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><configuration><source>1.6</source><target>1.6</target></configuration></plugin><plugin><artifactId>maven-war-plugin</artifactId><version>2.1-alpha-2</version><configuration><packagingExcludes>WEB-INF/lib/servlet-api-*.jar</packagingExcludes></configuration></plugin><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-dependency-plugin</artifactId><version>2.0</version><executions><execution><id>unpack</id><phase>install</phase><goals><goal>unpack</goal></goals><configuration><artifactItems><artifactItem><groupId>${groupId}</groupId><artifactId>${artifactId}</artifactId><version>${version}</version><type>${packaging}</type><overWrite>true</overWrite><outputDirectory>${project.build.directory}/${artifactId}-${version}-exploded.${packaging}</outputDirectory></artifactItem></artifactItems></configuration></execution></executions></plugin></plugins></build>
</project>

EmpRequest.java ：請求對象的Java Bean。這里要注意的重要事情是@XmlRootElement批注，用于將類映射到XML元素。

package com.jd.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;}
}

EmpResponse.java ：響應對象的Java bean。

package com.jd.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;}}

ErrorResponse.java ：在發生異常的情況下將作為響應發送的Java Bean。

package com.jd.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;}}

EmpNotFoundException.java：Web服務中引發的普通異常類。

package com.jd.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);}
}

jboss-web.xml ：為Web服務定義JBoss servlet上下文。

<jboss-web><context-root>jd</context-root>
</jboss-web>

web.xml ：Web服務的部署描述符。因此，任何帶有URI“ http：// <HOST>：<POST> / jd / rest / *”的請求都將由Jersey ServletContainer servlet處理。要注意的重要事項是為“ com.sun.jersey.config.property.packages”傳遞的init-param值。這定義了jersey將在哪個程序包中查找Web服務類。此屬性必須指向您的資源類。它還在子包中查找資源類。

<?xml version='1.0' encoding='UTF-8'?>
<web-app id='WebApp_ID' version='2.5'xmlns='http://java.sun.com/xml/ns/javaee' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'xsi:schemaLocation='http://java.sun.com/xml/ns/javaeehttp://java.sun.com/xml/ns/javaee/web-app_2_5.xsd'><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.jd</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>

EmpRouter.java ：處理不同類型請求的資源類。

@Path（“ / emp”）–具有URI http：// <HOST>：<PORT> / jd / rest / emp /的所有請求將由該資源類處理。
@Path（“ / getEmp”）–使用URI http：// <HOST>：<PORT> / jd / rest / emp / getEmp的所有請求都將通過此方法處理。
@POST –此注釋定義所使用的HTTP方法應為POST。其他一些可能的值是@ GET，@ PUT，@ DELETE
@Consumes（MediaType.APPLICATION_XML）–該方法接受XML元素
@Produces（MediaType.APPLICATION_XML）–該方法返回XML元素

package com.jd.router;import com.jd.exception.EmpNotFoundException;
import com.jd.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();}
}

EmpNotFoundExceptionMapper.java ：異常Mapper類，將EmpNotFoundException映射到Response對象。該類應具有批注@Provider。此類應位于web.xml中為資源類提供的包中。 toResponse（）方法的實現會生成ErrorResponse對象，并將其設置為Response對象中的Entity，狀態為INTERNAL_SERVER_ERROR。

package com.jd.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.jd.exception.EmpNotFoundException;
import com.jd.model.ErrorResponse;@Provider
public class EmpNotFoundExceptionMapper implementsExceptionMapper<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文件并將其部署在應用程序服務器中。

EmpClient.java ：這是一個示例Java程序，通過它可以調用我們的Web服務。我們正在使用jersey客戶端API調用服務，并基于響應狀態將響應實體解析為EmpResponse或ErrorResponse類。

package com.jd.client;import javax.ws.rs.core.MediaType;import com.jd.model.EmpRequest;
import com.jd.model.EmpResponse;
import com.jd.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 = 'http://localhost:8080/jd/rest/emp/getEmp';EmpRequest request = new EmpRequest();//set id as 1 for OK responserequest.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編寫并編寫您的第一個Restful Web服務。
如果您遇到任何問題或需要進一步的說明，請告訴我。

參考： 休息使用Jersey – 開發人員食譜博客上的JCG合作伙伴 Pankaj Kumar 提供的JAXB，異常處理和客戶端程序的完整教程。