DIV CSS 佈局教程網

在客戶端設定與讀取 Cookie 的兩個函式
編輯:關於JavaScript     

Cookie 是瀏覽器端最古老的持久化機制。原生 API 只有一個 document.cookie 字串,讀寫都要自己解析,因此實務上一定會包成兩個函式:setCookie 與 getCookie。

寫入:setCookie

<script language="javascript">
function setCookie(name, value, expires, path, domain, secure) {
  var today  = new Date();
  // 未指定過期時間時,預設七天後失效
  var expiry = new Date(today.getTime() + 7 * 24 * 60 * 60 * 1000);
  if (expires == '' || expires == null) {
    expires = expiry;
  }

  var curCookie = name + "=" + escape(value) +
    ((expires) ? "; expires=" + expires.toGMTString() : "") +
    ((path)    ? "; path="    + path    : "") +
    ((domain)  ? "; domain="  + domain  : "") +
    ((secure)  ? "; secure"              : "");

  document.cookie = curCookie;
}

幾個重點:值必須編碼,因為分號、逗號與空白在 Cookie 字串裡有語意;expires 要用 GMT 字串(toGMTString(),現在應改用 toUTCString());path 決定這個 Cookie 對哪些路徑可見,不設的話預設只在當前目錄生效,這是最常被忽略的一項。

讀取:getCookie

function getCookie(name) {
  var dc = document.cookie;
  var prefix = name + "=";
  var begin = dc.indexOf("; " + prefix);      // 先找「; name=」形式
  if (begin == -1) {
    begin = dc.indexOf(prefix);               // 再找放在最前面的情況
    if (begin != 0) return null;              // 找不到就回傳 null
  } else {
    begin += 2;                               // 跳過 "; " 兩個字元
  }
  var end = document.cookie.indexOf(";", begin);
  if (end == -1) end = dc.length;             // 是最後一個 cookie
  return unescape(dc.substring(begin + prefix.length, end));
}

這段解析邏輯處理了兩個邊界情況:目標 Cookie 是整串的第一個(前面沒有 "; "),以及它是最後一個(後面沒有 ";")。少了這兩個判斷,讀值就會出錯。

用法

setCookie("userName", "訪客", null, "/");
alert(getCookie("userName"));      // 訪客

五個實務上的升級建議

escape 已過時,改用 encodeURIComponent。escape() 不編碼 UTF-8,中文會出問題;encodeURIComponent() 才是正確選擇,讀取時對應用 decodeURIComponent()。

用 toUTCString 取代 toGMTString。後者是前者的別名,已被標記為不要用。

用物件一次寫入多個值。把整個物件 JSON 化後存成一個 Cookie,比拆成十幾個 name-value 好管理:

document.cookie = "appState=" + encodeURIComponent(JSON.stringify(obj)) +
                  "; path=/; max-age=604800; SameSite=Lax";

SameSite 一定要設。不設的話現代瀏覽器預設行為已經趨嚴,明確寫 SameSite=Lax 或 Strict 可以避免被誤判為跨站請求;HTTPS 站點加上 Secure。

注意大小限制與替代品。每個 Cookie 上限約 4KB,同網域總數也有上限。若只是要暫存前端狀態,用 localStorage(持久)或 sessionStorage(一次工作階段)會更方便,容量大得多、API 也乾淨:

localStorage.setItem("userName", JSON.stringify(obj));
var obj = JSON.parse(localStorage.getItem("userName"));

但要記得:Cookie 會隨每次請求自動送到伺服器,localStorage 不會。需要伺服器讀得到的身分資訊仍然該用 Cookie(且加上 HttpOnly 由伺服器設定,讓前端腳本讀不到,降低 XSS 風險)。

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