DIV CSS 佈局教程網

JavaScript 操作 Cookie 的完整工具函式集
編輯:關於JavaScript     

Cookie 的 API 只有一個 document.cookie,字串讀寫全靠手動解析,每次專案重寫一遍很麻煩。以下整理成一套可直接複用的工具函式,涵蓋設定、刪除、清空、存在性檢查、依名稱取值、依值反查名稱,以及把全部 Cookie 格式化輸出的功能。

寫入、刪除與清空

/**
 * 設定 Cookie
 * @param name    名稱(呼叫端需自行 trim)
 * @param value   值(會做 encode)
 * @param expires 有效天數
 * @param path    路徑
 * @param domain  網域
 * @param secure  是否只走 HTTPS
 */
var SetCookie = function (name, value, expires, path, domain, secure) {
    var expires_date;
    if (expires) {
        expires_date = new Date();
        expires_date.setDate(expires_date.getDate() + expires);
    }
    document.cookie = encodeURIComponent(name) + "=" + encodeURIComponent(value)
        + ((expires) ? ";expires=" + expires_date.toUTCString() : "")
        + ((path)    ? ";path=" + path   : "")
        + ((domain)  ? ";domain=" + domain : "")
        + ((secure)  ? ";secure" : "");
};

/** 刪除單一 Cookie:把過期時間設為過去即可 */
var DeleteCookie = function (name, path, domain) {
    document.cookie = encodeURIComponent(name) + "="
        + ((path)   ? ";path=" + path   : "")
        + ((domain) ? ";domain=" + domain : "")
        + ";expires=Fri, 01-Jan-2010 00:00:01 UTC";
};

/** 清空所有 Cookie */
var DelAllCookies = function () {
    var currDate = new Date().toUTCString();
    var theCookie = document.cookie.split(";");
    var i = theCookie.length;
    while (i--) {
        document.cookie = theCookie[i] + "; expires=" + currDate;
    }
};

/** 輔助:把字串中的正則特殊字元轉義 */
var EscapeReg = function (str) {
    return str.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
};

查詢與取值(皆為不分大小寫)

/** 某個名稱是否存在 */
var CNameExists = function (cookie_name) {
    if (document.cookie.length == 0) return false;
    var testName = EscapeReg(cookie_name);
    var myReg = new RegExp('(^|;) ?' + testName + '=([^;]*)(;|$)', 'i');
    return myReg.test(decodeURIComponent(document.cookie));
};

/** 某個值是否存在 */
var CValueExists = function (cookie_value) {
    if (document.cookie.length == 0) return false;
    var testName = EscapeReg(cookie_value);
    var myReg = new RegExp('(=)' + testName + '(;|$)', 'i');
    return myReg.test(decodeURIComponent(document.cookie));
};

/** 依值反查名稱 */
var CNameGet = function (cookie_value) {
    if (document.cookie.length == 0) return '';
    var testName = EscapeReg(cookie_value);
    var myReg = new RegExp('(^|;) ?([^=]*)=' + testName + '(;|$)', 'i');
    var results = decodeURIComponent(document.cookie).match(myReg);
    return (results) ? results[2] : '';
};

/** 依名稱取值 */
var CValueGet = function (cookie_name) {
    if (document.cookie.length == 0) return '';
    var testName = EscapeReg(cookie_name);
    var myReg = new RegExp('(^|;) ?' + testName + '=([^;]*)(;|$)', 'i');
    var results = decodeURIComponent(document.cookie).match(myReg);
    return (results) ? results[2] : '';
};

/** 把全部 Cookie 輸出成「名稱 (值)」的清單字串 */
var CookieStr = function () {
    return decodeURIComponent(document.cookie)
        .replace(/([^=;]+)=([^;]*)[;\s]*/g, '$1 ($2)\n') || '';
};

使用要點

正則的錨點是關鍵。'(^|;) ?' + name + '=' 這個寫法能避免 uid 誤抓到 myuid;再加上 EscapeReg 轉義特殊字元,名稱裡出現 .、? 也不會出錯。

刪除的原理是過期。Cookie 沒有 delete 方法,把 expires 設成過去時間,瀏覽器就會視為失效。注意 path 與 domain 必須和寫入時一致,否則刪不掉。

編碼不要省。名稱與值都用 encodeURIComponent 處理,中文和分號、等號等保留字元才不會破壞 Cookie 的字串結構。

最後提醒,Cookie 不適合存放敏感資料,容量也僅約 4KB。若只是要暫存前端狀態,優先考慮 localStorage 或 sessionStorage;需要跨站維持登入狀態時,也別忘了設定 Secure 與 SameSite 屬性來降低被竊取的風險。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved