JSP Cookie 処理

Cookie はクライアントマシンに保存されるテキストファイルであり、大量の追跡情報を保持します。Servlet 技術を基盤として、JSP は HTTP Cookie を明確にサポートできます。

リピーターを識別するには、通常3つのステップがあります:

  • サーバースクリプトは、名前、年齢、ID番号などの一連の Cookie をブラウザに送信します。
  • ブラウザはこれらの情報をローカルマシンに保存し、必要なときに備えます。
  • 次回ブラウザがサーバーにリクエストを送信するとき、同時にこれらの Cookie 情報もサーバーに送信します。サーバーはこの情報を使用してユーザーを識別したり、その他の処理を行ったりします。

この章では、Cookie を設定または再設定する方法、それらにアクセスする方法、そして削除する方法を説明します。

JSP での Cookie 処理では、中国語のエンコードとデコードが必要です。方法は次のとおりです:

String   str   =   java.net.URLEncoder.encode("中文", "UTF-8");            //编码
String   str   =   java.net.URLDecoder.decode("编码后的字符串","UTF-8");   // 解码

Cookie の解析

Cookie は通常 HTTP ヘッダーで設定されます(JavaScript はブラウザ内で直接 Cookie を設定できます)。JSP で Cookie を設定するには、次のヘッダーをサーバーに送信する必要があります:

HTTP/1.1 200 OK
Date: Fri, 04 Feb 2015 21:03:38 GMT
Server: Apache/1.3.9 (UNIX) PHP/4.0b3
Set-Cookie: name=サンプル; expires=Friday, 04-Feb-17 22:03:38 GMT; 
                 path=/; domain=example.com
Connection: close
Content-Type: text/html

ご覧のとおり、Set-Cookie ヘッダーには、キーと値のペア、GMT(グリニッジ標準時)時間、パス、ドメインが含まれます。キーと値のペアは URL エンコードされます。有効期限フィールドは、ブラウザにいつ以降この Cookie をクリアしてよいかを指示するものです。

ブラウザが Cookie を保存するように設定されている場合、ブラウザは有効期限が切れるまでこの情報を保持します。ユーザーがアクセスしたページが Cookie のパスとドメインに一致する場合、ブラウザはこの Cookie を再びサーバーに送信します。ブラウザ側のヘッダーは次のようになります:

GET / HTTP/1.0
Connection: Keep-Alive
User-Agent: Mozilla/4.6 (X11; I; Linux 2.2.6-15apmac ppc)
Host: zink.demon.co.uk:1126
Accept: image/gif, */*
Accept-Encoding: gzip
Accept-Language: en
Accept-Charset: iso-8859-1,*,utf-8
Cookie: name=xyz

JSP スクリプトは、request オブジェクトの getCookies() メソッドを使用してこれらの Cookie にアクセスします。このメソッドは Cookie オブジェクトの配列を返します。


Servlet Cookie メソッド

次の表は、Cookie オブジェクトでよく使用されるメソッドを示しています:

番号 メソッド & 説明
1 public void setDomain(String pattern)

Cookie のドメインを設定します。例: example.com 2 public String getDomain()

Cookie のドメインを取得します。例: example.com 3 public void setMaxAge(int expiry)Cookie の有効期限を設定します。単位は秒です。デフォルトの有効期限は現在のセッションの存続時間です。 4 public int getMaxAge()Cookie の有効期限を取得します。単位は秒です。デフォルトは -1 で、ブラウザが閉じられるまで Cookie が有効であることを示します。 5 public String getName()Cookie の名前を返します。名前は作成後に変更できません。 6 public void setValue(String newValue)Cookie の値を設定します。 7 public String getValue()Cookie の値を取得します。 8 public void setPath(String uri)Cookie のパスを設定します。デフォルトは、現在のページのディレクトリ内のすべての URL と、そのディレクトリのすべてのサブディレクトリです。 9 public String getPath()Cookie のパスを取得します。 10 public void setSecure(boolean flag)Cookie を暗号化して送信するかどうかを指定します。 11 public void setComment(String purpose)Cookie の目的を説明するコメントを設定します。ブラウザが Cookie をユーザーに表示するときに、このコメントは非常に役立ちます。 12 public String getComment()Cookie の目的を説明するコメントを返します。ない場合は null を返します。

JSP を使用した Cookie の設定

JSP を使用した Cookie の設定には、3つのステップがあります:

(1) Cookie オブジェクトを作成します:Cookie のコンストラクタを呼び出し、Cookie の名前と値をパラメータとして渡します。これらは両方とも文字列です。

Cookie cookie = new Cookie("key","value");

必ず覚えておいてください。名前と値にはスペースや以下の文字を含めることはできません:

[ ] ( ) = , " / ? @ : ;

(2) 有効期限を設定します:setMaxAge() 関数を呼び出して、Cookie が有効な秒数を指定します。次の操作では、有効期限を24時間に設定しています。

cookie.setMaxAge(60*60*24); 

(3) Cookie を HTTP レスポンスヘッダーに送信します:response.addCookie() 関数を呼び出して、HTTP レスポンスヘッダーに Cookie を追加します。

response.addCookie(cookie);

実例デモ

main.jsp ファイルのコードは次のとおりです:

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<%@ page import="java.net.*" %>
<%
   // 编码,解决中文乱码   
   String str = URLEncoder.encode(request.getParameter("name"),"utf-8");  
   // 设置 name 和 url cookie 
   Cookie name = new Cookie("name",
           str);
   Cookie url = new Cookie("url",
              request.getParameter("url"));

   // 设置cookie过期时间为24小时。
   name.setMaxAge(60*60*24); 
   url.setMaxAge(60*60*24); 

   // 在响应头部添加cookie
   response.addCookie( name );
   response.addCookie( url );
%>
<html>
<head>
<title>设置 Cookie</title>
</head>
<body>

<h1>设置 Cookie</h1>

<ul>
<li><p><b>网站名:</b>
   <%= request.getParameter("name")%>
</p></li>
<li><p><b>网址:</b>
   <%= request.getParameter("url")%>
</p></li>
</ul>
</body>
</html>

以下は、GET メソッドを使用してクライアントデータを main.jsp ファイルに送信し、Cookie を設定する簡単な HTML フォームです:

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>サンプル(example.com)</title>
</head>
<body>

<form action="main.jsp" method=GET>
站点名: <input type="text" name="name">
<br />
网址: <input type="text" name="url" />
<input type="submit" value="提交" />
</form>

</body>
</html>

上記の HTML コードを test.htm ファイルに保存します。

このファイルを現在の JSP プロジェクトの WebContent ディレクトリ(main.jsp と同じディレクトリ)に配置します。

http://localhost:8080/testjsp/test.html にアクセスしてフォームデータを main.jsp ファイルに送信します。デモの GIF 画像は次のとおりです:

「サイト名」と「URL」を入力して送信ボタンをクリックしてみてください。画面に「サイト名」と「URL」が表示され、「サイト名」と「URL」の2つの Cookie が設定されます。


JSP を使用した Cookie の読み取り

Cookie を読み取るには、request.getCookies() メソッドを呼び出して javax.servlet.http.Cookie オブジェクトの配列を取得し、配列を反復処理して getName() メソッドと getValue() メソッドを使用して各 Cookie の名前と値を取得する必要があります。

前の例の Cookie を読み取ってみましょう。以下は cookie.jsp ファイルのコードです:

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<%@ page import="java.net.*" %>
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>获取 Cookie</title>
</head>
<body>
<%
   Cookie cookie = null;
   Cookie[] cookies = null;
   // 获取 cookies 的数据,是一个数组
   cookies = request.getCookies();
   if( cookies != null ){
      out.println("<h2> 查找 Cookie 名与值</h2>");
      for (int i = 0; i < cookies.length; i++){
         cookie = cookies[i];
        
         out.print("参数名 : " + cookie.getName());
         out.print("<br>");
         out.print("参数值: " + URLDecoder.decode(cookie.getValue(), "utf-8") +" <br>");
         out.print("------------------------------------<br>");
      }
  }else{
      out.println("<h2>没有发现 Cookie</h2>");
  }
%>
</body>
</html>

ブラウザでアクセスすると、出力結果は次のとおりです:


JSP を使用した Cookie の削除

Cookie の削除は非常に簡単です。Cookie を削除したい場合は、次の手順に従います:

  • 既存の Cookie を取得し、Cookie オブジェクトに格納します。
  • Cookie の有効期限を0に設定します。
  • この Cookie をレスポンスヘッダーに再度追加します。

実例デモ

次のプログラムは、名前が「name」の Cookie を削除します。cookie.jsp を2回目に実行すると、name は null になります。

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<%@ page import="java.net.*" %>
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>获取 Cookie</title>
</head>
<body>
<%
   Cookie cookie = null;
   Cookie[] cookies = null;
   // 获取当前域名下的cookies,是一个数组
   cookies = request.getCookies();
   if( cookies != null ){
      out.println("<h2> 查找 Cookie 名与值</h2>");
      for (int i = 0; i < cookies.length; i++){
         cookie = cookies[i];
         if((cookie.getName( )).compareTo("name") == 0 ){
            cookie.setMaxAge(0);
            response.addCookie(cookie);
            out.print("删除 Cookie: " + 
            cookie.getName( ) + "<br/>");
         }
         out.print("参数名 : " + cookie.getName());
         out.print("<br>");
         out.print("参数值: " + URLDecoder.decode(cookie.getValue(), "utf-8") +" <br>");
         out.print("------------------------------------<br>");
      }
  }else{
      out.println("<h2>没有发现 Cookie</h2>");
  }
%>
</body>
</html>

ブラウザからアクセスすると、出力結果は次のとおりです:

再度アクセスするとhttp://localhost:8080/testjsp/cookie.jsp、次の結果が得られます:

名前が「name」の Cookie がなくなっていることがわかります。

ブラウザで Cookie を手動で削除することもできます。IE ブラウザでは、[Tools] メニュー項目をクリックし、[Internet Options] を選択して、[Delete Cookies] をクリックすると、すべての Cookie を削除できます。

その他の拡張