Servlet Обработка Cookie
Cookies — это текстовые файлы, хранящиеся на компьютере клиента и содержащие различную информацию для отслеживания. Java Servlet, очевидно, поддерживает HTTP Cookies.
Распознавание возвращающихся пользователей включает три шага:
- Серверный скрипт отправляет набор Cookies браузеру. Например: имя, возраст или идентификационный номер и т. д.
- Браузер сохраняет эту информацию на локальном компьютере для будущего использования.
- Когда браузер в следующий раз отправит любой запрос на веб-сервер, браузер отправит эту информацию куки на сервер, и сервер использует эту информацию для идентификации пользователя.
В этой главе объясняется, как устанавливать или сбрасывать куки, как получать к ним доступ и как их удалять.
Обработка куки в Servlet требует кодирования и декодирования китайских символов. Методы следующие:
String str = java.net.URLEncoder.encode("中文","UTF-8"); //编码 String str = java.net.URLDecoder.decode("编码后的字符串","UTF-8"); // 解码
Анализ куки
Куки обычно устанавливаются в HTTP-заголовке (хотя JavaScript также может напрямую установить куки в браузере). 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=example.com
Connection: close
Content-Type: text/html
Как видите, заголовок Set-Cookie содержит пару имя-значение, дату GMT, путь и домен. Имя и значение URL-кодируются. Поле expires — это инструкция, которая сообщает браузеру "забыть" куки после заданного времени и даты.
Если браузер настроен на хранение куки, он сохранит эту информацию до даты истечения срока. Если браузер пользователя указывает на любую страницу, соответствующую пути и домену куки, он повторно отправит куки на сервер. Информация заголовка браузера может выглядеть так:
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 в сервлете
Ниже приведён список полезных методов, доступных для манипулирования куки в Servlet.
| Нет. | Метод и описание |
|---|---|
| 1 | public void setDomain(String pattern) Этот метод задаёт домен, к которому применяется куки, например example.com. |
| 2 | public String getDomain() Этот метод получает домен, к которому применяется куки, например example.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. Если не указать путь, все URL в том же каталоге, что и текущая страница (включая подкаталоги), будут возвращать cookie. |
| 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, возвращает null, если у cookie нет комментария. |
Установка Cookie через Servlet
Установка Cookie через Servlet включает три шага:
(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 для имени и фамилии.
package com.example.test;
import java.io.IOException;
import java.io.PrintWriter;
import java.net.URLEncoder;
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 HelloServlet
*/
@WebServlet("/HelloForm")
public class HelloForm extends HttpServlet {
private static final long serialVersionUID = 1L;
/**
* @see HttpServlet#HttpServlet()
*/
public HelloForm() {
super();
// TODO Auto-generated constructor stub
}
/**
* @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
*/
public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
{
// 为名字和姓氏创建 Cookie
Cookie name = new Cookie("name",
URLEncoder.encode(request.getParameter("name"), "UTF-8")); // 中文转码
Cookie url = new Cookie("url",
request.getParameter("url"));
// 为两个 Cookie 设置过期日期为 24 小时后
name.setMaxAge(60*60*24);
url.setMaxAge(60*60*24);
// 在响应头中添加两个 Cookie
response.addCookie( name );
response.addCookie( url );
// 设置响应内容类型
response.setContentType("text/html;charset=UTF-8");
PrintWriter out = response.getWriter();
String title = "设置 Cookie 实例";
String docType = "<!DOCTYPE html>\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>站点名:</b>:"
+ request.getParameter("name") + "\n</li>" +
" <li><b>站点 URL:</b>:"
+ request.getParameter("url") + "\n</li>" +
"</ul>\n" +
"</body></html>");
}
/**
* @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)
*/
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// TODO Auto-generated method stub
doGet(request, response);
}
}
Скомпилируйте приведённый выше сервлетHelloFormи создайте соответствующие записи в файле web.xml:
<?xml version="1.0" encoding="UTF-8"?>
<web-app>
<servlet>
<!-- 类名 -->
<servlet-name>HelloForm</servlet-name>
<!-- 所在的包 -->
<servlet-class>com.example.test.HelloForm</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>HelloForm</servlet-name>
<!-- 访问的网址 -->
<url-pattern>/TomcatTest/HelloForm</url-pattern>
</servlet-mapping>
</web-app>
Наконец, попробуйте следующую HTML-страницу, чтобы вызвать сервлет.
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Example(example.com)</title> </head> <body> <form action="../TomcatTest/HelloForm" method="GET"> 站点名 :<input type="text" name="name"> <br /> 站点 URL:<input type="text" name="url" /><br> <input type="submit" value="提交" /> </form> </body> </html>
Сохраните приведённое выше HTML-содержимое в файл /TomcatTest/test.html.
Затем мы переходим по адресу http://localhost:8080/TomcatTest/test.html. Демонстрация в формате GIF выглядит так:

Примечание:Некоторые из приведённых выше путей необходимо изменить в соответствии с фактическим путём вашего проекта.
Чтение куки с помощью сервлета
Чтобы прочитать куки, нужно вызвать уHttpServletRequestметодgetCookies( ), чтобы создатьjavax.servlet.http.Cookieмассив объектов. Затем пройдите по массиву в цикле и используйте методы getName() и getValue() для доступа к каждому куки и связанному с ним значению.
Пример
Давайте прочитаем куки, установленные в приведённом выше примере
package com.example.test;
import java.io.IOException;
import java.io.PrintWriter;
import java.net.URLDecoder;
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 ReadCookies
*/
@WebServlet("/ReadCookies")
public class ReadCookies extends HttpServlet {
private static final long serialVersionUID = 1L;
/**
* @see HttpServlet#HttpServlet()
*/
public ReadCookies() {
super();
// TODO Auto-generated constructor stub
}
/**
* @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
*/
public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
{
Cookie cookie = null;
Cookie[] cookies = null;
// 获取与该域相关的 Cookie 的数组
cookies = request.getCookies();
// 设置响应内容类型
response.setContentType("text/html;charset=UTF-8");
PrintWriter out = response.getWriter();
String title = "Delete Cookie Example";
String docType = "<!DOCTYPE html>\n";
out.println(docType +
"<html>\n" +
"<head><title>" + title + "</title></head>\n" +
"<body bgcolor=\"#F0F0F0\">\n" );
if( cookies != null ){
out.println("<h2>Cookie 名称和值</h2>");
for (int i = 0; i < cookies.length; i++){
cookie = cookies[i];
if((cookie.getName( )).compareTo("name") == 0 ){
cookie.setMaxAge(0);
response.addCookie(cookie);
out.print("已删除的 cookie:" +
cookie.getName( ) + "<br/>");
}
out.print("名称:" + cookie.getName( ) + ",");
out.print("值:" + URLDecoder.decode(cookie.getValue(), "utf-8") +" <br/>");
}
}else{
out.println(
"<h2 class=\"tutheader\">No Cookie founds</h2>");
}
out.println("</body>");
out.println("</html>");
}
/**
* @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)
*/
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// TODO Auto-generated method stub
doGet(request, response);
}
}
Скомпилируйте приведённый выше сервлетReadCookiesи создайте соответствующие записи в файле web.xml. Попробуйте запуститьhttp://localhost:8080/TomcatTest/ReadCookies, и будет отображён следующий результат:

Удаление куки с помощью сервлета
Удалить куки очень просто. Если вы хотите удалить куки, вам достаточно выполнить следующие три шага:
- Прочитать существующий cookie и сохранить его в объекте Cookie.
- Используйте методsetMaxAge(), чтобы установить возраст cookie равным нулю и удалить существующий cookie.
- Добавьте этот cookie в заголовок ответа.
Пример
Следующий пример удалит существующий cookie с именем "url". Когда вы в следующий раз запустите ReadCookies Servlet, он вернёт url как null.
package com.example.test;
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;
/**
* Servlet implementation class DeleteCookies
*/
@WebServlet("/DeleteCookies")
public class DeleteCookies extends HttpServlet {
private static final long serialVersionUID = 1L;
/**
* @see HttpServlet#HttpServlet()
*/
public DeleteCookies() {
super();
// TODO Auto-generated constructor stub
}
/**
* @see HttpServlet#doGet(HttpServletRequest request, HttpServletResponse response)
*/
public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
{
Cookie cookie = null;
Cookie[] cookies = null;
// 获取与该域相关的 Cookie 的数组
cookies = request.getCookies();
// 设置响应内容类型
response.setContentType("text/html;charset=UTF-8");
PrintWriter out = response.getWriter();
String title = "删除 Cookie 实例";
String docType = "<!DOCTYPE html>\n";
out.println(docType +
"<html>\n" +
"<head><title>" + title + "</title></head>\n" +
"<body bgcolor=\"#F0F0F0\">\n" );
if( cookies != null ){
out.println("<h2>Cookie 名称和值</h2>");
for (int i = 0; i < cookies.length; i++){
cookie = cookies[i];
if((cookie.getName( )).compareTo("url") == 0 ){
cookie.setMaxAge(0);
response.addCookie(cookie);
out.print("已删除的 cookie:" +
cookie.getName( ) + "<br/>");
}
out.print("名称:" + cookie.getName( ) + ",");
out.print("值:" + cookie.getValue( )+" <br/>");
}
}else{
out.println(
"<h2 class=\"tutheader\">No Cookie founds</h2>");
}
out.println("</body>");
out.println("</html>");
}
/**
* @see HttpServlet#doPost(HttpServletRequest request, HttpServletResponse response)
*/
protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
// TODO Auto-generated method stub
doGet(request, response);
}
}
Скомпилируйте вышеуказанный сервлетDeleteCookiesи создайте соответствующие записи в файле web.xml. Теперь запуститеhttp://localhost:8080/TomcatTest/DeleteCookies, и будет отображён следующий результат:
