Servlet Manejo de cookies

Las cookies son archivos de texto almacenados en la computadora del cliente y conservan diversa información de seguimiento. Java Servlet, obviamente, admite las cookies HTTP.

Identificar a los usuarios que regresan incluye tres pasos:

  • El script del servidor envía un conjunto de cookies al navegador. Por ejemplo: nombre, edad o número de identificación, etc.
  • El navegador almacena esta información en la computadora local para uso futuro.
  • La próxima vez que el navegador envíe cualquier solicitud al servidor web, el navegador enviará esta información de cookies al servidor, y el servidor utilizará esta información para identificar al usuario.

Este capítulo le explicará cómo configurar o restablecer cookies, cómo acceder a ellas y cómo eliminarlas.

El manejo de cookies de Servlet requiere codificar y decodificar el chino; el método es el siguiente:

String   str   =   java.net.URLEncoder.encode("中文","UTF-8");            //编码
String   str   =   java.net.URLDecoder.decode("编码后的字符串","UTF-8");   // 解码

Análisis de cookies

Las cookies generalmente se establecen en la información del encabezado HTTP (aunque JavaScript también puede establecer una cookie directamente en el navegador). El Servlet que establece la cookie enviará la siguiente información de encabezado:

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

Como puede ver, el encabezado Set-Cookie contiene un par de nombre y valor, una fecha GMT, una ruta y un dominio. El nombre y el valor se codifican en URL. El campo expires es una directiva que le dice al navegador que "olvide" la cookie después de la fecha y hora dadas.

Si el navegador está configurado para almacenar cookies, conservará esta información hasta la fecha de vencimiento. Si el navegador del usuario apunta a cualquier página que coincida con la ruta y el dominio de esa cookie, reenviará la cookie al servidor. La información del encabezado del navegador podría verse así:

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

El Servlet puede entonces, a través del método de solicitudrequest.getCookies()acceder a las cookies; este método devolverá unCookiearray de objetos.

Métodos de cookies de Servlet

La siguiente es una lista de métodos útiles que se pueden utilizar al manipular cookies en Servlet.

N.ºMétodo & descripción
1public void setDomain(String pattern)
Este método establece el dominio al que se aplica la cookie, por ejemplo, example.com.
2public String getDomain()
Este método obtiene el dominio al que se aplica la cookie, por ejemplo, example.com.
3public void setMaxAge(int expiry)
Este método establece el tiempo de expiración de la cookie (en segundos). Si no se configura de esta manera, la cookie solo será válida durante la sesión actual.
4public int getMaxAge()
Este método devuelve el ciclo de vida máximo de la cookie (en segundos). De forma predeterminada, -1 indica que la cookie persistirá hasta que se cierre el navegador.
5public String getName()
Este método devuelve el nombre de la cookie. El nombre no se puede cambiar después de crearse.
6public void setValue(String newValue)
Este método establece el valor asociado con la cookie.
7public String getValue()
Este método obtiene el valor asociado con la cookie.
8public void setPath(String uri)
Este método establece la ruta a la que se aplica la cookie. Si no especifica una ruta, todas las URL en el mismo directorio que la página actual (incluidos los subdirectorios) devolverán la cookie.
9public String getPath()
Este método obtiene la ruta a la que se aplica la cookie.
10public void setSecure(boolean flag)
Este método establece un valor booleano que indica si la cookie solo debe enviarse a través de conexiones cifradas (es decir, SSL).
11public void setComment(String purpose)
Establece el comentario de la cookie. Este comentario es muy útil cuando el navegador presenta la cookie al usuario.
12public String getComment()
Obtiene el comentario de la cookie; si la cookie no tiene comentario, devuelve null.

Configurar cookies mediante Servlet

Configurar cookies mediante Servlet incluye tres pasos:

(1) Crear un objeto Cookie:Puede llamar al constructor de Cookie con el nombre de la cookie y el valor de la cookie; tanto el nombre como el valor de la cookie son cadenas.

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

Recuerde que ni el nombre ni el valor deben contener espacios ni ninguno de los siguientes caracteres:

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

(2) Establecer el ciclo de vida máximo:Puede utilizar el método setMaxAge para especificar el tiempo durante el cual la cookie puede permanecer válida (en segundos). A continuación, se establecerá una cookie con un período de validez máximo de 24 horas.

cookie.setMaxAge(60*60*24); 

(3) Enviar la cookie al encabezado de respuesta HTTP:Puede utilizarresponse.addCookiepara agregar la cookie al encabezado de respuesta HTTP, de la siguiente manera:

response.addCookie(cookie);

Ejemplo

Modifiquemos nuestroejemplo de datos de formulario, para configurar cookies para el nombre y el apellido.

package com.ejemplo.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);
    }

}

Compile el Servlet anteriorHelloForm, y cree las entradas apropiadas en el archivo web.xml:

<?xml version="1.0" encoding="UTF-8"?>
<web-app>
  <servlet> 
    <!-- 类名 -->  
    <servlet-name>HelloForm</servlet-name>
    <!-- 所在的包 -->
    <servlet-class>com.ejemplo.test.HelloForm</servlet-class>
  </servlet>
  <servlet-mapping>
    <servlet-name>HelloForm</servlet-name>
    <!-- 访问的网址 -->
    <url-pattern>/TomcatTest/HelloForm</url-pattern>
  </servlet-mapping>
</web-app>
Finalmente, pruebe la siguiente página HTML para invocar el Servlet.
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Ejemplo(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>

Guarde el contenido HTML anterior en el archivo /TomcatTest/test.html.

A continuación, accedemos a http://localhost:8080/TomcatTest/test.html, la demostración en Gif es la siguiente:

Nota:Algunas de las rutas anteriores deben modificarse según la ruta real de su proyecto.

Leer cookies mediante Servlet

Para leer las cookies, debe llamar alHttpServletRequestdegetCookies( )método para crear unjavax.servlet.http.Cookiearray de objetos. Luego recorra el array y utilice los métodos getName() y getValue() para acceder a cada cookie y a sus valores asociados.

Ejemplo

Leamos las cookies configuradas en el ejemplo anterior.

package com.ejemplo.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);
    }

}

Compile el Servlet anteriorReadCookies, y cree las entradas apropiadas en el archivo web.xml. Intente ejecutarhttp://localhost:8080/TomcatTest/ReadCookies, se mostrará el siguiente resultado:


Eliminar cookies mediante Servlet

Eliminar cookies es muy sencillo. Si desea eliminar una cookie, solo necesita seguir los siguientes tres pasos:

  • Lea una cookie existente y almacénela en un objeto Cookie.
  • UtilicesetMaxAge()el método para establecer la edad de la cookie en cero, eliminando así la cookie existente.
  • Agregue esta cookie al encabezado de respuesta.

Ejemplo

El siguiente ejemplo eliminará la cookie existente llamada "url". Cuando ejecute el Servlet ReadCookies la próxima vez, devolverá url como null.

package com.ejemplo.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);
    }

}

Compile el Servlet anteriorDeleteCookies, y cree las entradas apropiadas en el archivo web.xml. Ahora ejecutehttp://localhost:8080/TomcatTest/DeleteCookies, se mostrará el siguiente resultado:

Otras extensiones