当前位置: 首页>>代码示例 >>用法及示例精选 >>正文

Java Javax.servlet.http.Cookie用法及代码示例


许多网站使用称为 cookie 的小文本字符串来存储连接之间的持久客户端状态。 Cookie 在请求和响应的 HTTP 标头中从服务器传递到客户端，然后再次传递返回。服务器可以使用 Cookie 来指示会话 ID、购物车内容、登录凭据、用户首选项等。

How Cookies work?

How cookies work?

从上图可以看出，当用户第一次请求页面时，服务器与资源一起发送一个 cookie 对象以存储在客户端的计算机上。该对象可能包含请求的详细信息。现在，如果用户再次请求相同的资源，它会随请求一起发送存储的 cookie，服务器可以使用该 cookie 来进一步增强用户的体验。

Cookie 的属性：

  • 名称=值对：这说明了 cookie 中存储的实际信息。名称和值均不应包含空格或以下任何字符：[ ] ( ) = , ” /? @：；
    有效 cookie name-value 对的示例：
     
     Set-Cookie:session-id = 187-4969589-3049309
  • Domain:默认情况下，cookie 适用于它来自的服务器。如果 cookie 最初是由 www.foo.example.com 设置的，则浏览器只会将该 cookie 发送回 www.foo.example.com。但是，站点还可以指示 cookie 适用于整个子域，而不仅仅是原始服务器。例如，此请求为整个 foo.example.com 域设置用户 cookie：
    浏览器不仅会将此 cookie 回显给 www.foo.example.com，还会回显给 lothar.foo.example.com、eliza.foo.example.com、enoch.foo.example.com 以及任何其他主机。在foo.example.com 域中。但是，服务器只能为其直接所属的域设置 cookie。 www.foo.example.com 无法为 www.geeksforgeeks.org、example.com 或 .com 设置 cookie，无论它如何设置域。
     Set-Cookie: user = geek ;Domain =.foo.example.com
  • Path:当从同一服务器请求子树中的文档时，客户端会回显该 cookie。但是，它不使用站点上其他目录中的 cookie。
    Set-Cookie: user = geek; Path =/ restricted
  • Expires :该日期过后，浏览器应从缓存中删除 cookie。
     Set-Cookie: user = geek; expires = Wed, 21-Feb-2017 15:23:00 IST
  • Max-Age:此属性将 cookie 设置为在经过一定秒数后而不是在特定时刻过期。例如，此 cookie 在首次设置后一小时(3,600 秒)过期。
    Set-Cookie: user = "geek"; Max-Age = 3600

构造函数：使用指定的name-value对创建一个cookie。

Syntax : public Cookie(String name, String value)
Parameters :
name : name of the cookie
value : value associated with this cookie

方法：

  1. setDomain():设置此 cookie 可见的域。前面在cookie部分的属性中详细解释了域。
    Syntax : public void setDomain(String pattern)
Parameters :
pattern : string representing the domain in which this cookie is visible.
  2. getDomain():返回此 cookie 可见的域。
    Syntax : public String getDomain()
  3. setComment():指定此 cookie 的用途。
    Syntax : public void setComment(String purpose)
Parameters :
purpose : string representing the purpose of this cookie.
  4. getComment()：返回表示此 cookie 用途的字符串。
    Syntax : public String getComment()
  5. setMaxAge():指定此 cookie 过期之前经过的时间(以秒为单位)。
    Syntax : public void setMaxAge(long time)
Parameters :
time : time in seconds before this cookie expires
  6. getMaxAge():返回此 cookie 的最大年龄部分。
    Syntax : public String getMaxAge()
  7. setPath():指定客户端应将 cookie 返回到的 cookie 路径。
    Syntax : public void setPath(String path)
Parameters :
path : path where this cookie is returned
  8. getPath():返回此 cookie 的路径部分。
    Syntax : public String getMaxAge()
  9. setSecure():指示发送此 cookie 时是否使用安全协议。默认值为 false。
    Syntax : public void setSecure(boolean secure)
参数：
secure - If true, the cookie can only be sent over a secure
protocol like https. 
If false, it can be sent over any protocol.
  10. getSecure():如果此 cookie 必须是，则返回 true
    由安全协议发送，否则为 false。
    Syntax : public boolean getSecure()
  11. getName():返回 cookie 的名称。
     Syntax : public String getName()
  12. setValue():初始化后为 cookie 分配新值。
    Syntax : public void setValue(String newValue)
Parameters :
newValue - a String specifying the new value
  13. getValue :返回 cookie 的值。
    Syntax : public String getValue()
  14. getVersion():如果 cookie 符合原始 Netscape 规范，则返回 0； 1 如果 cookie 符合 RFC 2965/2109
    Syntax : public int getVersion()
  15. setVersion():用于设置此 cookie 使用的 cookie 协议的版本。
    Syntax :public void setVersion(int v)
Parameters :
v - 0 for original Netscape specification; 1 for RFC 2965/2109
  16. clone():返回此 cookie 的副本。
    Syntax : public Cookie clone()

下面是一个简单 servlet 程序的 Java 实现，当用户第一次请求它时，它会在浏览器中存储一个 cookie，然后对于进一步的请求，它会显示存储的 cookie。


// Java program to illustrate methods 
// of Cookie class 
import java.io.IOException; 
import java.io.PrintWriter; 
import java.util.List; 
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 cookieTest 
 */
@WebServlet("/cookieTest") 
public class cookieTest extends HttpServlet  
{ 
    private static final long serialVersionUID = 1L; 
  
    /** 
     * @see HttpServlet#HttpServlet() 
     */
    public cookieTest() { 
        super(); 
        // TODO Auto-generated constructor stub 
    } 
  
    /** 
     * @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse 
     *      response) 
     */
    protected void doGet(HttpServletRequest request, HttpServletResponse response) 
            throws ServletException, IOException  
    { 
  
        response.setContentType("text/html"); 
        // Create a new cookie with the name test cookie 
        // and value 123 
        Cookie cookie = new Cookie("test_cookie", "123"); 
  
        // setComment() method 
        cookie.setComment("Just for testing"); 
  
        // setDomain() method 
        // cookie.setDomain("domain"); 
  
        // setMaxAge() method 
        cookie.setMaxAge(3600); 
  
        // setPath() method 
        cookie.setPath("/articles"); 
  
        // setSecure() method 
        cookie.setSecure(false); 
  
        // setValue() method 
        cookie.setValue("321"); 
  
        // setVersion() method 
        cookie.setVersion(0); 
  
        response.addCookie(cookie); 
  
        PrintWriter pw = response.getWriter(); 
        pw.print("<html><head></head><body>"); 
        Cookie ck[] = request.getCookies(); 
  
        if (ck == null) { 
            pw.print("<p>This is first time the page is requested.</p>"); 
            pw.print("<p>And therefore no cookies found</p></body></html>"); 
        } else { 
            pw.print("<p>Welcome Again...Cookies found</p>"); 
            for (int i = 0; i < ck.length; i++) { 
  
                // getName() method 
                pw.print("<p>Name :" + ck[i].getName() + "</p>"); 
  
                // getValue() method 
                pw.print("<p>Value :" + ck[i].getValue() + "</p>"); 
  
                // getDomain() method 
                pw.print("<p>Domain :" + ck[i].getDomain() + "</p>"); 
  
                // getPath() method 
                pw.print("<p>Name :" + ck[i].getPath() + "</p>"); 
  
                // getMaxAge() method 
                pw.print("<p>Max Age :" + ck[i].getMaxAge() + "</p>"); 
  
                // getComment() method 
                pw.print("<p>Comment :" + ck[i].getComment() + "</p>"); 
  
                // getSecure() method 
                pw.print("<p>Name :" + ck[i].getSecure() + "</p>"); 
  
                // getVersion() method 
                pw.print("<p>Version :" + ck[i].getVersion() + "</p>"); 
            } 
            pw.print("<body></html>"); 
  
        } 
        pw.close(); 
    } 
  
    /** 
     * @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse 
     *      response) 
     */
    protected void doPost(HttpServletRequest request, HttpServletResponse response) 
            throws ServletException, IOException  
    { 
      
        doGet(request, response); 
    } 
  
}

输出：以下输出来自网络浏览器 -
对于第一个请求：

This is first time the page is requested.
And therefore no cookies found.

对于第二个请求：

Welcome Again...Cookies found
Name :test_cookie
Value :321
Domain :null
Name :null
Max Age :-1
Comment :null
Name :false
Version :0

How to run the above program?

首先，确保您安装了 Apache Tomcat 等服务器，并使用您正在使用的工具(如 Eclipse)进行了配置。只需在服务器或本地浏览器上运行上述程序，只需输入您正在使用的服务器目录的完整地址即可。
CookieTest servlet，一个执行三项任务的 servlet：

  1. 首先，servlet 设置一个名为 test_cookie 的 cookie。程序中的其他行设置cookie的属性，例如最大年龄、域、值等。
  2. 其次，servlet 使用request.getCookies 查找所有传入的 cookie 并显示它们的名称和其他相应属性。
  3. 如果像第一次请求一样没有找到 cookie，则会显示一条简单的显示消息，告诉您这是第一次访问该页面。

参考：Official Java Documentation



相关用法


注：本文由纯净天空筛选整理自佚名大神的英文原创作品 Javax.servlet.http.Cookie class in Java。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。