Javaサーブレット開発入門 - わかりやすい図解解説 » Javaサーブレット入門

セッションによるデータ受け渡し(セッションオブジェクトの利用)

admin — Wed, 29 Apr 2015 03:13:57 +0000

前回に引き続き、セッション管理に関するサンプルサーブレットを作成していきます。今回は、サーブレット間でのデータ受け渡しを行います。

まずは、作成していくサーブレットの内容を下記します。

適当な質問フォームを表示し、ユーザーに入力させます。

「サーブレット呼び出し」ボタンを押せば、入力されたデータがサーブレット「SampleSessionCtl」に渡されます。

サーブレット「SampleSessionCtl」では、セッションオブジェクトを生成し、生成したセッションオブジェクトに、フォームから受け取ったデータを保存します。さらに、そのデータとセッションIDを表示するHTMLをレスポンスとして返します。

「次のサーブレット呼び出し」をクリックすると、サーブレット「SampleSessionGetServlet」を呼び出します。

サーブレット「SampleSessionGetServlet」では、セッションオブジェクトを取得し、セッションオブジェクトからSampleSessionCtlサーブレットで保存したデータとセッションIDを取得します。さらに、それらのデータを表示するHTMLをレスポンスとして返します。

サーブレット間でデータが受け渡せていることが確認できます。

セッション操作メソッド一覧

セッションを操作するには、主に下記メソッドを使用します。

void setAttribute(String name, Object value)

セッションオブジェクト(HttpSessionオブジェクト)に属性を保存するメソッドです。引数にはString型の属性名とObject型の属性値を指定します。

下記例では、属性名を「MyName」、属性値を「TARO YAMADA」としています。
HttpSession session = request.getSession();
session.setAttribute(“MyName”, “TARO YAMADA”);

Object getAttribute(String name)

セッションオブジェクトに保存されている属性値を取得するメソッドです。引数には取得したい属性名を指定します。戻り値として返される属性値の型はObject型になるので、文字列の場合はString型にキャストします。

HttpSession session = request.getSession();
myName = (String) session.getAttribute(“MyName”);

void setMaxInactiveInterval(int 有効期限)

セッションの有効期限を設定するメソッドです。指定した有効期限を超えるとセッションは無効となり新たなセッションとして管理できます。有効期限はクライアントが最後にアクセスしてからおおよその経過時間を秒単位で指定します。

void invalidate()

セッションオブジェクトを明示的に無効にするメソッドです。セッション管理に有効期限が設定されている場合はクライアントからアクセスがないまま一定時間経過すると、自動的にセッションは無効になります。一方、任意のタイミングで明示的に無効にしたい場合は本メソッドを使用します。

サンプルサーブレットのソースコード

以降に各サーブレットのソースコードを記載します。(冗長な部分は省略し、主要な部分のみ記載しています。)

まずは、サーブレット呼び出し用のフォームを作成します。





セッション管理サーブレットサンプル(データ受け渡し)


セッション管理サーブレットサンプル(データ受け渡し)

あなたの名前は？

好きなゲームは？

「サーブレットの呼び出し」ボタンをクリックした場合のアクションとして、SampleSessionCtlサーブレットを呼び出してします。その際のリクエストの種類には「GET」を指定しています。

SampleSessionCtlサーブレットのdoGet()メソッドには下記のように記述します。

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    String userName = request.getParameter("UserName");
    String gameName = request.getParameter("GameName");
    
    HttpSession session = request.getSession();
    session.setAttribute("UserName", userName);
    session.setAttribute("GameName", gameName);

    PrintWriter out = response.getWriter();
    out.println("");
    out.println("");
    out.println("セッションの生成");
    out.println("");
    out.println("");
    out.println("セッションの生成(ページ1)");
    out.println("あなたの名前は「" + userName + "」です。");
    out.println("好きなゲームは「" + gameName + "」です。");
    out.println("セッションIDは「" + session.getId() + "」です。");
    out.println("次のサーブレット呼び出し");
    out.println("");
    out.println("");
}

getSession()メソッドでHttpSessionオブジェクト生成し、setAttribute()メソッドでフォームから受け取ったデータをセッションオブジェクトに保存しています。

「次のサーブレット呼び出し」のリンク先として、SampleSessionGetServletサーブレットを指定します。その場合のリクエストの種類には「GET」になります。

SampleSessionGetServletサーブレットのdoGet()メソッドには下記のように記述します。

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    String userName = "";
    String gameName = "";
    
    HttpSession session = request.getSession();
    userName = (String) session.getAttribute("UserName");
    gameName = (String) session.getAttribute("GameName");
    
    PrintWriter out = response.getWriter();
    out.println("");
    out.println("");
    out.println("セッションオブジェクトの取得");
    out.println("");
    out.println("");
    out.println("セッションオブジェクトの取得(ページ2)");
    out.println("あなたの名前は「" + userName + "」です。");
    out.println("好きなゲームは「" + gameName + "」です。");
    out.println("セッションIDは「" + session.getId() + "」です。");
    out.println("前のサーブレットに戻る");
    out.println("");
    out.println("");
}

ここでもgetSession()メソッドを呼び出していますが、今回は、既にセッションが開始されているので、セッション管理の開始時に生成されたHttpSessionオブジェクトが戻り値として返されます。そのため、getAttribute()メソッドにより、SampleSessionCtlサーブレットでセッションオブジェクトに保存したデータを取得できます。

セッションIDの発行と受け渡し

admin — Mon, 27 Apr 2015 15:05:18 +0000

今回は、セッションIDの発行とサーブレット間での受け渡しを行うサンプルサーブレットを作成していきます。

まずは、作成していくサーブレットの内容を下記します。

サーブレットを呼び出すためのフォームを作成します。

「サーブレットの呼び出し」ボタンをクリックすると、サーブレット「SampleSessionCtl」を呼び出します。

サーブレット「SampleSessionCtl」では、セッションオブジェクトを生成し、生成されたセッションIDを表示するHTMLをレスポンスとして返します。

「次のサーブレット呼び出し」をクリックすると、サーブレット「SampleSessionGetServlet」を呼び出します。

サーブレット「SampleSessionGetServlet」では、セッションIDを取得し、取得したセッションIDを表示するHTMLをレスポンスとして返します。

セッションIDがサーブレットが変わっても同じ文字列であることが確認できます。

セッション生成メソッド一覧

セッションを生成するには、下記メソッドを使用します。

HttpSession getSession()

セッションを開始するメソッドです。セッション管理をはじめるにはHttpServletRequestオブジェクトのgetSession()メソッドを使用します。getSession()メソッドは、既にセッションが開始されているか開始されていないかに従い、引数であるboolean値の指定によって処理が異なります。

①getSession()とgetSession(true)の動作
まだセッションが開始されていないときは、新規に生成したHttpSessionオブジェクトを戻り値として返して、セッション管理を開始します。
既にセッションが開始されているときは、セッション管理の開始時に生成されたHttpSessionオブジェクトを戻り値として返します。

②getSession(false)の動作
まだセッションが開始されていないときは、新規にHttpSessionオブジェクトを生成せずにnullを戻り値として返します。

String getId()

セッションIDを取得します。

サンプルサーブレットのソースコード

以降に各サーブレットのソースコードを記載します。(冗長な部分は省略し、主要な部分のみ記載しています。)

まずは、サーブレット呼び出し用のフォームを作成します。フォーム(HTMLファイル)の詳細な作成方法はこちらを参照してください。





セッション管理サーブレットサンプル


セッション管理サーブレットサンプル

SampleSessionCtlサーブレットのdoGet()メソッドには下記のように記述します。

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    PrintWriter out = response.getWriter();
    HttpSession session = request.getSession();

    out.println("");
    out.println("");
    out.println("セッションの生成");
    out.println("");
    out.println("");
    out.println("セッションの生成(ページ1)");
    out.println("セッションIDは「" + session.getId() + "」です。");
    out.println("次のサーブレット呼び出し");
    out.println("");
    out.println("");
}

getSession()メソッドでHttpSessionオブジェクト生成し、getId()メソッドで取得したセッションIDを出力しています。

「次のサーブレット呼び出し」のリンク先として、SampleSessionGetServletサーブレットを指定します。その場合のリクエストの種類は「GET」になります。また、注意点として、println()メソッドでダブルクォーテーショ(“)を出力したい場合は、「\」でエスケープしてやる必要があります。

SampleSessionGetServletサーブレットのdoGet()メソッドには下記のように記述します。

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    PrintWriter out = response.getWriter();
    HttpSession session = request.getSession();
    
    out.println("");
    out.println("");
    out.println("セッションIDの取得");
    out.println("");
    out.println("");
    out.println("セッションIDの取得(ページ2)");
    out.println("セッションIDは「" + session.getId() + "」です。");
    out.println("前のサーブレットに戻る");
    out.println("");
    out.println("");
}

ここでもgetSession()メソッドを呼び出していますが、今回は、既にセッションが開始されているので、セッション管理の開始時に生成されたHttpSessionオブジェクトが戻り値として返されます。そのため、getId()メソッドで取得するセッションIDは前のページで表示した文字列と同じになります。

セッション管理

admin — Sun, 26 Apr 2015 15:10:39 +0000

ステートフルを実現する方法のひとつとして前回はクッキーの利用について見てきましたが、今回からはセッションを利用した方法について見ていきます。

クッキーの問題点

クッキーを利用すれば、Webページを遷移しても状態を引き継ぐような仕組み(ユーザーを特定できる仕組み)を実現できますが、ある問題が残ります。

クッキーはWebブラウザを通してクライアントのローカルディスクにファイルとして保存することになります。ローカルディスク上に保存される、そのファイルは簡単に探し出すことができ、実体はただのテキストファイルであるため、開けば中身を普通に参照できます。それはつまり、ユーザー名やパスワードも平文のまま保存されてしまうということです。

自分専用のPCであればまだしも、公共施設やカフェなど、不特定多数のユーザーが使用するPCは至る所に存在するので、クッキーを利用するということは、セキュリティ上、非常に危険な要素を含んでいるのです。

セッション管理

Webアプリケーションは、決まった順番で実行させなければならないものがほとんどです。(そのように決められた一連の処理のことをトランザクション処理と言います。)

ステートレスなプロトコルであるHTTPを使用する以上、トランザクション処理を行うためには、ユーザーを識別するための仕組みを作る必要があります。その仕組みはJavaでコーディングすれば作成可能ですが、ソースコードが長くなってしまいます。また、そのようなものは大抵のWebアプリケーションで共通して必要なものであり、毎回同じコードを書かなくてはいけません。

そこで考えだされたのが、そのような仕組みは、Webコンテナの機能として組み込んでしまおうという発想です。

セッションとは特定のクライアントとの通信接続状態を管理する情報のことです。Webコンテナはリクエストを送信してきたWebブラウザに対し、複数のユーザーを識別するためのネットワーク上で重複しないユニークな番号を割り振り、それをWebブラウザに渡します。(そのユニークな番号のことを「セッションID」と言います。)

セッションIDはクッキーを利用してユーザーのPC上に保存されます。以降、Webブラウザから送信されるHTTPリクエストにはクッキーによりセッションIDが埋め込まれ、そのHTTPリクエストを受信したWebコンテナは、セッションIDをキーにして、そのユーザーは前回と同一のユーザーであると判断します。

また、Webコンテナは各ユーザー(Webブラウザ)に対して専用のメモリー領域を用意します、そのメモリ領域のことを「セッションオブジェクト」と言います。セッションオブジェクトには、ユーザーとのやり取りで使用する任意のデータを保存してくおくことができます。

Webコンテナはサーブレットを呼び出すとき、サーブレットにそのユーザーのセッションオブジェクトを自動的に教えます。

このような仕組みにより、Webコンテナは、不特定多数のユーザーを見分けることができるのです。それをセッション管理と言います。

クッキーとの違い

クッキーとの決定的な違いは、クッキーはクライアントのPC上にデータを保存しておくのに対し、上記のWebコンテナによるセッション管理では、セッションID以外のデータはサーバー上に保存されるということです。

クッキーの発行と取得

admin — Sat, 25 Apr 2015 16:55:58 +0000

今回は、クッキーを使用したサンプルサーブレットを作成していきます。
以前に作成したサンプルサーブレットを改良します。

まずは、作成していくサーブレットの内容を下記します。

適当な質問フォームを表示し、ユーザーに入力させます。

送信ボタンが押されたら、入力されたデータをサーブレット「RequestRecv」に渡します。

「RequestRecv」では、質問フォームで入力されたデータを表示させるとともに追加の質問フォームを表示するHTMLをHTTPレスポンスとして返します。その際、クッキーを発行し、入力データもクライアントへ渡します。

データ入力後、送信ボタンを押せば、入力されたデータがサーブレット「SampleGetCookie」に渡されるようにします。さらに、送信ボタンを押した際のHTTPリクエストの中に、クッキーにより、前回の入力データを格納し、「SampleGetCookie」に渡します。

「SampleGetCookie」は、質問フォームで入力されたデータを表示させるとともに、クッキーからデータを取得し、そのデータを表示するHTMLをHTTPレスポンスとして返します。

クッキー操作メソッド一覧

クッキーを操作するには、主に下記メソッドを使用します。

void addCookie(Cookie cookie)

クライアントにクッキーを保存する場合はHttpServletResponseインターフェースで定義されているaddCookieメソッドを使用します。なお、1つのドメインに対して保存できるCookieの数は20個まで、1つのCookieは名前と値を合わせて4096バイトまで、クライアントに保存できるCookieの数は全体で300個までに制限されます。

addCookieメソッドの引数にはjavax.servlet.http.Cookieオブジェクトを設定します。Cookieクラスの引数はString型の「名前」と「値」の2つです。コンストラクタの定義は以下になります。
Cookie(String name, String value)

void setMaxAge(int 有効期限)

クッキーの有効期限を秒単位で指定します。指定した有効期限を超えた場合、クライアントのWebブラウザの保存場所から破棄されます。負の値を指定するとWebブラウザが終了したときに削除されます。また0を指定すると直ちに削除されます。

Cookie[ ] getCookies()

クライアントに保存されているクッキーのテキストを取得するにはHttpServletRequestインターフェースに定義されているgetCookiesメソッドを使用します。戻り値にはCookieオブジェクトの配列が返されます。

クッキーの取得は保存したWebサーバーから読み出すことはできますが、他のWebサーバーが保存したクッキーを取得することはできません。

クライアントに保存したCookieオブジェクトを削除するには、コンストラクタで値を空にしたインスタンスを生成します。もしくは上記したsetMaxAge()メソッドの引数(有効期限)で0を設定します。

Cookie cookMemberName = new Cookie("MemberName", "");
cookMemberName.setMaxAge(0);

サンプルサーブレットのソースコード

以降に各サーブレットのソースコードを記載します。(冗長な部分は省略し、主要な部分のみ記載しています。)

まずは、フォームを作成します。フォーム(HTMLファイル)の詳細な作成方法はこちらを参照してください。





サーブレットへのデータ送信


サーブレットへのデータ送信

好きなゲームは？

テキストボックスに入力後、送信ボタンをクリックした場合のアクションとして、RequestRecvサーブレットを呼び出してします。その際のリクエストの種類には「GET」を指定しています。

RequestRecvサーブレットのdoGet()メソッドには下記のように記述します。

protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    String gameName = request.getParameter("Game");
    
    Cookie cookGameTitle = new Cookie("GameTitle", gameName);
    cookGameTitle.setMaxAge(60*60*24);
    response.addCookie(cookGameTitle);
    
    PrintWriter out = response.getWriter();
    
    out.println("");
    out.println("");
    out.println("あなたの回答");
    out.println("");
    out.println("");
    out.println("あなたの回答");
    out.println("好きなゲームは" + gameName + "です。

");
    
    out.println("では、そのゲームの好きなナンバリングは？
");
    out.println("");
    out.println("");
    out.println("");
    out.println("");
    
    out.println("");
    out.println("");
}

getParameter()メソッドで取得したデータを、addCookie()メソッドでクッキーに保存します。その前の、setMaxAge()メソッドでは、有効期限を1日としています。

「次のサーブレットを起動」ボタンをクリックした場合のアクションとして、SampleGetCookieサーブレットを呼び出してします。その際のリクエストの種類には「POST」を指定しています。また、注意点として、println()メソッドでダブルクォーテーショ(“)を出力したい場合は、「\」(バックスラッシュもしくは環境によっては円マーク)でエスケープしてやる必要があります。

SampleGetCサーブレットのdoPost()メソッドには下記のように記述します。

protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    Cookie[] cookies = request.getCookies();
    String gameTitle = "";
    String gameNumbering = request.getParameter("GameNumbering");
    
    if (cookies != null) {
        for (Cookie cook : cookies) {
            if (cook.getName().equals("GameTitle")) {
                gameTitle = cook.getValue();
            }
        }
    }
    
    PrintWriter out = response.getWriter();
    
    out.println("");
    out.println("");
    out.println("クッキーサンプル");
    out.println("");
    out.println("");
    out.println("クッキーサンプル");
    out.println("好きなゲームは" + gameTitle + "です。
");
    out.println("ナンバリングは" + gameNumbering + "です。
");
    out.println("");
    out.println("");
}

getCookies()メソッドで、クッキーを取得し、さらに、getParameter()メソッドでデータを取得しています。そして、それらを表示するHTMLを生成しています。

不完全なサーブレット

上記サンプルは一見、動いたように見えますが、致命的な問題が存在しています。例えば、フォーム画面でテキストボックスに日本語を入力して「送信」ボタンをクリックしたら、HTTPステータス500が返り、サーバー内部エラーとなります。

サーバー内部では「java.lang.IllegalArgumentException: Control character in cookie value or attribute.」という例外が発生しています。

このエラーの発生箇所は下記になります。

Cookie cookGameTitle = new Cookie("GameTitle", gameName);
cookGameTitle.setMaxAge(60*60*24);
response.addCookie(cookGameTitle);

実は、Cookieの値として使用できる文字には制限があり、日本語をそのままクッキーに保存しようとしているため、エラーが発生しています。このエラーは回避するにはURLエンコードと呼ばれる処理を行う必要があります。

URLエンコードとデコードはそれぞれ、URLEncoder.encode()メソッド、URLDecoder.decode()メソッドで行えます。
URLEncoder.encodeは、テキストをURLエンコードしたものを返し、URLDecoder.decodeはエンコードされたテキストを元のテキストに戻したものを返します。
これらを利用し、テキストをエンコードしてクッキーに保存し、クッキーから取り出したら再びデコードして利用することで、日本語でも問題なくクッキーに保管しておけるようになります。

但し、今ではこの方法はあまり使われません。クッキーをそのまま使うにはかなり致命的な問題があり、推奨されないからです。では、どのように「ステートフル」を実現すれば良いのでしょう。次回の記事でクッキーの問題点と代替の方法について見ていきます。

クッキー(Cookie)の利用

admin — Wed, 22 Apr 2015 11:29:26 +0000

通常、ひとつのWebシステムは複数のWebアプリケーションで構成されます。

例として、ショッピングサイトでの商品購入までの流れを考えてみます。
まず、商品を購入するためにはユーザー登録を行い、システムへログインする必要があります。その後、商品を検索し、欲しい商品が決まったら、購入ページへ遷移し、決済を行います。

このとき、最初にシステムにログインすると、その後ログオフしない限り、同じシステム内でページを遷移する際、ログイン状態を引き継ぎます。そのような状態を「ステートフル」と言います。

その逆に、ページを遷移する際にログイン状態を引き継がないことを、「ステートレス」と言います。

そのため、上記のようなショッピングサイトを構築するためには、ステートフルな仕組みが必要となります。

ただ、Webアプリケーションで使用するHTTPは、ステートレスなプロトコルであり、1ページごとに1セッションとなってしまいます。
ステートフルを実現するには、ページを遷移しても状態を引き継ぐような仕組みが必要です。

そのための仕組みのひとつにCookie（クッキー）というものがあります。

クッキー(Cookie)とは

クッキー(Cookie)とは、Webサイトの提供者が、Webブラウザを通じてクライアントのパソコン上に一時的にデータを書き込んで保存させる仕組みのことです。

本来、セキュリティ上の理由などから、Webサイトの提供者がクライアントのパソコンにデータを保持することはできないのですが、このクッキーという仕組みのみ、それが可能です。

クッキーには、ユーザーIDやパスワードなど、提供側が指定した任意のデータを保存しておくことができ、その仕組みを使用して、複数のページでデータを共有し、結果、ステートフルを実現することができるのです。

ただし、クッキーにはいくつかの制限事項があります。

1つのCookieに保存できるサイズは4096バイト以内。
1台のサーバーが同じコンピュータに対して発行できるCookieの数は20個のみ。
Cookieの総数は300個まで。これを超えると古い方から削除される。
個々のCookieには有効期限が設定されており、期限を過ぎたものは破棄される。

GETメソッドとPOSTメソッドの違い

admin — Tue, 21 Apr 2015 08:22:35 +0000

サーブレットは、WebクライアントからHTTPリクエストを受信したら実行されます。

HTTPリクエストでは、リクエストラインの中でリクエストの種類(メソッド)を指定します。詳細は「HTTPリクエストの構成」を参照してください。

サーブレットは、そのリクエストの種類に応じて最初に呼び出されるメソッドが変わってきます。
例えば、リクエストの種類が「GET」であれば、サーブレットではdoGet()メソッドが呼び出され、リクエストの種類が「POST」であれば、doPost()メソッドが呼び出されることになります。

リクエストの種類は「GET」「POST」以外にもあり、サーブレットはそれらに対するメソッドが呼び出されます。
どのようなメソッドが存在するのかは「サーブレット作成」ダイアログ等から確認できます。

ただし、主に使われるのはdoGet()メソッドかdoPost()メソッドのどちらかになります。

GETメソッドとPOSTメソッドの違い

では、GETメソッドとPOSTメソッドの違いは何でしょう。

両者の違いは、パラメータの受け渡し方法にあります。
GETメソッドでは、サーブレットに受け渡すパラメータをURLに組み込んでいます。
対して、POSTメソッドは、HTTPリクエストのメッセージボディの中に組み込んでいます。

例えば、前回の記事で作成したサンプルでは、リクエストの種類に「GET」を指定していたので、サーブレットを呼び出すURLは下記のようになります。

http://localhost:8080/RequestRecvPJ/RequestRecv?Game=%E3%83%A2%E3%83%B3%E3%82%B9%E3%82%BF%E3%83%BC%E3%83%8F%E3%83%B3%E3%82%BF%E3%83%BC&Hard=%E3%83%95%E3%82%A1%E3%83%9F%E3%82%B3%E3%83%B3

※「%E3」などはURLエンコードされた状態の文字列です。URLデコードしたら元の文字列に戻ります。

GETの場合、URL内部にパラメータが組み込まれるので、ブラウザの履歴やキャッシュが残ります。
POSTは残らないので、機密性が高いと言えなくもありませんが、結局、パケットは平文で流れるので、機密性について考える場合は、どちらにしても別途、暗号化の仕組みを取り入れる必要があります。

クライントからのデータ受け取り

admin — Mon, 20 Apr 2015 03:37:51 +0000

クライアントから送信されたデータをサーブレットで受け取る方法について見てきます。

今回は、HTMLのフォームに入力されたデータをサーブレットで受け取り、レスポンスとして、受け取ったデータを出力するサンプルを作成していきます。

フォームの作成

サーブレットを作成する前に、まずはフォームを作成します。フォーム(HTMLファイル)も、Eclipse上から作成できます。

まずは新規プロジェクトを作成します。

Eclipseのメニューから「ファイル」-「新規」-「動的Webプロジェクト」をクリックします。

「新規動的Webプロジェクト」ダイアログが表示されます。

任意のプロジェクト名を入力して「次へ」をクリックします。このサンプルではプロジェクト名を「RequestRecvPJ」としています。

新規プロジェクトが作成され、プロジェクト・エクスプローラに追加されます。

続いて、今作成したプロジェクトを選択した状態で、メニューの「新規」-「その他」をクリックします。

「ウィザードを選択」ダイアログが表示されます。

「Web」-「HTMLファイル」を選択し、「次へ」ボタンをクリックします。

任意のHTMLファイル名を入力し、「完了」ボタンをクリックします。このサンプルではHTMLファイル名を「FormSample.html」としています。

プロジェクト・エクスプローラに「FormSample.html」が追加されます。

「FormSample.html」を開いて、下記のようなHTMLを入力します。





サーブレットへのデータ送信


サーブレットへのデータ送信

好きなゲームは？

初めて購入したハードは？
ファミコン

スーパーファミコン

セガサターン

プレイステーション

以上でフォームは完成です。

サーブレットの作成

続いて、サーブレットを作成します。

プロジェクトを選択した状態で、メニューの「新規」-「サーブレット」をクリックします。

「サーブレット作成」ダイアログが表示されます。

「Javaパッケージ」と「クラス名」に任意の名前を入力します。
ここでは、それぞれ「sample_pkg02」、「RequestRecv」と入力します。
入力後、「完了」をクリックします。

プロジェクト・エクスプローラに「sample_pkg02」パッケージと「RequestRecv.java」が追加されます。

「RequestRecv.java」をダブルクリックして開いてください。

RequestRecv.javaを開くと、いくつか警告が表示されています。
まずはこの警告を消してください。警告の消し方はこちらを参照してください。

フォーム作成時、method属性に”Get”を指定したので、doGet()メソッドに、フォームから受け取ったデータを出力するコードを記述します。

@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    String gameName = request.getParameter("Game");
    String hardName = request.getParameter("Hard");
    
    PrintWriter out = response.getWriter();
    
    out.println("");
    out.println("");
    out.println("あなたの回答");
    out.println("");
    out.println("");
    out.println("あなたの回答");
    out.println("好きなゲームは" + gameName + "です。");
    out.println("初めて購入したハードは" + hardName + "です。");
    out.println("");
    out.println("");
}

データの取得にはHttpServletRequestクラスのgetParameter()メソッドを使用します。
メソッドの引数には、フォームHTMLで記述したinputタグのname属性の値を指定します。

クライアントから送信されるデータの取得は、主に下記メソッドを使用します。

public String getParameter(String): 引数にパラメータの名前を指定し、そのパラメータの値を取得します。パラメータが存在しない場合はNullが返されます。
public String[ ] getParameterValues(String): ひとつのパラメータに対し、複数の値が指定された場合にこのメソッドを使用します。値はString型の配列で返されます。パラメータが存在しない場合はNullが返されます。
public Enumeration getParameterNames( ): クライアントから送信されるすべてのパラメータの名前を取得します。

文字エンコーディング

ここまででひととおり完成ですが、このままではサーブレットで文字化けを起こし、Webブラウザ上に正しく日本語が表示されません。

「サーブレットでの文字化け対策」に記載したように文字エンコーディング用のフィルタを作成してください。

もしくは、フィルタで記述する内容をdoGet()メソッド内で記述しても構いません。

@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    request.setCharacterEncoding("UTF-8");
    response.setContentType("text/html; charset=UTF-8");
    
    String gameName = request.getParameter("Game");
    String hardName = request.getParameter("Hard");
    
    ：

setCharacterEncoding()メソッドでパラメータデータのエンコード方式を指定します。
このメソッドは、必ず、値を取得する前(上記サンプルではgetParameterメソッドを呼び出す前)に指定してください。

動作確認

以上でサンプルサーブレットは完成です。早速、動作確認をしてみましょう。
まず、フォームのWebページを開きます。

適当に入力し、「送信」をクリックします。

すると、サーブレットに入力したデータが渡され、レスポンスとして下記のように返されます。

サーブレットでの文字化け対策

admin — Sun, 19 Apr 2015 16:46:18 +0000

サーブレットで日本語を表示させるにはどうしたら良いのでしょうか。

まず、前回の記事で作成したサーブレットの一部を変更して、日本語を出力できるか試してみます。

doGet()メソッドを下記のように変更します。

@Override
protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    // TODO Auto-generated method stub
    PrintWriter out = response.getWriter();
    out.println("");
    out.println("");
    out.println("Encoding Sample");
    out.println("");
    out.println("");
    out.println("Encoding Sample");
    out.println("こんにちは。");
    out.println("");
}

これをWebブラウザで表示すると、下記のように文字化けしてしまいます。

これは、Webブラウザ側の問題ではなく、サーブレットが日本語に対応していないためです。

文字エンコーディング

日本語が文字化けしてしまうのは、サーブレットが日本語の文字コードに対応していないためです。
文字コードに対応させるためには、文字エンコーディングと呼ばれる処理を行う必要があります。

文字コードとは文字に割り当てられた「数字」のことで、エンコードは文字と数字をマッピングする方式のことです。

では、その文字エンコーディングはどのように実現すれば良いのでしょうか。

フィルタ

文字エンコーディングを行うには、フィルタを使用します。

フィルタとはWebクライアントとサーバー間のリクエスト・レスポンス時に何らかの処理を行う機能のことです。

このフィルタ機能を利用して文字エンコーディングを実現します。
フィルタは、文字エンコーディングの他にも、ログの生成や認証などの処理にも使用されます。

フィルタの作成手順

フィルタには、Webアプリケーションへリクエストが渡される前、または、Webクライアントへレスポンスを返した後に実行する処理を実装します。

現在のプロジェクトを選択した状態で、メニューから「ファイル」-「新規」-「その他」をクリックします。

「ウィザードを選択」では、「Web」から「フィルター」を選択して、「次へ」をクリックします。

「フィルターの作成」画面に遷移します。

「Javaパッケージ」欄には「filter」、「クラス名」欄には「SampleFilter」と入力し、「次へ」をクリックします。

「フィルター・マッピング」-「URLパターン/サーブレット名」欄には、「/SampleFilter」と入力されています。「編集」をクリックして、「/*」に変更します。これにより、このEclipseプロジェクトの全サーブレットがフィルタ対象になります。

最後に「完了」をクリックします。

すると、プロジェクトに「filter」パッケージと「SampleFilter.java」が作成されます。

「SampleFilter.java」をダブルクリックして開いてください。

SampleFilter.javaを開くと、いくつか警告が表示されています。
まずはこの警告を消してください。警告の消し方はこちらを参照してください。

doFilter()メソッドにリクエスト・レスポンス時のエンコード処理を記述します。

@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
    // TODO Auto-generated method stub
    // place your code here
    request.setCharacterEncoding("UTF-8");
    response.setContentType("text/html; charset=UTF-8");
    // pass the request along the filter chain
    chain.doFilter(request, response);
}

これでWebブラウザ上に日本語が表示されるようになります。

@WebServletアノテーション

admin — Fri, 17 Apr 2015 14:59:38 +0000

前回の記事で作成したサーブレットはWebブラウザから下記URLにアクセスすることで実行されました。

http://localhost:8080/HelloWorld_PJ01/HelloWorldServlet

このようにサーブレットは、WebブラウザからURLや、Webページの中のリンクにURLを指定して呼び出します。

そのURLは、Eclipseのプロジェクト名とサーブレットの@WebServletというアノテーションと関連付きます。

URLで指定して呼び出す場合

http://サーバホスト名:ポート番号/Eclipseプロジェクト名/@WebServletアノテーション

　　※ポート番号は省略できます。省略した場合はポート番号は80となります。

Webページの中のリンクから呼び出す場合

Click Here

フォームから呼び出す場合

@WebServletアノテーションはServlet3.0から利用できるようになった機能です。

それまでのServlet2.5以前は、web.xmlにを記述することで指定していましたが、
Servletは3.0になってからアノテーションを利用することでServletの設定が単純になりました。

@WebServlet使用例

前回は@WebServletを以下のように設定しました。

@WebServlet("/HelloWorldServlet")
public class HelloWorldServlet extends HttpServlet {

@WebServletには以下のような属性を設定できます。

@WebServletの属性

属性名	説明
name	サーブレット名を設定する
description	サーブレットの説明を設定する
displayName	表示名を設定する
initParams	サーブレットの初期パラメタを設定する
smallIcon	GUIツールで使用する小アイコンを設定する
largeIcon	GUIツールで使用する大アイコンを設定する
loadOnStartup	サーブレットの開始順序を設定する
urlPatterns	マッピングするURLパターンを設定する
value	マッピングするURLパターンを設定する(urlPatternsと同時に設定した場合は無効)

例えば、URLを複数指定したい場合は、下記のように記述します。

@WebServlet(urlPatterns = {"/HelloWorldServlet", "/HelloServlet", "/HELLO"})
public class HelloWorldServlet extends HttpServlet {

このようにweb.xmlにサーブレットマッピングを書く必要があったServlet2.5以前と比べ、設定は単純になりました。
ただ、アノテーションはソースコード上に記述することになるので、各種設定は外出しして記述したいというケースも多く、ソースコード管理等の理由で、今でもweb.xmlを利用しているところも多いです。

サーブレットの基本

admin — Fri, 03 Apr 2015 13:18:20 +0000

今回は前回作成した「HelloWorldServlet」を基にし、サーブレットの作成方法について詳しく見ていきます。

サーブレットを動作させるためにはそのための実行環境、すなわちTomcatというWebコンテナが必要です。そして、Webコンテナからサーブレットを呼び出すためにはHttpServletクラスを継承する必要があります。

また、Webクライアント(ここではブラウザ)がWebサーバーへのHTTPリクエストにメソッド種類「Get」を指定した場合、、そのリクエストを受けると、最初にdoGetメソッドが呼び出されます。

サーブレットからWebクライアントへ結果を送信する場合は、PrintWriterクラスのprintlnメソッドで行います。

これらを前提に、もう一度前回作成した「HelloWorldServlet」のJavaソースファイルを見ていきます。

package sample_pkg01;

import java.io.IOException;
import java.io.PrintWriter;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * Servlet implementation class HelloWorldServlet
 */
@WebServlet("/HelloWorldServlet")
public class HelloWorldServlet extends HttpServlet {
    private static final long serialVersionUID = 1L;
       
    /**
     * @see HttpServlet#HttpServlet()
     */
    public HelloWorldServlet() {
        super();
        // TODO Auto-generated constructor stub
    }

    /**
     * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
     */
    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // TODO Auto-generated method stub
        PrintWriter out = response.getWriter();
        out.println("");
        out.println("");
        out.println("Hello World!");
        out.println("");
        out.println("");
        out.println("Hello World!");
        out.println("First Servlet");
        out.println("");
    }
}

パッケージのインポート

サーブレットを作成する上で必要となるクラスは「javax.servlet.http」に含まれています。
インポート部分は基本的にEclipseにより自動生成されるため実際に記述する必要はないところではありますが、サーブレットを作成していく上で、何をインポートする必要があるのかを理解しておく必要があります。

import java.io.IOException;
import java.io.PrintWriter;

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

まずサーブレットを作成する上で大前提となるのがHttpServletクラスとなります。
前述しましたが、作成するクラスをサーブレットとして定義するためには、HttpServletクラスを継承する必要があります。

HttpServletRequestクラスとHttpServletResponseクラスは、doGetメソッドの引数として受け渡されます。上記サンプルではそれぞれ「request」と「response」という変数名で定義しています。(Javaではそれらの変数のことをインスタンスと呼びます。)
HttpServletRequestクラスのインスタンス(オブジェクト)にはサーブレットに対して送られてきたリクエストに含まれる、フォームなどで設定されたパラメータやクッキーなどの情報が格納されています。今回の例では特に使用していませんが、必要に応じて使用します。

HttpServletResponseクラスのインスタンスは、サーブレットからWebクライアントへデータを返信するために使用します。

HttpServletクラスの例外処理準備として、ServletExceptionクラスとIOExceptionクラスをインポートします。

PrintWriterクラスは、Webクライアントへデータを返信する際に、HttpServletResponseクラスとともに使用します。

doGetメソッドの実装

これも前述しましたが、WebクライアントがWebサーバーへのHTTPリクエストのメソッド種類が「Get」であれば、リクエストを受けると、最初にdoGetメソッドが呼び出されます。もし、メソッド種類が「Post」であれば、doPostメソッドが呼び出されます。

    @Override
    protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        // TODO Auto-generated method stub
        PrintWriter out = response.getWriter();
        out.println("");
        out.println("");
        out.println("Hello World!");
        out.println("");
        out.println("");
        out.println("Hello World!");
        out.println("First Servlet");
        out.println("");
    }

本サンプルでは、doGetメソッド内で、「HelloWorld!」文字列を含んだHTML文を出力しています。
そのHTML文がWebクライアント(ブラウザ)に返され、クライアントの画面上に「HelloWorld!」文字列が表示されます。

PrintWriter out = response.getWriter();

上記のように、doGetメソッドの引数で受け取ったHttpServletResponseクラスのインスタンス(response)をPrintWriterクラスに委譲※することで、Webクライアントへ送信できるようになります。

※委譲とは、ある処理を別のオブジェクトに委ねることで別のオブジェクトの処理を再利用する手法のことです。

あとは、printlnメソッドの引数に出力したい文字列を指定します。

out.println("");

本サンプルでは、HTMLタグを順番に出力しており、Webクライアントには下記HTMLが返されます。

Hello World!

First Servlet