九、处理Cookie

March 25,2004

九、处理Cookie
作者 : 仙人掌工作室

　　 9.1 Cookie概述

　　 Cookie是服务器发送给浏览器的体积很小的纯文本信息，用户以后访问同一个Web服务器时浏览器会把它们原样发送给服务器。通过让服务器读取它原先保存到客户端的信息，网站能够为浏览者提供一系列的方便，例如在线交易过程中标识用户身份、安全要求不高的场合避免用户重复输入名字和密码、门户网站的主页定制、有针对性地投放广告，等等。

　　 Cookie的目的就是为用户带来方便，为网站带来增值。虽然有着许多误传，事实上Cookie并不会造成严重的安全威胁。Cookie永远不会以任何方式执行，因此也不会带来病毒或攻击你的系统。另外，由于浏览器一般只允许存放300个Cookie，每个站点最多存放20个Cookie，每个Cookie的大小限制为4 KB，因此Cookie不会塞满你的硬盘，更不会被用作“拒绝服务”攻击手段。

　　 9.2 Servlet的Cookie API

　　要把Cookie发送到客户端，Servlet先要调用new Cookie(name,value)用合适的名字和值创建一个或多个Cookie（2.1节），通过cookie.setXXX设置各种属性（2.2节），通过response.addCookie(cookie)把cookie加入应答头（2.3节）。

　　要从客户端读入Cookie，Servlet应该调用request.getCookies()，getCookies()方法返回一个Cookie对象的数组。在大多数情况下，你只需要用循环访问该数组的各个元素寻找指定名字的Cookie，然后对该Cookie调用getValue方法取得与指定名字关联的值，这部分内容将在2.4节讨论。

　　 9.2.1 创建Cookie

　　调用Cookie对象的构造函数可以创建Cookie。Cookie对象的构造函数有两个字符串参数：Cookie名字和Cookie值。名字和值都不能包含空白字符以及下列字符：
  [ ] ( ) = , " / ? @ : ;

　　 9.2.2 读取和设置Cookie属性

　　把Cookie加入待发送的应答头之前，你可以查看或设置Cookie的各种属性。下面摘要介绍这些方法：

getComment/setComment
获取/设置Cookie的注释。
getDomain/setDomain
获取/设置Cookie适用的域。一般地，Cookie只返回给与发送它的服务器名字完全相同的服务器。使用这里的方法可以指示浏览器把Cookie返回给同一域内的其他服务器。注意域必须以点开始（例如.sitename.com），非国家类的域（如.com，.edu，.gov）必须包含两个点，国家类的域（如.com.cn，.edu.uk）必须包含三个点。
getMaxAge/setMaxAge
获取/设置Cookie过期之前的时间，以秒计。如果不设置该值，则Cookie只在当前会话内有效，即在用户关闭浏览器之前有效，而且这些Cookie不会保存到磁盘上。参见下面有关LongLivedCookie的说明。
getName/setName
获取/设置Cookie的名字。本质上，名字和值是我们始终关心的两个部分。由于HttpServletRequest的getCookies方法返回的是一个Cookie对象的数组，因此通常要用循环来访问这个数组查找特定名字，然后用getValue检查它的值。
getPath/setPath
获取/设置Cookie适用的路径。如果不指定路径，Cookie将返回给当前页面所在目录及其子目录下的所有页面。这里的方法可以用来设定一些更一般的条件。例如，someCookie.setPath("/")，此时服务器上的所有页面都可以接收到该Cookie。
getSecure/setSecure
获取/设置一个boolean值，该值表示是否Cookie只能通过加密的连接（即SSL）发送。
getValue/setValue
获取/设置Cookie的值。如前所述，名字和值实际上是我们始终关心的两个方面。不过也有一些例外情况，比如把名字作为逻辑标记（也就是说，如果名字存在，则表示true）。
getVersion/setVersion
获取/设置Cookie所遵从的协议版本。默认版本0（遵从原先的Netscape规范）；版本1遵从RFC 2109 ，但尚未得到广泛的支持。
　　 9.2.3 在应答头中设置Cookie

　　 Cookie可以通过HttpServletResponse的addCookie方法加入到Set-Cookie应答头。下面是一个例子：
  Cookie userCookie = new Cookie("user", "uid1234");
  response.addCookie(userCookie);

　　 9.2.4 读取保存到客户端的Cookie

　　要把Cookie发送到客户端，先要创建Cookie，然后用addCookie发送一个Set-Cookie HTTP应答头。这些内容已经在上面的2.1节介绍。从客户端读取Cookie时调用的是HttpServletRequest的getCookies方法。该方法返回一个与HTTP请求头中的内容对应的Cookie对象数组。得到这个数组之后，一般是用循环访问其中的各个元素，调用getName检查各个Cookie的名字，直至找到目标Cookie。然后对这个目标Cookie调用getValue，根据获得的结果进行其他处理。

　　上述处理过程经常会遇到，为方便计下面我们提供一个getCookieValue方法。只要给出Cookie对象数组、Cookie名字和默认值，getCookieValue方法就会返回匹配指定名字的Cookie值，如果找不到指定Cookie，则返回默认值。

　　 9.3 几个Cookie工具函数

　　下面是几个工具函数。这些函数虽然简单，但是，在和Cookie打交道的时候很有用。

　　 9.3.1 获取指定名字的Cookie值

　　该函数是ServletUtilities.java的一部分。getCookieValue通过循环依次访问Cookie对象数组的各个元素，寻找是否有指定名字的Cookie，如找到，则返回该Cookie的值；否则，返回参数中给出的默认值。getCookieValue能够在一定程度上简化Cookie值的提取。
  public static String getCookieValue(Cookie[] cookies,
            String cookieName,
            String defaultValue) {
for(int i=0; i＜cookies.length; i++) {
   Cookie cookie = cookies;
   if (cookieName.equals(cookie.getName()))
      return(cookie.getValue());
}
return(defaultValue);
  }

　　 9.3.2自动保存的Cookie

　　下面是LongLivedCookie类的代码。如果你希望Cookie能够在浏览器退出的时候自动保存下来，则可以用这个LongLivedCookie类来取代标准的Cookie类。
package hall;

import javax.servlet.http.*;

public class LongLivedCookie extends Cookie {
  public static final int SECONDS_PER_YEAR = 60*60*24*365;
  public LongLivedCookie(String name, String value) {
super(name, value);
setMaxAge(SECONDS_PER_YEAR);
  }
}

　　 9.4.实例：定制的搜索引擎界面

　　下面也是一个搜索引擎界面的例子，通过修改前面HTTP状态代码的例子得到。在这个Servlet中，用户界面是动态生成而不是由静态HTML文件提供的。Servlet除了负责读取表单数据并把它们发送给搜索引擎之外，还要把包含表单数据的Cookie发送给客户端。以后客户再次访问同一表单时，这些Cookie的值将用来预先填充表单，使表单自动显示最近使用过的数据。

　　 SearchEnginesFrontEnd.java

　　该Servlet构造一个主要由表单构成的用户界面。第一次显示的时候，它和前面用静态HTML页面提供的界面差不多。然而，用户选择的值将被保存到Cookie（本页面将数据发送到CustomizedSearchEngines Servlet，由后者设置Cookie）。用户以后再访问同一页面时，即使浏览器是退出之后再启动，表单中也会自动填好上一次搜索所填写的内容。

　　注意该Servlet用到了ServletUtilities.java，其中getCookieValue前面已经介绍过，headWithTitle用于生成HTML页面的一部分。另外，这里也用到了前面已经说明的LongLiveCookie类，我们用它来创建作废期限很长的Cookie。
package hall;

import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.net.*;

public class SearchEnginesFrontEnd extends HttpServlet {
  public void doGet(HttpServletRequest request,
               HttpServletResponse response)
   throws ServletException, IOException {
Cookie[] cookies = request.getCookies();
String searchString =
   ServletUtilities.getCookieValue(cookies,
         "searchString",
         "Java Programming");
String numResults =
   ServletUtilities.getCookieValue(cookies,
         "numResults",
         "10");
String searchEngine =
   ServletUtilities.getCookieValue(cookies,
            "searchEngine",
            "google");
response.setContentType("text/html");
PrintWriter out = response.getWriter();
String title = "Searching the Web";
out.println(ServletUtilities.headWithTitle(title) +
            "＜BODY BGCOLOR=＼"#FDF5E6＼"＞＼n" +
            "＜H1 ALIGN=＼"CENTER＼"＞Searching the Web＜/H1＞＼n" +
            "＼n" +
            "＜FORM ACTION=＼"/servlet/hall.CustomizedSearchEngines＼"＞＼n" +
            "＜CENTER＞＼n" +
            "Search String:＼n" +
            "＜INPUT TYPE=＼"TEXT＼" NAME=＼"searchString＼"＼n" +
            "    VALUE=＼"" + searchString + "＼"＞＜BR＞＼n" +
            "Results to Show Per Page:＼n" +
            "＜INPUT TYPE=＼"TEXT＼" NAME=＼"numResults＼"＼n" +
            "    VALUE=" + numResults + " SIZE=3＞＜BR＞＼n" +
            "＜INPUT TYPE=＼"RADIO＼" NAME=＼"searchEngine＼"＼n" +
            "    VALUE=＼"google＼"" +
            checked("google", searchEngine) + "＞＼n" +
            "Google |＼n" +
            "＜INPUT TYPE=＼"RADIO＼" NAME=＼"searchEngine＼"＼n" +
            "    VALUE=＼"infoseek＼"" +
            checked("infoseek", searchEngine) + "＞＼n" +
            "Infoseek |＼n" +
            "＜INPUT TYPE=＼"RADIO＼" NAME=＼"searchEngine＼"＼n" +
            "    VALUE=＼"lycos＼"" +
            checked("lycos", searchEngine) + "＞＼n" +
            "Lycos |＼n" +
            "＜INPUT TYPE=＼"RADIO＼" NAME=＼"searchEngine＼"＼n" +
            "    VALUE=＼"hotbot＼"" +
            checked("hotbot", searchEngine) + "＞＼n" +
            "HotBot＼n" +
            "＜BR＞＼n" +
            "＜INPUT TYPE=＼"SUBMIT＼" VALUE=＼"Search＼"＞＼n" +
            "＜/CENTER＞＼n" +
            "＜/FORM＞＼n" +
            "＼n" +
            "＜/BODY＞＼n" +
            "＜/HTML＞＼n");
  }

  private String checked(String name1, String name2) {
if (name1.equals(name2))
   return(" CHECKED");
else
   return("");
  }
}

　　 CustomizedSearchEngines.java

　　前面的SearchEnginesFrontEnd Servlet把数据发送到CustomizedSearchEngines Servlet。本例在许多方面与前面介绍HTTP状态代码时的例子相似，区别在于，本例除了要构造一个针对搜索引擎的URL并向用户发送一个重定向应答之外，还要发送保存用户数据的Cookies。
package hall;

import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.net.*;

public class CustomizedSearchEngines extends HttpServlet {
  public void doGet(HttpServletRequest request,
                  HttpServletResponse response)
   throws ServletException, IOException {

String searchString = request.getParameter("searchString");
Cookie searchStringCookie =
   new LongLivedCookie("searchString", searchString);
response.addCookie(searchStringCookie);
searchString = URLEncoder.encode(searchString);
String numResults = request.getParameter("numResults");
Cookie numResultsCookie =
   new LongLivedCookie("numResults", numResults);
response.addCookie(numResultsCookie);
String searchEngine = request.getParameter("searchEngine");
Cookie searchEngineCookie =
   new LongLivedCookie("searchEngine", searchEngine);
response.addCookie(searchEngineCookie);
SearchSpec[] commonSpecs = SearchSpec.getCommonSpecs();
for(int i=0; i＜commonSpecs.length; i++) {
   SearchSpec searchSpec = commonSpecs;
   if (searchSpec.getName().equals(searchEngine)) {
      String url =
      searchSpec.makeURL(searchString, numResults);
      response.sendRedirect(url);
      return;
   }
}
response.sendError(response.SC_NOT_FOUND,
                     "No recognized search engine specified.");
  }

  public void doPost(HttpServletRequest request,
                  HttpServletResponse response)
   throws ServletException, IOException {
doGet(request, response);
  }
}