在純前端開發裡,需要把一些輕量狀態暫存在瀏覽器時,Cookie 仍然是最直覺的選擇。jQuery Cookie 插件把原生 document.cookie 那套繁瑣的字串拼接與解析封裝成一行 API,讓讀寫 Cookie 變得像操作物件屬性一樣自然。以下從常用寫法談到原始碼,並對照 Discuz! 的實作做個比較。
寫入最簡單的形式只需要名稱與值:
$.cookie('name', 'value');
若要一次指定有效期、路徑、網域與安全性傳輸,第三個參數傳入設定物件即可:
$.cookie('name', 'value', {
expires: 7, // 有效天數
path: '/', // 作用路徑
domain: 'jquery.com',// 作用網域
secure: true // 僅在 HTTPS 下傳送
});
刪除的做法是把值設為 null,插件會自動把過期時間設為過去,等價於「立即失效」:
$.cookie('name', null);
讀取則只傳名稱,回傳值就是字串或 null:
var account = $.cookie('name');
理解實作有助於避坑。整個插件其實就是一個掛在 jQuery 上的函式,靠「有沒有傳第二個參數」來判斷是寫入還是讀取:
jQuery.cookie = function(name, value, options) {
if (typeof value != 'undefined') { // 有 value:設定 cookie
options = options || {};
if (value === null) { // 傳 null 視為刪除
value = '';
options.expires = -1;
}
var expires = '';
if (options.expires && (typeof options.expires == 'number' || options.expires.toUTCString)) {
var date;
if (typeof options.expires == 'number') {
date = new Date();
date.setTime(date.getTime() + (options.expires * 24 * 60 * 60 * 1000));
} else {
date = options.expires;
}
expires = '; expires=' + date.toUTCString(); // 只用 expires,max-age 在舊 IE 不受支援
}
var path = options.path ? '; path=' + options.path : '';
var domain = options.domain ? '; domain=' + options.domain : '';
var secure = options.secure ? '; secure' : '';
document.cookie = [name, '=', encodeURIComponent(value), expires, path, domain, secure].join('');
} else { // 只有 name:讀取 cookie
var cookieValue = null;
if (document.cookie && document.cookie != '') {
var cookies = document.cookie.split(';');
for (var i = 0; i < cookies.length; i++) {
var cookie = jQuery.trim(cookies[i]);
if (cookie.substring(0, name.length + 1) == (name + '=')) {
cookieValue = decodeURIComponent(cookie.substring(name.length + 1));
break;
}
}
}
return cookieValue;
}
};
幾個值得注意的細節:值在寫入時經過 encodeURIComponent,讀出時再用 decodeURIComponent 還原,因此中文與特殊字元不會出問題;判斷名稱時用 name + '=' 前綴比對,避免 user 誤配到 username;有效期優先採用 expires 而非 max-age,是為了相容舊版 IE。
Discuz! 自己寫了一組更精簡的版本,用 indexOf 直接定位名稱,省下了遍歷陣列與 trim 的開銷:
function getcookie(name) {
var cookie_start = document.cookie.indexOf(name);
var cookie_end = document.cookie.indexOf(";", cookie_start);
return cookie_start == -1 ? '' : unescape(document.cookie.substring(
cookie_start + name.length + 1,
(cookie_end > cookie_start ? cookie_end : document.cookie.length)
));
}
function setcookie(cookieName, cookieValue, seconds, path, domain, secure) {
var expires = new Date();
expires.setTime(expires.getTime() + seconds);
document.cookie = escape(cookieName) + '=' + escape(cookieValue)
+ (expires ? '; expires=' + expires.toGMTString() : '')
+ (path ? '; path=' + path : '/')
+ (domain ? '; domain=' + domain : '')
+ (secure ? '; secure' : '');
}
兩者最大差異在時間單位:插件用「天」,Discuz! 用「秒」。另外 Discuz! 版本沒有做名稱邊界比對,在多個名稱重複前綴的場景下容易誤取;而 jQuery 插件改用 encodeURIComponent,比已逐漸被棄用的 escape 更合適處理 UTF-8 中文。實務上可以依專案既有慣例擇一,重點是同一個站內不要混用兩套編碼方式,否則讀出來會是亂碼。