対象読者
- Java EE開発に興味ある方
- これからJavaのWebアプリケーション開発をはじめる方
必要な環境
動作環境は以下のとおりです。
- Java EE 6 / Java EE 7
- NetBeans IDE 7.3 / 7.3.1
本サンプルはJavaEE6とJavaEE7での動作確認済みです。
JavaEE7の環境はGlassFish4.0で動作確認を行なっています。JavaEE7用のプロジェクトファイルはSampleApp7.zipです。
JAX-RSとは
JAX-RSとはREST（※1）アーキテクチャに則って、JavaでWebサービスを提供する仕様で、JSR-311（※2）で定義されています。また、RESTに従ったシステムをRESTfulと呼び、今回紹介するJAX-RSはRESTのルールに従っています。NetBeans7.3はJAX-RSのWebサービスを簡単に作成できます。Webサービスを最小限の設定内容で構築できますので、簡単かつ非常に扱いやすい仕組みです。
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)
RESTに従うアプリケーションではURIでリソースを定義します。JAX-RSではこのリソース定義に対しアノテーションで設定可能です。詳細については後述する「JAX-RSアプリケーションの作成と動作確認」と「リソース取得とパス定義」で説明します。
またリソースに対して読み込みや書き込みなどの操作はHTTPメソッドを使って行います。
（b）リソースの操作方法を4つのHTTPメソッドで定義
リソースの操作をHTTPメソッドを利用して定義します。URIが同一であってもHTTPメソッドによって読み込みや書き込みなど、操作を切り替えます。Java EE6のJAX-RSでは次のように定義しています。
| 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）について解説します。
