Servlet Cookie 処理
Cookie はクライアントコンピュータ上に保存されるテキストファイルであり、さまざまな追跡情報を保持します。Java Servlet は当然 HTTP Cookie をサポートしています。
再訪ユーザーを識別するには、次の3つのステップがあります:
- サーバースクリプトはブラウザに一連の Cookie を送信します。例:名前、年齢、識別番号などです。
- ブラウザはこれらの情報を将来の使用に備えてローカルコンピュータに保存します。
- 次にブラウザが Web サーバーにリクエストを送信するとき、ブラウザはこれらの Cookie 情報をサーバーに送信し、サーバーはこの情報を使用してユーザーを識別します。
この章では、Cookie の設定またはリセット方法、アクセス方法、削除方法について説明します。
Servlet Cookie 処理では中国語をエンコードおよびデコードする必要があります。方法は次のとおりです:
String str = java.net.URLEncoder.encode("中文","UTF-8"); //编码 String str = java.net.URLDecoder.decode("编码后的字符串","UTF-8"); // 解码
Cookie の解析
Cookie は通常 HTTP ヘッダー情報に設定されます(JavaScript でもブラウザ上で直接 Cookie を設定できますが)。Cookie を設定する Servlet は次のようなヘッダー情報を送信します:
HTTP/1.1 200 OK
Date: Fri, 04 Feb 2000 21:03:38 GMT
Server: Apache/1.3.9 (UNIX) PHP/4.0b3
Set-Cookie: name=xyz; expires=Friday, 04-Feb-07 22:03:38 GMT;
path=/; domain=example.com
Connection: close
Content-Type: text/html
ご覧のとおり、Set-Cookie ヘッダーには名前と値のペア、GMT 日付、パス、ドメインが含まれています。名前と値は URL エンコードされます。expires フィールドは、指定された日時以降にブラウザにその 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
Servlet はリクエストメソッドを介してrequest.getCookies()Cookie にアクセスできます。このメソッドは次のものを返します:Cookieオブジェクトの配列。
Servlet Cookie メソッド
以下は、Servlet で Cookie を操作するときに使用できる便利なメソッドのリストです。
| 番号 | メソッド & 説明 |
|---|---|
| 1 | public void setDomain(String pattern) このメソッドは、cookie が適用されるドメインを設定します。例:example.com。 |
| 2 | public String getDomain() このメソッドは、cookie が適用されるドメインを取得します。例:example.com。 |
| 3 | public void setMaxAge(int expiry) このメソッドは、cookie の有効期限(秒単位)を設定します。これを設定しない場合、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 が cookie を返します。 |
| 9 | public String getPath() このメソッドは、cookie が適用されるパスを取得します。 |
| 10 | public void setSecure(boolean flag) このメソッドは、cookie が暗号化接続(つまり SSL)でのみ送信されるべきかどうかを示すブール値を設定します。 |
| 11 | public void setComment(String purpose) cookie のコメントを設定します。このコメントは、ブラウザがユーザーに cookie を提示するときに役立ちます。 |
| 12 | public String getComment() cookie のコメントを取得します。cookie にコメントがない場合は null を返します。 |
Servlet で Cookie を設定する
Servlet で Cookie を設定する手順は次の3つです:
(1) Cookie オブジェクトを作成します:cookie の名前と cookie の値を指定して Cookie コンストラクタを呼び出すことができます。cookie の名前と値はどちらも文字列です。
Cookie cookie = new Cookie("key","value");
名前と値のどちらにも、スペースや以下の文字を含めないでください:
[ ] ( ) = , " / ? @ : ;
(2) 最大有効期間を設定します:setMaxAge メソッドを使用して、cookie が有効な時間(秒単位)を指定できます。次に、最長有効期間が24時間の cookie を設定します。
cookie.setMaxAge(60*60*24);
(3) Cookie を HTTP レスポンスヘッダーに送信します:次のものを使用できます:response.addCookieを使用して、HTTP レスポンスヘッダーに Cookie を追加します。次のようになります:
response.addCookie(cookie);
例
それでは、私たちの〜を変更してフォームデータの例、名前と姓の Cookie を設定します。
package com.サンプル.test;
import java.io.IOException;
import java.io.PrintWriter;
import java.net.URLEncoder;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* Servlet implementation class HelloServlet
*/
@WebServlet("/HelloForm")
public class HelloForm extends HttpServlet {
private static final long serialVersionUID = 1L;
/**
* @see HttpServlet#HttpServlet()
*/
public HelloForm() {
super();
// TODO Auto-generated constructor stub
}
/**
* @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
*/
public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
{
// 为名字和姓氏创建 Cookie
Cookie name = new Cookie("name",
URLEncoder.encode(request.getParameter("name"), "UTF-8")); // 中文转码
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 );
// 设置响应内容类型
response.setContentType("text/html;charset=UTF-8");
PrintWriter out = response.getWriter();
String title = "设置 Cookie 实例";
String docType = "<!DOCTYPE html>\n";
out.println(docType +
"<html>\n" +
"<head><title>" + title + "</title></head>\n" +
"<body bgcolor=\"#F0F0F0\">\n" +
"<h1 align=\"center\">" + title + "</h1>\n" +
"<ul>\n" +
" <li><b>站点名:</b>:"
+ request.getParameter("name") + "\n</li>" +
" <li><b>站点 URL:</b>:"
+ request.getParameter("url") + "\n</li>" +
"</ul>\n" +
"</body></html>");
}
/**
* @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)
*/
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// TODO Auto-generated method stub
doGet(request, response);
}
}
上記の Servlet をコンパイルしますHelloForm、web.xml ファイルに適切なエントリを作成します:
<?xml version="1.0" encoding="UTF-8"?>
<web-app>
<servlet>
<!-- 类名 -->
<servlet-name>HelloForm</servlet-name>
<!-- 所在的包 -->
<servlet-class>com.サンプル.test.HelloForm</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>HelloForm</servlet-name>
<!-- 访问的网址 -->
<url-pattern>/TomcatTest/HelloForm</url-pattern>
</servlet-mapping>
</web-app>
最後に、以下の HTML ページを試して Servlet を呼び出します。
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>サンプル(example.com)</title> </head> <body> <form action="../TomcatTest/HelloForm" method="GET"> 站点名 :<input type="text" name="name"> <br /> 站点 URL:<input type="text" name="url" /><br> <input type="submit" value="提交" /> </form> </body> </html>
上記の HTML の内容を /TomcatTest/test.html ファイルに保存します。
次に、http://localhost:8080/TomcatTest/test.html にアクセスします。Gif デモは次のとおりです:

注意:上記の一部のパスは、実際のプロジェクトのパスに合わせて変更する必要があります。
Servlet で Cookie を読み取る
Cookie を読み取るには、次のメソッドを呼び出してHttpServletRequestのgetCookies( )メソッドで作成するのは、javax.servlet.http.Cookieオブジェクトの配列です。次に、配列をループし、getName() メソッドと getValue() メソッドを使用して、各 cookie と関連する値にアクセスします。
例
上記の例で設定した Cookie を読み取ってみましょう
package com.サンプル.test;
import java.io.IOException;
import java.io.PrintWriter;
import java.net.URLDecoder;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* Servlet implementation class ReadCookies
*/
@WebServlet("/ReadCookies")
public class ReadCookies extends HttpServlet {
private static final long serialVersionUID = 1L;
/**
* @see HttpServlet#HttpServlet()
*/
public ReadCookies() {
super();
// TODO Auto-generated constructor stub
}
/**
* @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
*/
public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
{
Cookie cookie = null;
Cookie[] cookies = null;
// 获取与该域相关的 Cookie 的数组
cookies = request.getCookies();
// 设置响应内容类型
response.setContentType("text/html;charset=UTF-8");
PrintWriter out = response.getWriter();
String title = "Delete Cookie Example";
String docType = "<!DOCTYPE html>\n";
out.println(docType +
"<html>\n" +
"<head><title>" + title + "</title></head>\n" +
"<body bgcolor=\"#F0F0F0\">\n" );
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("值:" + URLDecoder.decode(cookie.getValue(), "utf-8") +" <br/>");
}
}else{
out.println(
"<h2 class=\"tutheader\">No Cookie founds</h2>");
}
out.println("</body>");
out.println("</html>");
}
/**
* @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)
*/
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// TODO Auto-generated method stub
doGet(request, response);
}
}
上記の Servlet をコンパイルしますReadCookies、web.xml ファイルに適切なエントリを作成します。実行してみます:http://localhost:8080/TomcatTest/ReadCookies、次の結果が表示されます:

Servlet で Cookie を削除する
Cookie の削除は非常に簡単です。cookie を削除する場合は、次の3つの手順に従うだけです:
- 既存の cookie を読み取り、Cookie オブジェクトに保存します。
- 次のメソッドを使用します:setMaxAge()メソッドで cookie の有効期間をゼロに設定し、既存の cookie を削除します。
- この cookie をレスポンスヘッダーに追加します。
例
次の例では、既存の "url" という名前の cookie を削除します。次回 ReadCookies Servlet を実行すると、url が null として返されます。
package com.サンプル.test;
import java.io.IOException;
import java.io.PrintWriter;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
* Servlet implementation class DeleteCookies
*/
@WebServlet("/DeleteCookies")
public class DeleteCookies extends HttpServlet {
private static final long serialVersionUID = 1L;
/**
* @see HttpServlet#HttpServlet()
*/
public DeleteCookies() {
super();
// TODO Auto-generated constructor stub
}
/**
* @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
*/
public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
{
Cookie cookie = null;
Cookie[] cookies = null;
// 获取与该域相关的 Cookie 的数组
cookies = request.getCookies();
// 设置响应内容类型
response.setContentType("text/html;charset=UTF-8");
PrintWriter out = response.getWriter();
String title = "删除 Cookie 实例";
String docType = "<!DOCTYPE html>\n";
out.println(docType +
"<html>\n" +
"<head><title>" + title + "</title></head>\n" +
"<body bgcolor=\"#F0F0F0\">\n" );
if( cookies != null ){
out.println("<h2>Cookie 名称和值</h2>");
for (int i = 0; i < cookies.length; i++){
cookie = cookies[i];
if((cookie.getName( )).compareTo("url") == 0 ){
cookie.setMaxAge(0);
response.addCookie(cookie);
out.print("已删除的 cookie:" +
cookie.getName( ) + "<br/>");
}
out.print("名称:" + cookie.getName( ) + ",");
out.print("值:" + cookie.getValue( )+" <br/>");
}
}else{
out.println(
"<h2 class=\"tutheader\">No Cookie founds</h2>");
}
out.println("</body>");
out.println("</html>");
}
/**
* @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)
*/
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// TODO Auto-generated method stub
doGet(request, response);
}
}
上記の Servlet をコンパイルしますDeleteCookies、web.xml ファイルに適切なエントリを作成します。次に実行します:http://localhost:8080/TomcatTest/DeleteCookies、次の結果が表示されます:
