Servlet - Cookie 处理



Cookie 是存储在客户端计算机上的文本文件,它们用于各种信息跟踪目的。Java Servlet 透明地支持 HTTP Cookie。

识别回访用户涉及三个步骤:

  • 服务器脚本向浏览器发送一组 Cookie。例如姓名、年龄或识别号等。

  • 浏览器将此信息存储在本地机器上以供将来使用。

  • 下次浏览器向 Web 服务器发送任何请求时,它会将这些 Cookie 信息发送到服务器,服务器使用这些信息来识别用户。

本章将教你如何设置或重置 Cookie、如何访问它们以及如何删除它们。

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 = tutorialspoint.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 应用到的域,例如 tutorialspoint.com。

2

public String getDomain()

此方法获取 Cookie 应用到的域,例如 tutorialspoint.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 应用到的路径。如果您未指定路径,则 Cookie 将返回到与当前页面相同的目录中的所有 URL 以及所有子目录。

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 涉及三个步骤:

(1) 创建 Cookie 对象 - 使用 Cookie 名称和 Cookie 值(均为字符串)调用 Cookie 构造函数。

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

请记住,名称和值都不应包含空格或以下任何字符:

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

(2) 设置最大生存期 - 使用 setMaxAge 指定 Cookie 应有效多长时间(以秒为单位)。以下将设置 Cookie 持续 24 小时。

cookie.setMaxAge(60 * 60 * 24); 

(3) 将 Cookie 发送到 HTTP 响应标头 - 使用 response.addCookie 将 Cookie 添加到 HTTP 响应标头,如下所示:

response.addCookie(cookie);

示例

让我们修改我们的表单示例以设置姓氏和名字的 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>"
      );
   }
}

编译上述 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-installationdirectory>/webapps/ROOT 目录中。当您访问https://127.0.0.1:8080/Hello.htm时,以下是上述表单的实际输出。

名字
姓氏

尝试输入名字和姓氏,然后单击提交按钮。这将在屏幕上显示名字和姓氏,同时它将设置两个 Cookie firstName 和 lastName,下次您按下提交按钮时,它们将传递回服务器。

下一节将解释如何在 Web 应用程序中访问这些 Cookie。

使用 Servlet 读取 Cookie

要读取 Cookie,您需要通过调用HttpServletRequestgetCookies()方法创建一个javax.servlet.http.Cookie对象的数组。然后循环遍历数组,并使用 getName() 和 getValue() 方法访问每个 Cookie 及其关联的值。

示例

让我们读取我们在上一个示例中设置的 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>");
   }
}

编译上述 Servlet ReadCookies,并在 web.xml 文件中创建相应的条目。如果您已将 first_name Cookie 设置为“John”,将 last_name Cookie 设置为“Player”,则运行https://127.0.0.1:8080/ReadCookies将显示以下结果:

Found Cookies Name and Value

Name : first_name, Value: John
Name : last_name, Value: Player

使用 Servlet 删除 Cookie

删除 Cookie 非常简单。如果您想删除 Cookie,只需执行以下三个步骤:

  • 读取已存在的 Cookie 并将其存储在 Cookie 对象中。

  • 使用setMaxAge()方法将 Cookie 的生存期设置为零以删除现有 Cookie

  • 将此 Cookie 添加回响应标头。

示例

以下示例将删除名为“first_name”的现有 Cookie,下次运行 ReadCookies Servlet 时,它将返回 first_name 的 null 值。

// 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>");
   }
}

编译上述 Servlet DeleteCookies,并在 web.xml 文件中创建相应的条目。现在运行https://127.0.0.1:8080/DeleteCookies将显示以下结果:

Cookies Name and Value

Deleted cookie : first_name

Name : first_name, Value: John

Name : last_name, Value: Player

现在尝试运行https://127.0.0.1:8080/ReadCookies,它将仅显示一个 Cookie,如下所示:

Found Cookies Name and Value

Name : last_name, Value: Player

您可以在 Internet Explorer 中手动删除 Cookie。从“工具”菜单开始,然后选择“Internet 选项”。要删除所有 Cookie,请按“删除 Cookie”。

广告