Jersey Javaチュートリアル

チュートリアル
Java

Java Jersey チュートリアルへようこそ。最近、JAX-RS Jersey フレームワークを使用した Restful web サービスプロジェクトに取り組み始めました。

Java Jersey フレームワークとは何ですか？

Java Jersey プロジェクトは、Java で Restful web サービスを作成するために使用される JAX-RS API を追跡します。

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サービスプロジェクトの説明

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。ここで重要なのは、クラスをXML要素にマップするための@XmlRootElementアノテーションです。

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サーブレットによって処理されます。init-paramの値である”com.sun.jersey.config.property.packages”は、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”）- https://<HOST>:<PORT>/My-Jersey-Project/rest/emp/getEmpというURIのリクエストは、このメソッドで処理されます。
  • @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オブジェクトを生成し、内部サーバーエラーのステータスで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();

	}

}

ウェブサービスは準備ができています。WARファイルをビルドしてアプリケーションサーバーにデプロイしてください。

Jersey Clientの例

Jersey Clientを使用して、プログラムからWebサービスを呼び出し、応答を取得することができます。 EmpClient.java：このサンプルのJavaプログラムでは、Webサービスを呼び出すために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();
		// OKの応答の場合、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 Webサービスを作成する方法を学びました。また、Jersey Clientを使用して、Javaプログラムを介してREST APIを呼び出す方法も見てみました。

完全なプロジェクトコードは、GitHubリポジトリからご確認いただけます。

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