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

コメントの記述

admin — Sun, 03 May 2015 05:12:04 +0000

JSPページを作成する場合、コメントの記述方法に注意しなければいけません。

普通、他のプログラミング言語では、コメントの内容はともかく、記述方法はそれ程注意することはありませんが、JSPの場合、1つのソースファイルの中に、HTMLのコメント、JSPのコメント、Javaのコメントの最大3種が混在することになります。

HTMLのコメント

HTMLのコメント書式は下記になります。

「<- -」から「- ->」の間は、コメントとして扱われ、ブラウザには表示されません。ただし、HTMLのソースには表示されます。
コメントは、複数行にまたがってもかまいませんし、コメント内にHTMLタグを挟むことも可能です。(ただし、コメント文の中に続けてハイフン(- -)は使用しない方が無難です。)

JSPのコメント

JSPのコメント書式は下記になります。

「<%- -」から「- -%>」の間は、コメントとして扱われ、ブラウザには表示されません。また、HTMLのソースにも表示されません。
例えば、JSPページをブラウザに表示させた際、IEの場合は、表示された画面を右クリック→「ソースの表示」をクリックし、HTMLソースを開いてみてください。HTMLのコメントは出力されていますが、JSPのコメントは出力されていないことが確認できます。

Javaのコメント

Javaのコメント書式は下記になります。

// Javaのコメント

または

/*
Javaのコメント
*/

スクリプトレット内はJavaコードになるので、コメント書式はJavaのものになります。

行の先頭に「//」を記述した場合は、その1行だけがコメントになります。または、「/* … */」を記述した場合は、「/*」から「*/」までの間がコメントになります。

JavaのコメントもJSPのコメントと同じで、ブラウザにもHTMLソースにも出力されません。それら各コメントの性質を理解し、使い分けることが重要です。

宣言と式

admin — Sun, 03 May 2015 02:52:25 +0000

今回は、JSPの構成要素である「宣言」と「式」について見ていきます。

宣言(Declaration)

変数、メソッドは下記のように記述し、宣言します。

宣言文もJavaの文であるため、最後に「;」が必要です。

変数の宣言

前回の記事では、下記のようにスクリプトレット内に変数を定義していました。

<%
    int cnt = 10;
    
    if(cnt < 10) {
        out.println("10未満です。");
    } else {
        out.println("10以上です。");
    }
%>

スクリプトレットと宣言、両者の違いは、スクリプトレットで定義した変数はローカル変数、宣言で定義した変数はインスタンス変数になる点です。

インスタンス変数の場合、初めてリクエストが合ったときに一度だけ初期化され、その後のリクエストにおいては変数の値は初期化されることなく、JSPコンテナ(Tomcat)を再起動するまで、値が保持されます。

ローカル変数の場合は、リクエストがある都度、変数が初期化されます。

宣言では変数以外に、メソッドの定義もできます。

式(Expression)

式を記述することで、変数の値や式の結果、メソッドの戻り値をHTML内に埋め込むことができます。

<=% 式 %>

宣言では最後に「;」が必要ですが、式はJavaの文ではないので「;」は不要です。

<%
    String name = new String("まんじゅう");
    int price = 100;
%>
    商品名：<%= name %>
    価格：<%= price %>

JSPページを作成する際、上記のように動的に変化する文字列を表示したい場合は、式を利用することで、簡単に実装できます。もちろん、これまでどおりスクリプトレット内でprint()メソッドを使用しても同じ結果となります。

下記のようにメソッドの戻り値を表示することもできます。

メソッド戻り値：<%= getText() %>
%>

スクリプトレット

admin — Sat, 02 May 2015 17:08:10 +0000

前回の記事でも少し触れましたが、HTML内にJavaコードを記述する記法のことをスクリプトレットと言います。スクリプト(script)の断片(let)という意味です。

構文は下記になります。

<%
    Javaコード
%>

簡単なJSPサンプルを見てみましょう。「<%」から「%>」内はJavaのコードと見なされ、それ以外は普通のHTMLです。

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>




Insert title here


<%
    String str = new String("HelloWorld!");
    out.print(str);
%>

最初の行は、pageディレクティブと呼ばれ、JSP全体の動作を定義します。(ここでは一旦、JSPのおまじないみないなものだと思っていただいても構いません。)

下記のようにスクリプトレットを複数箇所に記述することもできます。

<%
    int cnt = 10;
    
    if(cnt < 10) {
%>
        10未満です。
<%
    } else {
%>
        10以上です。
<%
    }
%>

このようにスクリプトレットを複数箇所に離れて記述しても、つなぎ合わせた際に正しい文法になっていれば、問題ありません。
また、下記のようにスクリプトレット内にまとめて記述することもできます。実行結果はまったく同じになります。

<%
    int cnt = 10;
    
    if(cnt < 10) {
        out.println("10未満です。");
    } else {
        out.println("10以上です。");
    }
%>

JSPでHelloWorld!

admin — Sat, 02 May 2015 15:57:47 +0000

JSPで「HelloWorld!」と表示するだけの簡単なプログラムを作成してみましょう。

まずは、Eclipseを起動し、新規プロジェクトを作成します。プロジェクトは、メニューから「ファイル」-「新規」-「プロジェクト」をクリックすることで作成できます。

プロジェクトを作成したら、続いて、JSPファイルを作成します。
画面左のプロジェクトエクスプローラーからプロジェクト名を選択した状態で、メニューから「ファイル」-「新規」-「その他」をクリックします。

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

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

新規JSPファイルダイアログが表示されます。

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

プロジェクトに「JSPSample01.jsp」が追加されます。

最小限のソースコードが記述された状態で作成されます。JSPページと言っても、基本はHTMLページですので、見慣れたタグが並んでいると思います。動的に変化する部分のみJavaでコーティングしていきます。

コーディング

Javaでコーディングする部分はスクリプトレットという記述法を使用する必要があります。

スクリプトレットの構文は下記になります。

<%
    Javaコード
%>

「<%」と「%>」で囲むことで、その中はJavaのコードと見なされ、Javaのプログラムを記述することができます。

上記を踏まえて、「HelloWorld!」プログラムをコーディングしてみましょう。

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>




Insert title here


<%
    String str = new String("HelloWorld!");
    
    for(int i=0; i<5; i++){
        out.print(str);
        out.println("
");
    }
%>

実行結果は下記のようになります。

JSPとは

admin — Sat, 02 May 2015 06:21:24 +0000

前回まではサーブレットの基本を見てきましたが、今回からはJSPについて見ていきます。

JSPはJava Server Pagesの略語であり、Javaを利用してサーバーサイドで動的にWebページ(動的コンテンツ)を生成し、クライアントに送信する技術のことです。

サーブレットのソースコードの実体はJavaで書かれたテキストファイルであり、アプリケーションとして利用するためにはコンパイルを行ってクラスファイルを作成する必要があります。(Eclipse上で、「実行」-「1 サーバーで実行」をクリックすることでEclipseがそれらの処理を自動的にやってくれていました。)

これに対し、JSPはHTMLファイルの中に、Javaコードを埋め込んでおき、クライアントからの要求に応じて、プログラムを実行し、その処理結果をクライアントへ返します。クライアントへ返す結果は、通常のHTML形式になるため、Webブラウザに特殊な機能を組みこむことなくWebアプリケーションを構築することができます。

似たような技術に、マイクロソフトのIIS上で動作させることができるASP(Active Server Pages)がありますが、ASPに対応しているWebサーバー、APサーバーはIISぐらいしかないのに対し、JSPはTomcatはもちろん、他の様々なWebサーバー、APサーバーが対応しています。

JSPページ

JSPを利用したコンテンツのことをJSPページと言います。JSPページはそのままWebブラウザに送信されるわけではなく、いったんサーバー側でサーブレットにコンパイルされ、その実行結果であるHTMLページがブラウザに送信されます。

JSPページがブラウザに表示されるまでの流れが下図になります。

①HTMLフォームや直接URLにアクセスすることでJSPページが呼び出される。
②Webサーバーは呼び出されたコンテンツがJSPページであると判断すると、リクエストをAPサーバーにリダイレクトする。
③APサーバーは呼び出されたJSPページをサーブレットに変換するコンパイラに渡す。
④コンパイラにより、JSPページの中に記述されたHTMLタグやJavaコードがすべてサーブレットに変換され、サーブレットにより生成されたHTMLページをブラウザに返す。

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

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には有効期限が設定されており、期限を過ぎたものは破棄される。