DIV CSS 佈局教程網

原生 JavaScript cookie 操作詳解:讀取、設定、刪除與 path/domain 陷阱
編輯:JavaScript綜合知識     

不用任何函式庫,JavaScript 操作 cookie 只能靠 document.cookie 這一個入口。它讀起來像屬性、寫起來也像屬性,但行為其實是「新增一筆」而非「整體赋值」。以下拆解完整實作。

讀取 cookie

<script>
function getCookie(c_name){
  if (document.cookie.length > 0){                 // 先確認 cookie 不為空
      c_start = document.cookie.indexOf(c_name + "=");  // 用 indexOf 確認是否存在,不存在則為 -1
      if (c_start != -1){
        c_start = c_start + c_name.length + 1;  // +1 是為了跳過 "=" 號
        c_end = document.cookie.indexOf(";", c_start);   // 取得值的結束位置
        if (c_end == -1) c_end = document.cookie.length;  // 若無分號,表示是最後一項
        return unescape(document.cookie.substring(c_start, c_end));
      }
    }
  return ""
}

逐行看:先在整個 cookie 字串中找出 名稱= 的位置,找不到就回傳空字串;找到後把起點往後推「名稱長度 + 1」,那個 1 就是跳過等號;再用 indexOf(";", c_start) 從起點往後找分號作為終點。這裡的第二個參數是開始搜尋的位置,若找不到分號代表這是最後一筆,就把終點設為字串長度。

最後用 unescape 解碼。設定時若用了 escape 編碼,讀取時就必須解碼,兩者成對出現。

設定 cookie

function setCookie(c_name, value, expiredays){
  var exdate = new Date();
  exdate.setDate(exdate.getDate() + expiredays);
  document.cookie = c_name + "=" + escape(value) +
    "path=/;domain=example.com" +
    ((expiredays == null) ? "" : ";expires=" + exdate.toGMTString());
}

設定 cookie 就是「赋值一段以分號分隔的設定字串」。其中 expires 決定存活時間,path 與 domain 決定可見範圍,三者都非必要但實務上幾乎都會用到。

完整運作範例

以下示範一個常見應用:記住使用者已關閉過某個提示區,在 cookie 有效期內不再顯示。

function sc(days){
  setCookie('ashow', 'a', days);
  document.getElementById('ad').style.display = 'none';
}

function gc(){
  if (getCookie('ashow') == 1){
    alert(getCookie('ashow'));
    document.getElementById('ad').style.display = 'none';
  }
}
</script>

<div id="ad">廣告內容</div>
<script>gc();</script>
<a href="#" onclick="javascript:sc(1);">設定 Cookie 值</a>
<a href="#" onclick="javascript:gc();">取得 Cookie 值</a>
<a href="#" onclick="javascript:sc(-1);">清除 Cookie 值</a>

注意最後一個連結用 sc(-1) 來清除:把天數設為負數,等於設定一個已過去的到期時間,瀏覽器便會刪除它。這是刪除 cookie 唯一的方式。

path 與 domain:最容易踩到的兩個坑

path 決定 cookie 屬於哪個路徑範圍。若不設定,預設只在當前目錄可見。也就是說,在 /php/phper.html 設定的 cookie,到 /sj/ 底下就讀不到了。要讓全站共用,必須明確寫成 path=/。

domain 決定跨子網域的可見性。若在 www.example.com 上設定且未指定 domain,則 blog.example.com 讀不到。要讓所有子網域共用,須設為 domain=example.com。

這兩者最麻煩的地方是:刪除時必須使用與設定時完全相同的 path 與 domain,否則瀏覽器認為你要刪的是另一個 cookie,刪除失敗且不會報錯。這是「明明寫了刪除程式碼,cookie 卻還在」的最主要原因。

現代寫法的建議

escape 與 unescape 已於 ES2015 標示為停用,應改用 encodeURIComponent 與 decodeURIComponent。前者對 UTF-8 的處理更完整,能正確處理中文。

另外,若 cookie 涉及任何身分識別用途,務必加上 Secure(僅經 HTTPS 傳輸)與 HttpOnly(禁止 JavaScript 讀取,可大幅降低 XSS 竊取之風險)兩個旗標——不過 HttpOnly 需由伺服器端設定,前端無從為之。

最後,這些手寫函式今日已有更好的替代:ES Module 可直接使用 MDN 文件提供的 Cookies 工具物件,或引入 js-cookie 這類成熟函式庫,一行就能完成讀寫刪。若要在 localStorage 與 cookie 之間選擇,前者容量更大(5MB 起)且不隨每次請求上傳伺服器,除少數需要與後端同步的情境外,通常更合適。

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