JSR 315: Java Servlet 3.0 Specification
現在、Javaで構築するWebアプリケーションのためにはさまざまなフレームワークが用意されているが、基本となるのはServletにほかならない。次期Java EEプラットフォームとなるJava EE 6ではServlet仕様の大幅なアップデートが予定されており、その仕様がJSR 315として策定されている。本コラムでも第17回でその概要を紹介しているが、去る5月5日にEarly Draftが公開されたので、さっそく目を通してみたいと思う。
アノテーションの追加
Servlet 3.0ではEoDをさらに促進するため、ServletやFilterなどを定義するためのアノテーションが用意される予定となっている。これによってコードの記述量の削減やweb.xmlなどに対する設定の簡略化を実現する。具体的には次のようなアノテーションが挙げられている。
- @Servlet……Servletを定義する
- @ServletFilter……ServletFilterを定義する
- @FilterMapping……Filterのマッピングを指定する
- @InitParam……ServletやFilerにおける初期パラメータを指定する
- @ServletContextListener……ContextListenerを定義する
また、上記以外にJAX-RS(The Java API for RESTful Web Services)に用意されるHTTPメソッドのためのアノテーション(@HttpMethod/@GET/@POST/@PUT/@HEAD/@DELETE)も利用可能となる。
たとえば@ServletはServlerのコンポーネントとなるクラスに対して指定し、属性によってマッピングや初期パラメータなどのメタデータを定義することが可能になる。リスト1は@Servletを用いたServlet定義の例。urlMapping属性は必須で、その他はオプションとのこと。
リスト1 アノテーションを用いたServletの定義
@Servlet(urlMapping="/foo")
public class SimpleServlet {
//...
}
リスト2のようにメソッドに@GETや@POSTなどを指定すれば、GETやPOSTを処理するためのメソッドとすることができる。
リスト2 HTTPメソッドを指定
@Servlet(urlMappings={"/foo", "/bar"})
public class SampleUsingAnnotationAttributes {
@GET
public void handleGet(HttpServletRequest req, HttpServletResponse res) {
}
}
なお、従来通り上記の設定をweb.xmlに記述した場合には、web.xmlの内容の方が優先されるとのこと。また3.0からはweb.xmlは必須ではなくなり、JSPや静的リソースしか利用しない場合には省略できるようになるそうだ。
プラガビリティの強化
Webフレームワークを使用する場合、従来だとweb.xmlに指定されたFilterなどの設定を記述しなければならなかった。Servlet 3.0では大元のweb.xmlに対する追加の設定を、各フレームワークのJARファイルに含められるようにすることで、フレームワークの柔軟な追加/削除を実現するという。具体的には各JARファイルにMETA-INF/web.xmlを用意し、ここにそれぞれの設定を記述する。
記述方法は通常のweb.xmlと同様だが、リスト3全体を<web-fragment>というタグで囲む。
リスト3 META-INF/web.xmlの記述例
<web-fragment>
<servlet>
<servlet-name>welcome</servlet-name>
<servlet-class>WelcomeServlet</servlet-class>
</servlet>
<listener>
<listener-class>RequestListener</listener-class>
</listener>
</web-fragment>
また、ServletContextにweb.xmlにアクセスするためのメソッドが追加されるとのことで、これを使えば初期化時にフレームワーク側から設定を追加することができるようになる。用意されるメソッドはServletとそのマッピングを追加するaddServlet()およびaddServletMapping()、Filterとそのマッピングを追加するaddFilter()、addFilterMapping()の4種類。例えば任意のServletをロードしたい場合には、前述の@ServletContextListenerを利用してリスト4のようにContextListenerを定義する。
リスト4 初期化時にServletをロードする
@ServletContextListener
public class MyContextListener {
public void contextInitialized(ServletContextEvent sce) {
ServletContext sc = sce.getServletContext();
sc.addServlet("myServlet", "Sample servlet", "foo.bar.MyServlet", null, -1);
sc.addServletMapping("myServlet", new String[] {"/urlpattern/*" });
}
}
非同期サーブレット
Servler 3.0ではリクエストのサスペンドやレジューム、レスポンスの無効化を可能にすることで、Cometなど非同期のサービス呼び出しをサポートするとのこと。具体的には、ServletRequestおよびServletResponseに以下のようなメソッドが追加される。ただし、現時点ではレジューム時にどうやって別スレッドへ処理をディスパッチするかなどについては明記されてはいない。
ServletRequestに追加されるメソッド
| void suspend() | コンテナの指定するタイムアウト時間でリクエストの処理をサスペンドする |
|---|---|
| void suspend(long timeOutMs) | 指定されたタイムアウト時間でリクエストの処理をサスペンドする |
| void resume() | サスペンドされているリクエストを再開する |
| void complete() | サスペンドされたリクエストの処理を完了させる |
| boolean isSuspended() | リクエストがサスペンドされ、再開される前かどうかを返す |
| boolean isResumed() | サスペンドされたリクエストが再開されたかどうか返す |
| boolean isTimeout() | サスペンドがタイムアウトを迎えたかどうかを返す |
| boolean isInitial() | リクエストが一度も再ディスパッチされていない場合にtrueを返す |
ServletResponseに追加されるメソッド
| void disable() | レスポンスを無効にする |
|---|---|
| void enable() | レスポンスを有効にする |
| boolean isDisabled() | レスポンスが無効にされたかどうかを返す |
また、ServletRequestListenerに以下のメソッドが追加され、リクエストがサスペンドされたり再開されたりした場合にイベントを受け取ることができるようになる。
- void requestSuspended(ServletRequestEvent rre)
- void requestResumed(ServletRequestEvent rre)
- void requestCompleted(ServletRequestEvent rre)
その他の拡張
その他、次のような機能が追加される予定だ。
HTTP-Only Cookieのサポート
HTTP-Only CookieはクライアントサイドのスクリプトからアクセスできないようなCookieのことで、クロスサイトスクリプティング攻撃を防ぐ有効な手段になるとのこと。
Session Tracking Cookieが設定可能に
Session Tracking Cookieを利用すればCookieによるセッショントラッキングが可能となるが、従来はサーバ依存の設定項目だった。3.0からはこれが標準でサポートされるようになる。
セキュリティ関連
ログインおよびログアウトの機構を実現するために、HttpServletRequestやHttpSessionにlogin()/logout()メソッドを追加する予定とのこと。ただし、この部分の詳細は現在もExpertGroupにおいて調整中で、現時点のドラフトには含まれていない。
また、先日行われたJavaOneの際のテクニカルセッションでは、上記以外に検討中の内容として次のようなものが挙げられていた。
現在のEarly Draftは6月4日までの間にレビューが行われ、その結果を反映させて今年の夏ごろにPublic Reviewを行うとのことだ。
