DIV CSS 佈局教程網

JavaScript 實現 Cookie 的設定、讀取與刪除完整範例
編輯:關於JavaScript     

把 Cookie 操作封裝成三個函式,是每個前端專案都會用到的基礎工具。以下版本把 expires、path、domain、secure 四個常見參數都開放出來,彈性較高。

/*
 * 設定 Cookie
 * @param name    Cookie 的名稱
 * @param value   Cookie 的值
 * @param expires 有效時間(秒)
 * @param path    可存取的路徑
 * @param domain  可存取的主機名
 * @param secure  是否僅透過 HTTPS 傳輸
 */
function setCookie(name, value, expires, path, domain, secure) {
    // 組出基本的名/值對
    var str = name + "=" + escape(value);

    // 設定有效期,單位為秒
    if (expires > 0) {
        var date = new Date();
        var ms = expires * 1000;
        date.setTime(date.getTime() + ms);
        str += "; expires=" + date.toGMTString();
    }
    if (path)   { str += "; path=" + path; }
    if (domain) { str += "; domain=" + domain; }
    if (secure) { str += "; secure"; }

    document.cookie = str;
}

/*
 * 取得 Cookie
 * @param cookie_name 要讀取的 Cookie 名稱
 * @return 對應的值,不存在時回傳 null
 */
function getCookie(cookie_name) {
    var value = null;
    var allcookies = document.cookie;
    var cookie_pos = allcookies.indexOf(cookie_name);

    // 找到索引代表存在,反之則不存在
    if (cookie_pos != -1) {
        // 跳過名稱與等號,指向值的起點
        cookie_pos += cookie_name.length + 1;
        var cookie_end = allcookies.indexOf(";", cookie_pos);
        if (cookie_end == -1) {
            cookie_end = allcookies.length;
        }
        value = unescape(allcookies.substring(cookie_pos, cookie_end));
    }
    return value;
}

/*
 * 刪除 Cookie
 * @param cookie_name 要刪除的 Cookie 名稱
 */
function delCookie(cookie_name) {
    var exp = new Date();
    exp.setTime(exp.getTime() - 1);       // 設為過去時間即失效
    var value = getCookie(cookie_name);
    if (value) {
        document.cookie = cookie_name + "=" + value + "; expires=" + exp.toGMTString();
    }
}

使用方式

setCookie("token", "abc123", 3600, "/");   // 一小時後過期,全站可用
var token = getCookie("token");
delCookie("token");

兩個實務提醒

一、關於 escape / unescape:這兩個函式已被標記為不建議使用(尤其是 escape 對非 ASCII 字元的處理在新式瀏覽器中並不可靠)。建議改用 encodeURIComponent() 與 decodeURIComponent(),對中文與特殊符號的處理更完備。

二、getCookie 的比對方式:用 indexOf 做前綴比對時,若同時存在 user 與 userName,查詢 user 可能誤中 userName。更嚴謹的做法是先 split("; ") 再用 === 精確比對名稱。

另外,若要在 Node 或打包工具環境使用,也可直接採用 js-cookie 這個成熟函式庫,API 更簡潔且已處理好上述細節。

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