ジャージ・ジャワ・チュートリアル
「Java Jerseyチュートリアルへようこそ。最近、JAX-RS Jerseyフレームワークを使用したRestfulウェブサービスプロジェクトに取り組み始めました。」
Java Jersey フレームワークとは何ですか？
Java Jerseyプロジェクトは、JavaでRestfulウェブサービスを作成するために使用されるJAX-RS APIを追跡しています。
このチュートリアルを利用するべき人は誰ですか？
このチュートリアルは、JAX-RS APIとJAXBを使用してRestful Webサービスを開発および展開したいJavaプログラマーを対象としています。
2. 必要条件 (Hitsuyō jōken)
このチュートリアルの範囲は、Jersey APIを使用してRestfulウェブサービスを作成し、Javaのクライアントプログラムを使用してウェブサービスを呼び出し、ツールを使用してウェブサービスをテストすることです。Java、Webサービス、XML、Maven、およびアプリケーションサーバー（JBoss/Tomcat）に関する基本的な理解があれば、このチュートリアルを容易に理解できます。
3. ソフトウェアとツール
- JDK version 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
ジャージのEclipse Maven プロジェクトの作成
Java JerseyのRESTful Webサービスプロジェクトの説明
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.scdev.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です。ここで注目すべき重要な点は、クラスをXML要素にマップするための@XmlRootElementアノテーションです。
package com.scdev.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ビーン。
package com.scdev.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.scdev.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.scdev.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://:/My-Jersey-Project/rest/*であるリクエストは、Jersey ServletContainerサーブレットによって処理されます。init-paramの値は、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.scdev</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”) – All the requests with URI https://:/My-Jersey-Project/rest/emp/ will be processed by this resource class.
- @Path(“/getEmp”) – All the requests with URI https://:/My-Jersey-Project/rest/emp/getEmp will be processed by this method.
- @POST – This annotation defines that the HTTP method used should be POST. Some other possible values are @GET, @PUT, @DELETE
- @Consumes(MediaType.APPLICATION_XML) – The method accepts XML element
- @Produces(MediaType.APPLICATION_XML) – The method returns XML element
package com.scdev.router;
import com.scdev.exception.EmpNotFoundException;
import com.scdev.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()メソッドの実装では、INTERNAL_SERVER_ERRORをステータスとして持つErrorResponseオブジェクトを生成し、ResponseオブジェクトでEntityとして設定します。
package com.scdev.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.scdev.exception.EmpNotFoundException;
import com.scdev.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 Clientを使用して、Webサービスを呼び出し、プログラムで応答を取得することができます。EmpClient.java：これは私たちのウェブサービスを呼び出すためのサンプルのJavaプログラムです。私たちはJersey Client APIを使用してサービスを呼び出し、応答の状態に基づいて応答エンティティをEmpResponseまたはErrorResponseクラスに解析しています。
package com.scdev.client;
import javax.ws.rs.core.MediaType;
import com.scdev.model.EmpRequest;
import com.scdev.model.EmpResponse;
import com.scdev.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();
// set id as 1 for OK response
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 Clientを使用してJavaプログラムを通じてREST APIを呼び出す方法も見てみました。
弊社のGitHubリポジトリから、プロジェクトコード全体をチェックアウトすることができます。