如何在 Java Web 应用程序中使用 Cookie

叁歲伎倆 2023-09-30 08:55 2阅读 0赞

在本教程中，您将学习如何在 Java Web 应用程序中创建、更新、读取和删除 cookie。

cookie 是存储在 Web 浏览器中并通过 HTTP 标头在请求和响应之间传输的少量数据。cookie 具有名称和值，以及选项属性，如评论、路径、域、最大年龄…… cookie 通常用于在客户端实现简单的临时数据存储，例如会话管理、记住密码、购物车项目、等等。

在 Java Servlet API 中，javax.servlet.http。**Cookie**类代表一个 cookie。

表中的内容：

1. 如何创建cookie  
2. 如何读取cookie  
3. 如何更新cookie  
4. 如何删除cookie  
5. Java cookie 示例项目

### **1.如何创建cookie** ###

要在 Web 浏览器中存储 cookie，首先创建一个新的Cookie对象：

然后在 Servlet 类中调用HttpServletResponse对象的addCookie()方法，如下所示：

这将向客户端发送适当的 HTTP 标头，并且浏览器将 cookie 存储在用户的计算机上。

除了强制属性名称和值之外，您还可以使用以下方法为 cookie 指定附加信息：

**setComment** (String) : 指定描述 cookie 用途的注释。例如：

**setDomain** (String) : 指定此 cookie 在其中可见的域名。默认情况下，cookie 只返回给发送它们的服务器。所以设置域名使得cookies可以在同一个域名下的不同服务器上使用。例如：

此 cookie 将可用于域 codejava.net 下的所有服务器。请注意，域名应以点开头。以下示例将 cookie 的域设置为 localhost：

**setHttpOnly** (boolean) : 如果设置为true，Javascript在客户端无法读取这个cookie，可以防止一些跨站脚本攻击。例如：

**setMaxAge** (int) : 指定 cookie 在用户计算机中存储的时间，以秒为单位。如果未设置，则在 Web 浏览器退出时删除 cookie。例如：

这将 cookie 的寿命设置为 7 天（= 24 小时 x 60 分钟 x 60 秒），并且当浏览器存在时它仍存储在用户的计算机上。

**setPath** (String)：如果您想限制 cookie 可用于服务器上的某个路径（及其子路径），请使用此方法。例如：

**setSecure** (boolean) : 如果设置为 true，cookie 仅在使用安全协议（HTTPS 或 SSL）时从浏览器发送到服务器。默认为假。

##    **2.如何读取cookies** ##

要读取从浏览器发送到服务器的 cookie，请在 Java servlet 类中的HttpServletRequest对象上调用getCookies()方法。此方法返回对当前请求可见的Cookie对象数组。例如，以下代码读取所有 cookie 并打印其名称和值：

<table> 
 <tbody> 
  <tr> 
   <td style="text-align:left;vertical-align:baseline;"> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">1</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">2</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">3</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">4</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">5</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">6</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">7</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">8</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">9</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">10</span></span></span></span> 
    </div> </td> 
   <td style="text-align:left;vertical-align:baseline;"> 
    <div style="margin-left:0;text-align:left;"> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>Cookie[] cookies = request.getCookies();</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;">&nbsp;</span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>PrintWriter writer = response.getWriter();</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;">&nbsp;</span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>for</code> <code>(Cookie aCookie : cookies) { </code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>String name = aCookie.getName();</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>String value = aCookie.getValue();</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;">&nbsp;</span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>writer.println(name +&nbsp;</code><code>" = "</code> <code>+ value);</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>}</code></span></span></span></span> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

这意味着如果您想读取特定的 cookie，您需要在循环中检查 cookie 的名称。例如：

<table> 
 <tbody> 
  <tr> 
   <td style="text-align:left;vertical-align:baseline;"> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">1</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">2</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">3</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">4</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">5</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">6</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">7</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">8</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">9</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">10</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">11</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">12</span></span></span></span> 
    </div> </td> 
   <td style="text-align:left;vertical-align:baseline;"> 
    <div style="margin-left:0;text-align:left;"> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>String username =&nbsp;</code><code>null</code><code>;</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;">&nbsp;</span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>for</code> <code>(Cookie aCookie : cookies) { </code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>String name = aCookie.getName();</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;">&nbsp;</span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>(name.equals(</code><code>"username"</code><code>)) { </code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>username = aCookie.getValue();</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp;</span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>break</code><code>;</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp;</span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>}</code></span></span></span></span> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

如您所见，此代码片段读取名为“用户名”的 cookie 的值。

###    **3. 如何更新 cookie** ###

要更新现有 cookie，您需要创建一个具有相同名称的新 cookie 并将其添加到响应中。例如：

这将覆盖（更新）具有相同名称的 cookie。

###    **4.如何删除cookie** ###

要从浏览器的缓存中删除 cookie，您需要创建一个具有相同名称的新 cookie，将其最大年龄设置为零并将其添加到响应中。例如：

<table> 
 <tbody> 
  <tr> 
   <td style="text-align:left;vertical-align:baseline;"> 
    <div style="margin-left:0;text-align:right;">
      1 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">2</span></span></span></span> 
    </div> 
    <div style="margin-left:0;text-align:right;"> 
     <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="color:#787878;">3</span></span></span></span> 
    </div> </td> 
   <td style="text-align:left;vertical-align:baseline;"> 
    <div style="margin-left:0;text-align:left;"> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>Cookie cookie =&nbsp;</code><code>new</code> <code>Cookie(</code><code>"username"</code><code>,&nbsp;</code><code>""</code><code>);</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>cookie.setMaxAge(</code><code>0</code><code>);</code></span></span></span></span> 
     </div> 
     <div style="margin-left:0;text-align:left;"> 
      <span style="color:#333333;"><span style="background-color:#ffffff;"><span style="background-color:#FFFFFF;"><span style="background-color:#ffffff;"><code>response.addCookie(cookie);</code></span></span></span></span> 
     </div> 
    </div> </td> 
  </tr> 
 </tbody> 
</table>

此代码从浏览器中删除名为“用户名”的 cookie。

##    **5. Java Cookies 示例项目** ##

以下示例项目可帮助您了解如何在 Java Web 应用程序中使用 cookie。创建一个简单的 Java Web 项目。将主页 ( index.jsp ) 编码如下：

<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
    	pageEncoding="ISO-8859-1"%>
    <!DOCTYPE html>
    <html>
    <head>
    <meta charset="ISO-8859-1">
    <title>Java Cookies Example</title>
    </head>
    <body>
    	<div align="center">
    		<h1>Java Cookies Example</h1>
    
    		<h2>
    			<a href="add_cookies">Add Cookies</a>
    		</h2>
    		<h2>
    			<a href="read_cookies">Read Cookies</a>
    		</h2>
    		<h2>
    			<a href="delete_cookies">Delete Cookies</a>
    		</h2>
    
    	</div>
    </body>
    </html>

此页面显示 3 个超链接来测试创建、读取和删除 cookie：

![fe6e67bc7b39f4692ce71f06212145c0.png][]

创建AddCookiesServlet 类以使用以下代码处理超链接“添加 Cookie”：

import java.io.IOException;
    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;
    
    @WebServlet("/add_cookies")
    public class AddCookiesServlet extends HttpServlet {
    	private static final long serialVersionUID = 1L;
    	private static int cookieCount;
    
    	public AddCookiesServlet() {
    	}
    
    	protected void doGet(HttpServletRequest request, HttpServletResponse response)
    			throws ServletException, IOException {
    
    		String name = "Cookie" + (++cookieCount);
    		String value = String.valueOf(System.currentTimeMillis());
    		Cookie cookie = new Cookie(name, value);
    
    		response.addCookie(cookie);
    
    		response.getWriter().println("A cookie has been created successfully!");
    
    	}
    
    }

每次单击“添加 Cookie”链接时，都会创建一个新的 cookie 并将其发送到浏览器。

使用以下代码创建ReadCookiesServlet 类以读取应用程序可见的所有 cookie：

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;
    
    @WebServlet("/read_cookies")
    public class ReadCookiesServlet extends HttpServlet {
    	private static final long serialVersionUID = 1L;
    
    	public ReadCookiesServlet() {
    	}
    
    	protected void doGet(HttpServletRequest request, HttpServletResponse response)
    			throws ServletException, IOException {
    		PrintWriter writer = response.getWriter();
    
    		Cookie[] cookies = request.getCookies();
    
    		if (cookies == null) {
    			writer.println("No cookies found");
    		} else {
    			writer.println("Number of cookies: " + cookies.length);
    
    			for (Cookie aCookie : cookies) {
    				String name = aCookie.getName();
    				String value = aCookie.getValue();
    
    				writer.println(name + " = " + value);
    			}
    		}
    	}
    
    }

单击链接“Read Cookies”将在浏览器中给出以下输出：

![cd8d11c8b1dd2acc8d5dacffb4f86f3f.png][]

如您所见，第一个名为JSESSIONID 的 cookie是由服务器创建的，用于管理用户的会话。

要测试 cookie 的删除，请使用以下代码创建DeleteCookiesServlet类：

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;
    
    @WebServlet("/delete_cookies")
    public class DeleteCookiesServlet extends HttpServlet {
    	private static final long serialVersionUID = 1L;
    
    	public DeleteCookiesServlet() {
    	}
    
    	protected void doGet(HttpServletRequest request, HttpServletResponse response)
    			throws ServletException, IOException {
    
    		PrintWriter writer = response.getWriter();
    
    		Cookie[] cookies = request.getCookies();
    
    		if (cookies != null) {
    			for (Cookie aCookie : cookies) {
    				aCookie.setMaxAge(0);
    				response.addCookie(aCookie);
    			}
    
    			writer.println("All cookies have been deleted!");
    		} else {
    			writer.println("No cookies found");
    		}
    
    	}
    
    }

**了解更多：**

[使用cookies实现记住密码功能][cookies]

**API 参考：**

[Cookie 类 Javadoc][Cookie _ Javadoc]

[fe6e67bc7b39f4692ce71f06212145c0.png]: https://img-blog.csdnimg.cn/img_convert/fe6e67bc7b39f4692ce71f06212145c0.png
[cd8d11c8b1dd2acc8d5dacffb4f86f3f.png]: https://img-blog.csdnimg.cn/img_convert/cd8d11c8b1dd2acc8d5dacffb4f86f3f.png
[cookies]: https://www.codejava.net/coding/how-to-implement-remember-password-remember-me-for-java-web-application
[Cookie _ Javadoc]: https://docs.oracle.com/javaee/7/api/javax/servlet/http/Cookie.html