DIV CSS 佈局教程網

JavaScript 操作 Cookie:設定、讀取與清除的完整範例
編輯:關於JavaScript     

JavaScript 跑在用戶端,因此天生無法設定 Session——Session 屬於伺服器端的機制。相對地,Cookie 存活在瀏覽器裡,正好可以由 JS 直接讀寫。本文整理三種常見的 Cookie 操作寫法,並說明幾個容易忽略的細節。

寫法一:以 name / value / 天數為參數

這是最直觀的封装:設定時把「有效天數」換算成過期時間,讀取時以分號切開 document.cookie 逐筆比對,清除則是把過期時間設為負數。

 <script>
// 設定 cookie
function setCookie(cname, cvalue, exdays) {
    var d = new Date();
    d.setTime(d.getTime() + (exdays * 24 * 60 * 60 * 1000));
    var expires = "expires=" + d.toUTCString();
    document.cookie = cname + "=" + cvalue + "; " + expires;
}

// 取得 cookie
function getCookie(cname) {
    var name = cname + "=";
    var ca = document.cookie.split(';');
    for (var i = 0; i < ca.length; i++) {
        var c = ca[i];
        while (c.charAt(0) == ' ') c = c.substring(1);   // 去掉前導空白
        if (c.indexOf(name) != -1) return c.substring(name.length, c.length);
    }
    return "";
}

// 清除 cookie
function clearCookie(name) {
    setCookie(name, "", -1);
}

function checkCookie() {
    var user = getCookie("username");
    if (user != "") {
        alert("Welcome again " + user);
    } else {
        user = prompt("Please enter your name:", "");
        if (user != "" && user != null) {
            setCookie("username", user, 365);
        }
    }
}
checkCookie();
</script>

寫法二:用正則表達式比對

用 new RegExp("(^| )" + name + "=([^;]*)(;|$)") 直接對 document.cookie 做 match,程式碼更短。這裡的 (^| ) 很重要,可以防止 uid 誤配到 userid。此外用 escape()/unescape() 編解碼,能避免值裡含有分號或空白時破壞格式。

 <script>
// 寫 cookies
function setCookie(c_name, value, expiredays) {
    var exdate = new Date();
    exdate.setDate(exdate.getDate() + expiredays);
    document.cookie = c_name + "=" + escape(value)
        + ((expiredays == null) ? "" : ";expires=" + exdate.toGMTString());
}

// 讀取 cookies
function getCookie(name) {
    var arr, reg = new RegExp("(^| )" + name + "=([^;]*)(;|$)");
    if (arr = document.cookie.match(reg)) return (arr[2]);
    else return null;
}

// 刪除 cookies
function delCookie(name) {
    var exp = new Date();
    exp.setTime(exp.getTime() - 1);
    var cval = getCookie(name);
    if (cval != null) document.cookie = name + "=" + cval + ";expires=" + exp.toGMTString();
}

// 使用示例
setCookie('username', 'Darren', 30);
alert(getCookie("username"));
</script>

補充一點:escape() 已被標準標記為不建議使用,遇到中文時它會產生 %uXXXX 這種非標準編碼,解碼時容易出錯。建議改用 encodeURIComponent() 與 decodeURIComponent(),編碼規則符合 RFC,跨語言(例如後端 PHP、Java)互通時才不會出問題。

寫法三:搭配表單的完整操作介面

以下範例做了一個小頁面,可以輸入名稱、值與過期小時數,並提供新增、讀取、刪除三個按鈕,適合直接當測試工具使用。

 <html>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<head>
<script language="JavaScript" type="text/javascript">
function addCookie(objName, objValue, objHours) {   // 添加 cookie
    var str = objName + "=" + escape(objValue);
    if (objHours > 0) {
        // 為 0 時不設定過期時間,瀏覽器關閉時 cookie 自動消失
        var date = new Date();
        var ms = objHours * 3600 * 1000;
        date.setTime(date.getTime() + ms);
        str += "; expires=" + date.toGMTString();
    }
    document.cookie = str;
    alert("添加 cookie 成功");
}

function getCookie(objName) {   // 獲取指定名稱的 cookie 值
    var arrStr = document.cookie.split("; ");
    for (var i = 0; i < arrStr.length; i++) {
        var temp = arrStr[i].split("=");
        if (temp[0] == objName) return unescape(temp[1]);
    }
}

function delCookie(name) {   // 將過期時間設為過去即可刪除
    var date = new Date();
    date.setTime(date.getTime() - 10000);
    document.cookie = name + "=a; expires=" + date.toGMTString();
}

function allCookie() {   // 讀取所有 cookie 字串
    var str = document.cookie;
    if (str == "") {
        str = "沒有保存任何 cookie";
    }
    alert(str);
}

function $(m, n) { return document.forms[m].elements[n].value; }

function add_() {
    addCookie($("myform", "cookie_name"), $("myform", "cookie_value"),
              $("myform", "cookie_expiresHours"));
}
function get_() { alert(getCookie($("myform", "cookie_name"))); }
function del_() {
    delCookie($("myform", "cookie_name"));
    alert("刪除成功");
}
</script>
</head>
<body>
<form name="myform">
<div><label for="cookie_name"> 名稱 </label>
<input type="text" name="cookie_name" /></div>
<div><label for="cookie_value"> 值 </label>
<input type="text" name="cookie_value" /></div>
<div><label for="cookie_expireHours"> 多少個小時過期 </label>
<input type="text" name="cookie_expiresHours" /></div>
<div>
<input type="button" value="添加該 cookie" onclick="add_()"/>
<input type="button" value="讀取所有 cookie" onclick="allCookie()"/>
<input type="button" value="讀取該名稱 cookie" onclick="get_()"/>
<input type="button" value="刪除該名稱 cookie" onclick="del_()"/>
</div>
</form>
</body>
</html>

幾個一定要知道的注意事項

一、Chrome 在本地檔案無法讀寫 cookie。用 file:// 協定開啟的 HTML,Cookie 相關操作會被瀏覽器禁止,寫入後讀出來是空的。要測試必須透過 HTTP 服務(例如把檔案放到本機的 www 目錄,或用 npx serve 起一個臨時伺服器)。以下這段程式碼寫在本機 HTML 裡會什麼都拿不到,但放在線上網站上就能正常顯示 Test=cooo:

 document.cookie = "Test=cooo";
alert(document.cookie);

二、沒有 path 就會互相覆蓋。預設的 path 是當前頁面所在目錄。若兩個頁面都在根目錄下卻寫了不同 path 的同名 cookie,彼此會看不到對方。建議設定時明確指定 ;path=/。

三、容量與安全限制。Cookie 有大小上限(一般單站 4KB 左右、單域名約 50 筆),不適合存放大量資料。同時它會隨每次請求送到伺服器,因此不要放敏感資訊;若真要放身分識別,請加上 Secure 與 HttpOnly 旗標,其中 HttpOnly 會讓 JS 讀不到該 cookie,能有效降低 XSS 竊取的風險。

四、新專案可考慮改用 Storage。如果只是要在瀏覽器本地存資料、不需要每次請求都帶到伺服器,localStorage(長期保存)與 sessionStorage(關閉分頁即清除)會比 Cookie 更方便,容量也大了幾個數量級。Cookie 的價值主要在「需要自動隨請求送出」這個特性上。

以上三種寫法與四點注意事項,涵蓋了日常開發中絕大多數的 Cookie 操作場景,希望能對你的學習有所幫助。

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