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

转载

javascript 设置 cookie

设置 cookie

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

1
2
document.cookie
document.cookie="userId=828";

如果要一次存储多个名 / 值对,可以使用分号加空格(;)隔开,例如:

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

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

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

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

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

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

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

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

1
document.cookie="userId=929";

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

获取 cookie 的值

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

1
var strCookie=document.cookie;

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

1
2
3
4
document.cookie="userId=828";
document.cookie="userName=yaoqs";
var strCookie=document.cookie;
alert(strCookie);

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
//设置两个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 常常需要长期保存,例如保存用户登录的状态。这可以用下面的选项来实现:

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

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

1
2
3
4
5
6
7
//获取当前时间
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,可以将其过期时间设定为一个过去的时间,例如:

1
2
3
4
5
6
7
8
9
//获取当前时间

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

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

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

指定可访问 cookie 的路径

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

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

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

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

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

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

指定可访问 cookie 的主机名

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

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

以 google 为例,要实现跨主机访问,可以写为:

1
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 自动消失。该函数实现如下:
1
2
3
4
5
6
7
8
9
10
11
12
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;
}
  1. 获取指定名称的 cookie 值:getCookie (name)
    该函数返回名称为 name 的 cookie 值,如果不存在则返回空,其实现如下:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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;
}
  1. 删除指定名称的 cookie:deleteCookie (name)
    该函数可以删除指定名称的 cookie,其实现如下:
1
2
3
4
5
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 的基本知识。

1
2
  每个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)”,结果显示:

1
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。赋值的格式:

1
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 个月后过期。

1
2
3
4
5
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 的值。

1
2
3
4
5
6
7
8
9
10
11
12
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。

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

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

References