Servlet的Cookies处理
以下内容引用自http://wiki.jikexueyuan.com/project/servlet/cookies-handling.html:
Cookies是存储在客户端计算机上的文本文件,用于各种信息的跟踪目的。Java Servlet透明的支持HTTP Cookies。
识别返回用户包括以下三个步骤:
-
服务器脚本向浏览器发送一组cookies。例如姓名、年龄或身份证号码等。
-
浏览器将这些信息存储在本地计算机中以备将来使用。
- 当下次浏览器向Web服务器发送任何请求时,它会把这些Cookies信息发送到服务器,服务器使用这些信息来识别用户。
一、Cookie剖析
通常情况下,Cookies设置在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=jsoft.com
Connection: close
Content-Type: text/html
正如所看到的,Set-Cookie头信息包含了一个名称值对、一个GMT日期、一个路径和一个域。名称和值会被URL编码。有效期字段指示浏览器在给定的时间和日期之后“忘记”该Cookie。
如果浏览器被配置为存储Cookies,它将会把这个信息保留到截止日期。如果用户在任何与该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 Cookies方法
以下是在Servlet中操作Cookies时可能会用到的有用的方法列表。
方法 | 描述 |
---|---|
public void setDomain(String pattern) |
该方法设置Cookie适用的域,例如jsoft.com。 |
public String getDomain() |
该方法获取Cookie适用的域,例如jsoft.com。 |
public void setMaxAge(int expiry) |
该方法设置Cookie过期的时间(以秒为单位)。如果不这样设置,Cookie只会在当前Session会话中持续有效。 |
public int getMaxAge() |
该方法返回Cookie 的最大生存周期(以秒为单位),默认情况下,-1表示Cookie将持续下去,直到浏览器关闭。 |
public String getName() |
该方法返回Cookie 的名称。名称在创建后不能改变。 |
public void setValue(String newValue) |
该方法设置与Cookie关联的值。 |
public String getValue() |
该方法获取与Cookie关联的值。 |
public void setPath(String uri) |
该方法设置Cookie适用的路径。如果不指定路径,与当前页面相同目录下的(包括子目录下的)所有URL都会返回Cookie。 |
public String getPath() |
该方法获取Cookie适用的路径。 |
public void setSecure(boolean flag) |
该方法设置布尔值,表示Cookie是否应该只在加密的(即SSL)连接上发送。 |
public void setComment(String purpose) |
该方法规定了描述Cookie目的的注释。该注释在浏览器向用户呈现Cookie时非常有用。 |
public String getComment() |
该方法返回了描述Cookie目的的注释,如果Cookie没有注释则返回null。 |
三、用Servlet设置Cookies
用Servlet设置Cookies包括三个步骤:
(1) 创建一个Cookie对象:用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响应头中添加Cookies,如下所示:
response.addCookie(cookie);
实例:
// Import required java libraries import java.io.*; import javax.servlet.*; import javax.servlet.http.*; // Extend HttpServlet class public class HelloForm extends HttpServlet { public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { // Create cookies for first and last names. Cookie firstName = new Cookie("first_name", request.getParameter("first_name")); Cookie lastName = new Cookie("last_name", request.getParameter("last_name")); // Set expiry date after 24 Hrs for both the cookies. firstName.setMaxAge(60*60*24); lastName.setMaxAge(60*60*24); // Add both the cookies in the response header. response.addCookie( firstName ); response.addCookie( lastName ); // Set response content type response.setContentType("text/html"); PrintWriter out = response.getWriter(); String title = "Setting Cookies Example"; String docType = "<!doctype html public \"-//w3c//dtd html 4.0 " + "transitional//en\">\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>First Name</b>: " + request.getParameter("first_name") + "\n" + " <li><b>Last Name</b>: " + request.getParameter("last_name") + "\n" + "</ul>\n" + "</body></html>"); } }
配置web.xml:
<servlet> <servlet-name>HelloForm</servlet-name> <servlet-class>com.jsoft.testservletbasics.HelloForm</servlet-class> </servlet> <servlet-mapping> <servlet-name>HelloForm</servlet-name> <url-pattern>/HelloForm</url-pattern> </servlet-mapping>
编译上述Servlet HelloForm并在web.xml文件中创建适当的条目,最后尝试使用下述HTML页面来调用Servlet。
<html> <body> <form action="HelloForm" method="GET"> First Name: <input type="text" name="first_name"> <br /> Last Name: <input type="text" name="last_name" /> <input type="submit" value="Submit" /> </form> </body> </html>
将上述HTML内容保存到文件hello.htm中并把它放在<Tomcat-installation-directory>/webapps/ROOT
目录中。当访问http://localhost:8080/Hello.htm
时,上述表单的实际输出如下所示(注意:POM和Eclipse项目忽略这一步):
尝试输入姓名,然后点击提交按钮。这将在屏幕上显示姓名,同时会设置firstName和lastName这两个Cookies,当下次点击提交按钮时,会将这两个Cookies传回到服务器。
四、用Servlet读取Cookies
要读取Cookies,需要通过调用HttpServletRequest的getCookies( )方法创建一个javax.servlet.http.Cookie对象的数组。然后循环遍历数组,并使用getName()和getValue()方法来访问每个Cookie及其相关的值。
实例:
// Import required java libraries import java.io.*; import javax.servlet.*; import javax.servlet.http.*; // Extend HttpServlet class public class ReadCookies extends HttpServlet { public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { Cookie cookie = null; Cookie[] cookies = null; // Get an array of Cookies associated with this domain cookies = request.getCookies(); // Set response content type response.setContentType("text/html"); PrintWriter out = response.getWriter(); String title = "Reading Cookies Example"; String docType = "<!doctype html public \"-//w3c//dtd html 4.0 " + "transitional//en\">\n"; out.println(docType + "<html>\n" + "<head><title>" + title + "</title></head>\n" + "<body bgcolor=\"#f0f0f0\">\n" ); if( cookies != null ){ out.println("<h2> Found Cookies Name and Value</h2>"); for (int i = 0; i < cookies.length; i++){ cookie = cookies[i]; out.print("Name : " + cookie.getName( ) + ", "); out.print("Value: " + cookie.getValue( )+" <br/>"); } }else{ out.println( "<h2>No cookies founds</h2>"); } out.println("</body>"); out.println("</html>"); } }
配置web.xml:
<servlet> <servlet-name>ReadCookies</servlet-name> <servlet-class>com.jsoft.testservletbasics.ReadCookies</servlet-class> </servlet> <servlet-mapping> <servlet-name>ReadCookies</servlet-name> <url-pattern>/ReadCookies</url-pattern> </servlet-mapping>
编译上述Servlet ReadCookies并在web.xml文件中创建适当的条目。将显示如下所示结果:
五、用Servlet删除Cookies
如果想删除一个Cookie,那么只需要按照如下所示的三个步骤进行:
- 读取一个现存的Cookie并把它存储在Cookie对象中。
- 使用setMaxAge()方法设置Cookie的年龄为零来删除一个现存的Cookie。
- 将这个Cookie添加到响应中。
实例:
下述例子将删除一个现存的命名为“first name”的Cookie,且当下次运行ReadCookies Servlet时,它会为first name返回空值。
// Import required java libraries import java.io.*; import javax.servlet.*; import javax.servlet.http.*; // Extend HttpServlet class public class DeleteCookies extends HttpServlet { public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { Cookie cookie = null; Cookie[] cookies = null; // Get an array of Cookies associated with this domain cookies = request.getCookies(); // Set response content type response.setContentType("text/html"); PrintWriter out = response.getWriter(); String title = "Delete Cookies Example"; String docType = "<!doctype html public \"-//w3c//dtd html 4.0 " + "transitional//en\">\n"; out.println(docType + "<html>\n" + "<head><title>" + title + "</title></head>\n" + "<body bgcolor=\"#f0f0f0\">\n" ); if( cookies != null ){ out.println("<h2> Cookies Name and Value</h2>"); for (int i = 0; i < cookies.length; i++){ cookie = cookies[i]; if((cookie.getName( )).compareTo("first_name") == 0 ){ cookie.setMaxAge(0); response.addCookie(cookie); out.print("Deleted cookie : " + cookie.getName( ) + "<br/>"); } out.print("Name : " + cookie.getName( ) + ", "); out.print("Value: " + cookie.getValue( )+" <br/>"); } }else{ out.println( "<h2>No cookies founds</h2>"); } out.println("</body>"); out.println("</html>"); } }
配置web.xml:
<servlet> <servlet-name>DeleteCookies</servlet-name> <servlet-class>com.jsoft.testservletbasics.DeleteCookies</servlet-class> </servlet> <servlet-mapping> <servlet-name>DeleteCookies</servlet-name> <url-pattern>/DeleteCookies</url-pattern> </servlet-mapping>
编译上述Servlet DeleteCookies并在web.xml文件中创建适当的条目。将显示如下所示的结果:
测试工程:https://github.com/easonjim/5_java_example/tree/master/servletbasics/test8