JAX-RSを使ったWebサービスのカスタマイズ

Java EE 6 開発入門（9）

　では実際に先ほどテストで確認したブラウザで、アドレスバーに次のようにパスを追加して実行してみましょう。

• http://localhost:8080/SampleApp/webresources/user/ABC0001

　今回はそのまま表示するアプリケーションなので、次の図のようにユーザーIDの内容が表示されます。

図1 ユーザーIDのパスを追加したリソースの実行結果

　同様に、複数のリソースを指定した場合も、同じようにパスと対応するメソッドを用意します。例えばユーザーID、メールアドレス、電話番号の3つのリソースを指定する場合は、次のようにURIを定義します。

• http://localhost:8080/SampleApp/webresources/user/[ユーザ-ID]/[メールアドレス]/[電話番号]

　これを受け取るリソースクラスは、次のようになります。

リスト7 パラメータ用パスを3つ定義したリソースクラス UserResource.java

@Path("user/{userid}/{mailAddress}/{phone}") …（1）
public class UserResource {
    …(省略)…
    @GET
    @Produces("text/plain")
    public String getText(
            @PathParam("userid") String id ,            …（2）
            @PathParam("mailAddress") String address ,
            @PathParam("phone") String phone 
    ) {
        Map<String,String> userinfo = new HashMap<String,String>();
        userinfo.put("userid", id);
        userinfo.put("mailAddress", address);
        userinfo.put("phone", phone);
        
        return userinfo.toString();    …（3）
    }
}

　（1）では受け取るパスの定義をしています。順にユーザーID、メールアドレス、電話番号を受け取るパスに対するパラメータをuserid、mailAddress、phoneと定義しています。

　（2）では（1）で定義したリソースをメソッドの引数に渡しています。

　今回は設定と実装内容の差が分かりやすいよう、リソースと実際のメソッドの引数名を別の名称を割り当てていますが、実用する際には合わせておいた方が実装しやすいため、合わせておくと良いでしょう。

　（3）でリクエストされたパスに含まれたリクエスト情報は、java.util.Mapに格納したものをStringに変換したものを返します。

　これを表示するURLは例えば次のようになります。

• http://localhost:8080/SampleApp/webresources/user/A-pZ/[e-mail]/090-9999-9999

　これを先ほどと同様に表示したブラウザのアドレスバーに入力します。すると次の図のようにjava.util.Mapを文字列形式で表示されます。

図2 3つのパスパラメータを追加したリソースの実行結果

　このようにパラメータ用のパスをいくつか追加した場合も、その内容に合わせてパス階層とパスパラメ―タの定義をするだけで利用可能になります。

パスパラメータの制限

　正規表現を使って、URIに指定可能な文字列を制限することも可能です。例えばユーザーIDに対して、先頭は英文字、以降は英数のみ許可するなどです。この設定も@Pathで行います。次に例を示します。

リスト8 パスに正規表現で制限を行ったリソースクラス UserResource.java

@Path("user/{userid: [a-zA-Z][a-zA-Z0-9]*}/{mailAddress}/{phone}") …（1）
public class UserResource {
    …(省略)…
}

　useridのパスでは先頭は英文字、以降は英数のみ許可しています。この正規表現で利用できる制御文字は「[^/]+?」です。

　ではこの@Pathで設定した内容で、先ほどリクエストしたURIを使います。このユーザーIDのパスには英数以外の記号が含まれています。

• http://localhost:8080/SampleApp/webresources/user/A-pZ/[e-mail]/090-9999-9999

　これを実行すると、パス設定で行った正規表現に合致しないため「そのようなリソースは存在しない」とみなして、HTTPレスポンスコードの404（Not Found）が返されます。

図3 正規表現で合致しない値を指定した結果

　このようにパス設定で不要な値をリクエストしても、サーバー側はリソースがないと返しますので、通常のHTTPリクエストでファイルが存在しない時と同等のレスポンスです。もちろんユーザーIDの箇所を英字から始まる文字列に指定することで、先ほどと同様のユーザー情報を返す画面が表示されます。

　実際に機能を追加していくときは、ウィザードから自動生成された@GETメソッドや@PUTメソッドを参考にメソッドを追加していくことでリソースの機能を追加し、新たなクラスを同じ手順で作成し、リソースを追加していきます。

終わりに

　JAX-RSはJavaでWebサービスを簡単に提供できる非常に優れた仕組みで、RESTアーキテクチャに従った一定の作法と、Webアプリケーションで使われているデータフォーマットを簡単に定義できる強みがあります。NetBeansでは設定ファイルも不要になるので、より一層サービスを作りやすい仕組みと言えるのではないでしょうか。

　Java EE6はWebアプリケーションで昨今求められる仕様や機能を盛り込みつつ、実装までの手間を軽減する仕組みも導入されてきました。次期リリースであるJava EE7ではさらに実装手順の簡略化とともに、JSFやJAX-RS、ELも大幅に機能更新が予定されています。

参考文献

• The Java EE 6 Tutorial:Creating a RESTful Root Resource Class
• Example Applications for JAX-RS