專案中使用 sdmenu.js 時,需要在登入時清除它記住的狀態,但 sdmenu 預設會把狀態寫進 Cookie,而一般「過期即刪除」的寫法怎麼樣都刪不掉。這個問題背後其實藏著一個容易忽略的觀念。
document.cookie = "sdmenu_" + encodeURIComponent(this.menu.id) + "=" + states.join("") + "; expires=" + d.toGMTString() + "; path=/";
方法一,傳入名稱並把過期時間設為過去:
function deleteCookie(name){
var date = new Date();
date.setTime(date.getTime() - 10000);
document.cookie = name + "=v; expire=" + date.toGMTString() + "; path=/";
}
方法二,遍歷所有 Cookie 逐一刪除:
// js 遍歷所有 Cookie
function foreach()
{
var strCookie = document.cookie;
var arrCookie = strCookie.split("; "); // 將多 cookie 切割為多個名/值對
for(var i = 0; i < arrCookie.length; i++)
{
// 遍歷 cookie 陣列,處理每個 cookie 對
var arr = arrCookie[i].split("=");
if (arr.length > 0)
DelCookie(arr[0]);
}
}
function GetCooki(offset)
{
var endstr = document.cookie.indexOf(";", offset);
if (endstr == -1)
endstr = document.cookie.length;
return decodeURIComponent(document.cookie.substring(offset, endstr));
}
function DelCookie(name)
{
var exp = new Date();
exp.setTime(exp.getTime() - 1);
var cval = GetCookie(name);
document.cookie = name + "=" + cval + "; expires=" + exp.toGMTString();
}
function GetCookie(name)
{
var arg = name + "=";
var alen = arg.length;
var clen = document.cookie.length;
var i = 0;
while (i < clen)
{
var j = i + alen;
if (document.cookie.substring(i, j) == arg)
return GetCooki(j);
i = document.cookie.indexOf(" ", i) + 1;
if (i == 0) break;
}
return null;
}
兩種方法都刪不掉。後來看到一篇部落格文章講清楚了原因,原文大意如下。
名叫 username、網域為 www.45it.net 的 cookie 無論如何刪不掉,導致使用者登入後無法登出。折騰半天才發現,問題在於對 cookie 的基礎知識沒搞對。
Cookie 除了名稱與值,還有網域(domain)、過期時間(expires)、路徑(path)等屬性。其中,不同的網域、不同的路徑下,可以存在同樣名稱的 cookie。也就是說,同名 Cookie 可能同時有好幾份,各自活在不通的角落裡。
一般刪除 cookie 的做法,是用一個「同名、過期時間為過去」的 Cookie 去覆蓋它。此時就一定要確認要刪的那份 cookie 的網域與路徑——網域和路徑必須完全一致,才能被覆蓋掉。否則就會出現那個想要的刪除的 cookie 充滿生命力、怎麼樣都殺不死的神奇現象。
設定 Cookie 時如果沒有指定網域,那麼它的網域預設為當前網域,例如 www.45it.net。若設定時明確指定了某個網域,瀏覽器儲存時會自動在前面加上點,變成 .www.45it.net。例如:
setcookie('test', 'a', 0, '', 'www.45it.net');
瀏覽器裡存起來的網域就是 .www.45it.net。所以最保險的原則是:設定 Cookie 時怎麼寫,刪除時就怎麼寫。否則就會遇到這種情況——明明在瀏覽器裡看到 username=longbill、網域為 www.45it.net 的 Cookie,但寫:
setcookie('username', '', time() - 1000, '', 'www.45it.net');
卻刪不掉它。因為這行送出的其實是一個新的 Cookie:名叫 username、值為空、過期時間在過去 1000 秒、網域為 .www.45it.net、路徑為 /。這個 Cookie 一送到瀏覽器就立刻過期,什麼也看不到;而原本要刪的那個活在 www.45it.net 上的 Cookie,還活得好好的。
原來是刪除的程式碼裡少了路徑。對照一下就很清楚:
// 原本(設定時有 path)
document.cookie = "sdmenu_" + encodeURIComponent(this.menu.id) + "=" + states.join("") + "; expires=" + d.toGMTString() + "; path=/";
// 修正後(刪除時也要有 path)
var date = new Date();
date.setTime(date.getTime() - 10000);
document.cookie = name + "=v; expires=" + date.toGMTString() + "; path=/";
除了路徑,網域等其他屬性也可能造成同樣的問題。最保險的方式就是:設定 Cookie 時是什麼樣式,刪除時就應該是什麼樣式,再加上 expires 屬性。
第一,範例中的 expire= 是拼錯的,正確的屬性名稱是 expires。瀏覽器會忽略無法識別的屬性,所以寫錯時 Cookie 反而會變成「永久有效」,比刪不掉更麻煩。
第二,document.cookie 一次只能寫入一筆,而且讀取時拿到的是「名稱=值; 名稱=值」的合併字串,不含 path 與 domain 資訊——這正是問題難以察覺的原因。開發時請務必搭配開發者工具的 Application → Cookies 面板,直接看每份 Cookie 的 domain 與 path。
第三,前面那段 foreach 遍歷刪除的程式碼有個明顯缺陷:DelCookie 沒有帶 path,所以即使遍歷到全部名稱也一樣刪不掉,這與本文的主題完全吻合。此外它用 split("=") 切割,遇到值裡含 =(例如 base64)就會切錯,應改用 indexOf('=') 只切第一個。
第四,若 Cookie 帶有 HttpOnly 旗標,JavaScript 根本讀不到也刪不掉,只能由伺服器端處理。這也是安全性上的設計,遇到這種情況請確認是不是這個原因。