Cookie专题

---

Abstract

1. javascript设置cookie
   1. 设置cookie
   2. 获取cookie的值
   3. 删除cookie
   4. 指定可访问cookie的路径
   5. 指定可访问cookie的主机名
   6. 综合示例

Keywords 专题  Javascript  专题 

---

Citation Yao Qing-sheng.Cookie专题.FUTURE & CIVILIZATION Natural/Social Philosophy & Infomation Sciences,20250114. https://yaoqs.github.io/20250114/cookie-zhuan-ti/

---

转载

javascript设置cookie

※设置cookie

每个cookie都是一个名/值对，可以把下面这样一个字符串赋值给

document.cookie：
document.cookie="userId=828";

如果要一次存储多个名/值对，可以使用分号加空格（;）隔开，例如：

document.cookie="userId=828;userName=yaoqs";

在cookie的名或值中不能使用分号（;）、逗号（,）、等号（=）以及空格。在cookie的名中做到这点很容易，但要保存的值是不确定的。如何来存储这些值呢？方法是用escape()函数进行编码，它能将一些特殊符号使用十六进制表示，例如空格将会编码为“20%”，从而可以存储于cookie值中，而且使用此种方案还可以避免中文乱码的出现。例如：

document.cookie="str="+escape("Iloveajax");
相当于：
document.cookie="str=I%20love%20ajax";

当使用escape()编码后，在取出值以后需要使用unescape()进行解码才能得到原来的cookie值。尽管document.cookie看上去就像一个属性，可以赋不同的值。但它和一般的属性不一样，改变它的赋值并不意味着丢失原来的值，例如连续执行下面两条语句：

document.cookie="userId=828";
document.cookie="userName=yaoqs";

这时浏览器将维护两个cookie，分别是userId和userName，因此给document.cookie赋值更像执行类似这样的语句：

document.addCookie("userId=828");
document.addCookie("userName=yaoqs");

事实上，浏览器就是按照这样的方式来设置cookie的，如果要改变一个cookie的值，只需重新赋值，例如：

document.cookie="userId=929";

这样就将名为userId的cookie值设置为了929。

※获取cookie的值

下面介绍如何获取cookie的值。cookie的值可以由document.cookie直接获得：

var strCookie=document.cookie;

这将获得以分号隔开的多个名/值对所组成的字符串，这些名/值对包括了该域名下的所有cookie

document.cookie="userId=828";
document.cookie="userName=yaoqs";
var strCookie=document.cookie;
alert(strCookie);

名称来获得指定的值，这正是处理cookie值最麻烦的一部分。用户必须自己分析这个字符串，来获取指定的cookie值，例如，要获取userId的值，可以这样实现：

//设置两个cookie
document.cookie="userId=828";
document.cookie="userName=yaoqs";
//获取cookie字符串
var strCookie=document.cookie;
//将多cookie切割为多个名/值对
var arrCookie=strCookie.split(";");
var userId;
//遍历cookie数组，处理每个cookie对
for(vari=0;i<arrCookie.length;i++){
  var arr=arrCookie[i].split("=");
  //找到名称为userId的cookie，并返回它的值
  if("userId"==arr[0]){
  userId=arr[1];
  break;
  }
}
alert(userId);

用类似的方法，可以获取一个或多个cookie的值，其主要的技巧仍然是字符串和数组的相关操作.给cookie设置终止日期到现在为止，所有的cookie都是单会话cookie，即浏览器关闭后这些cookie将会丢失，事实上这些cookie仅仅是存储在内存中，而没有建立相应的硬盘文件。在实际开发中，cookie常常需要长期保存，例如保存用户登录的状态。这可以用下面的选项来实现：

document.cookie="userId=828;expires=GMT_String";

其中GMT_String是以GMT格式表示的时间字符串，这条语句就是将userId这个cookie设置为GMT_String表示的过期时间，超过这个时间，cookie将消失，不可访问。例如：如果要将cookie设置为10天后过期，可以这样实现：

//获取当前时间
vardate=newDate();
varexpireDays=10;
//将date设置为10天以后的时间
date.setTime(date.getTime()+expireDays*24*3600*1000);
//将userId和userName两个cookie设置为10天后过期
document.cookie="userId=828;userName=yaoqs;expire="+date.toGMTString();

※删除cookie

为了删除一个cookie，可以将其过期时间设定为一个过去的时间，例如：

//获取当前时间

vardate=newDate();
//将date设置为过去的时间

date.setTime(date.getTime()-10000);
//将userId这个cookie删除

document.cookie="userId=828;expire="+date.toGMTString();

※指定可访问cookie的路径

默认情况下，如果在某个页面创建了一个cookie，那么该页面所在目录中的其他页面也可以访问该cookie。如果这个目录下还有子目录，则在子目录中也可以访问。。为了控制cookie可以访问的目录，需要使用path参数设置cookie，语法如下：

document.cookie="name=value;path=cookieDir";

其中cookieDir表示可访问cookie的目录。例如：

document.cookie="userId=320;path=/shop";

就表示当前cookie仅能在shop目录下使用。如果要使cookie在整个网站下可用，可以将cookie_dir指定为根目录，例如：

document.cookie="userId=320;path=/";

※指定可访问cookie的主机名

和路径类似，主机名是指同一个域下的不同主机。默认情况下，一个主机中创建的cookie在另一个主机下是不能被访问的，但可以通过domain参数来实现对其的控制，其语法格式为：

document.cookie="name=value;domain=cookieDomain";

以google为例，要实现跨主机访问，可以写为：

document.cookie="name=value;domain=.google.com";

这样，所有google.com下的主机都可以访问该cookie。

※综合示例

构造通用的cookie处理函数cookie的处理过程比较复杂，并具有一定的相似性。因此可以定义几个函数来完成cookie的通用操作，从而实现代码的复用。下面列出了常用的cookie操作及其函数实现。

1. 添加一个cookie：addCookie(name,value,expireHours)
   该函数接收3个参数：cookie名称，cookie值，以及在多少小时后过期。这里约定expireHours为0时不设定过期时间，即当浏览器关闭时cookie自动消失。该函数实现如下：

function addCookie(name,value,expireHours){
var cookieString=name+"="+escape(value);
//判断是否设置过期时间


if(expireHours>0){
var date=newDate();
date.setTime(date.getTime+expireHours*3600*1000);
cookieString=cookieString+";expire="+date.toGMTString();
}
document.cookie=cookieString;
}

2. 获取指定名称的cookie值：getCookie(name)
   该函数返回名称为name的cookie值，如果不存在则返回空，其实现如下：

function getCookie(name){
var strCookie=document.cookie;
var arrCookie=strCookie.split(";");
for(vari=0;i<arrCookie.length;i++){
var arr=arrCookie[i].split("=");
if(arr[0]==name)returnarr[1];
}
return "";
}

function getCookie(cookie_name){
var results=document.cookie.match('(^|;)?'+cookie_name+'=([^;]*)(;|$)');

if(results)
return(unescape(results[2]));
else
return null;
}

3. 删除指定名称的cookie：deleteCookie(name)
   该函数可以删除指定名称的cookie，其实现如下：

function deleteCookie(name){
var date=newDate();
date.setTime(date.getTime()-10000);
document.cookie=name+"=v;expire="+date.toGMTString();
}

我们已经知道，在document对象中有一个cookie属性。但是Cookie又是什么？“某些Web站点在您的硬盘上用很小的文本文件存储了一些信息，这些文件就称为Cookie。”——MSIE帮助。一般来说，Cookies是CGI或类似，比HTML高级的文件、程序等创建的，但是javascript也提供了对Cookies的很全面的访问权利。

我们先要学一学Cookie的基本知识。

　　每个Cookie都是这样的：< cookie名 >=< 值 >
　　< cookie名 >的限制与javascript的命名限制大同小异，少了“不能用javascript关键字”，多了“只能用可以用在URL编码中的字符”。后者比较难懂，但是只要你只用字母和数字命名，就完全没有问题了。<值>的要求也是“只能用可以用在URL编码中的字符”。

每个Cookie都有失效日期，一旦电脑的时钟过了失效日期，这个Cookie就会被删掉。我们不能直接删掉一个Cookie，但是可以用设定失效日期早于现在时刻的方法来间接删掉它。

每个网页，或者说每个站点，都有它自己的Cookies，这些Cookies只能由这个站点下的网页来访问，来自其他站点或同一站点下未经授权的区域的网页，是不能访问的。每一“组”Cookies有规定的总大小（大约2KB每“组”），一超过最大总大小，则最早失效的Cookie先被删除，来让新的Cookie“安家”。

现在我们来学习使用documents.cookie属性。

如果直接使用documents.cookie属性，或者说，用某种方法，例如给变量赋值，来获得documents.cookie的值，我们就可以知道在现在的文档中有多少个Cookies，每个Cookies的名字，和它的值。例如，在某文档中添加“document.write(documents.cookie)”，结果显示：

name=yaoqs;email=yaoqs@yaoqs.com;lastvisited=index.html

这意味着，文档包含3个Cookies：name,email和lastvisited。可以看到，两个Cookies之间是用分号和空格隔开的，于是我们可以用cookieString.split(‘;’)方法得到每个Cookie分开的一个数组（先用varcookieString=documents.cookie）。

设定一个Cookie的方法是对documents.cookie赋值。与其它情况下的赋值不同，向documents.cookie赋值不会删除掉原有的Cookies，而只会增添Cookies或更改原有Cookie。赋值的格式：

documents.cookie='cookieName='+escape('cookievalue')+';expires='+expirationDateObj.toGMTString();

是不是看到头晕了呢？cookieName表示Cookie的名称，cookievalue表示Cookie的值，expirationDateObj表示储存着失效日期的日期对象名，如果不需要指定失效日期，则不需要第二行。不指定失效日期，则浏览器默认是在关闭浏览器（也就是关闭所有窗口）之后过期。

首先escape()方法：为什么一定要用？因为Cookie的值的要求是“只能用可以用在URL编码中的字符”。我们知道“escape()”方法是把字符串按URL编码方法来编码的，那我们只需要用一个“escape()”方法来处理输出到Cookie的值，用“unescape()”来处理从Cookie接收过来的值就万无一失了。而且这两个方法的最常用途就是处理Cookies。其实设定一个Cookie只是“documents.cookie=‘cookieName=cookievalue’”这么简单，但是为了避免在cookievalue中出现URL里不准出现的字符，还是用一个escape()好。　　然后“expires”前面的分号：注意到就行了。是分号而不是其他。　　最后toGMTString()方法：设定Cookie的时效日期都是用GMT格式的时间的，其它格式的时间是没有作用的。

现在我们来实战一下。设定一个“name=rose”的Cookie，在3个月后过期。

var expires=newDate();
expires.setTime(expires.getTime()+3*30*24*60*60*1000);
/*三个月x一个月当作30天x一天24小时
x一小时60分x一分60秒x一秒1000毫秒*/
documents.cookie='name=rose;expires='+expires.toGMTString();

为什么没有用escape()方法？这是因为我们知道rose是一个合法的URL编码字符串，也就是说，‘rose’==escape(‘rose’)。一般来说，如果设定Cookie时不用escape()，那获取Cookie时也不用unescape()。

再来一次：编写一个函数，作用是查找指定Cookie的值。

function getCookie(cookieName){
var cookieString=documents.cookie;
var start=cookieString.indexOf(cookieName+'=');
//加上等号的原因是避免在某些Cookie的值里有
//与cookieName一样的字符串。
if(start==-1)//找不到
return null;
start+=cookieName.length+1;
var end=cookieString.indexOf(';',start);
if(end==-1)returnunescape(cookieString.substring(start));
returnunescape(cookieString.substring(start,end));
}

这个函数用到了字符串对象的一些方法，如果你不记得了（你是不是这般没记性啊），请快去查查。这个函数所有的if语句都没有带上else，这是因为如果条件成立，程序运行的都是return语句，在函数里碰上return，就会终止运行，所以不加else也没问题。该函数在找到Cookie时，就会返回Cookie的值，否则返回“null”。

现在我们要删除刚才设定的name=roseCookie。

var expires=newDate();
expires.setTime(expires.getTime()-1);
documents.cookie='name=rose;expires='+expires.toGMTString();

可以看到，只需要把失效日期改成比现在日期早一点（这里是早1毫秒），再用同样的方法设定Cookie，就可以删掉Cookie了。

References

---

*Corresponding Author: Yao Qing-sheng <Email: 350788415@qq.com> BY-NC-SA .

1. Yao Qing-sheng.Cookie专题.FUTURE & CIVILIZATION.Natural/Social Philosophy & Infomation Sciences,20250114.https://yaoqs.github.io/20250114/cookie-zhuan-ti/
2. 版权声明：本文为「LordYao」的原创文章，遵循 CC 4.0 BY-NC-SA 版权协议，转载请附上原文出处链接及本声明。
   原文链接： https://yaoqs.github.io/20250114/cookie-zhuan-ti/