JAX-RSを使ったWebサービスの作成

CodeZine / 2013年6月18日 14時0分

図12 Webサービスのテスト結果

 本連載は、Java Enterprise Edition 6(Java EE 6)の導入方法をはじめとして、新導入された仕様や概念を紹介していきます。今回はNetBeans IDEを使い、JAX-RSを使ったWebサービスを作成する手順を紹介します。

■対象読者

Java EE開発に興味ある方 これからJavaのWebアプリケーション開発をはじめる方 ■必要な環境

 動作環境は以下のとおりです。

Java EE 6 NetBeans IDE 7.3 ■JAX-RSとは

 JAX-RSとはREST(※1)アーキテクチャに則って、JavaでWebサービスを提供する仕様で、JSR-311(※2)で定義されています。また、RESTに従ったシステムをRESTfulと呼び、今回紹介するJAX-RSはRESTのルールに従っています。NetBeans7.3はJAX-RSのWebサービスを簡単に作成できます。Webサービスを最小限の設定内容で構築できますので、簡単かつ非常に扱いやすい仕組みです。

※1
 RESTはRepresentational State Transferの略称。



※2
 Java Specification Requestsの略。Javaプラットフォームに追加される提案仕様や技術を記述した公式文書とその番号。



■RESTfulとJAX-RS

 Java EE6では、RESTfulアプリケーションを次のように説明しています。

(a)リソースの要求をURIのパスで定義 (b)リソースの操作方法を4つのHTTPメソッドで定義 (c)取得したリソースはそのデータフォーマットも定義 (d)ステートフルなハイパーリンクである  まずはこれらの定義を解説します。

●(a)リソースの要求をURIのパスで定義する

 これはアプリケーションに要求するHTTPリクエストのURIがもつ構造に関する定義です。すべてのリソースの要求はHTTPリクエストで行われ、要求するサービスやパラメータもすべてパスで一意に定義されます。例えばユーザー情報検索のサービスがuserinfoで定義され、取得するユーザー情報1件をユーザーIDで指定する場合は、次のようなURIになります。

http://(ドメイン名)/(コンテキスト)/userinfo/(ユーザーID)  従来のサーブレットでは、このURL以外にクエリ文字列やフォームからのパラメータを使い、サーバへ送信します。しかしRESTに従うアプリケーションでは、これらのパラメータもURIに含めます。JAX-RSではこの設定をアノテーション1つで設定可能です。詳細については後述する「JAX-RSアプリケーションの作成と動作確認」と「リソース取得とパス定義」で説明します。

●(b)リソースの操作方法を4つのHTTPメソッドで定義

 リソースの操作をHTTPメソッドを利用して定義します。URIが同一であってもHTTPメソッドによって読み込みや書き込みなど、操作を切り替えます。Java EE6のJAX-RSでは次のように定義しています。

表1 HTTPメソッドと操作内容 HTTPメソッド リソースの操作内容 PUT 追加 GET 取得 POST 更新 DELETE 削除 JAX-RSではこれらのHTTPメソッドに対応したJavaクラスの定義を、アノテーション1つで設定可能です。詳細については後述する「JAX-RSアプリケーションの作成と動作確認」で説明します。

●(c)取得したリソースはそのデータフォーマットも定義

 リソースの要求から得られるデータ形式はHTMLやXML以外にも、JSON、通常テキスト、PDFなど、データのフォーマットも存在します。JAX-RSではこれらのデータ形式を宣言するアノテーションが用意されており、データに対してフォーマットを定義する仕組みが用意されています。

●(d)ステートフルなハイパーリンクであること

 RESTではリソースの定義は状態を持たないステートレスな状態であり、すべての状態をURIに含めなければならないと定義しています。このため、URIにすべての情報を含んでいないステートフルな状態はRESTに反しています。ステートフルとは、具体的にはURIリライティングやクッキー情報、送信フォームの隠しパラメータなど、リクエストするURL以外に状態を保持する仕組みを使った従来のWebアプリケーションがよく行っている手法のことです。

 今回は特に(a)(c)について解説します。



CodeZine

トピックスRSS

ランキング