萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 腳本程式專題 >> JavaScript

JavaScript Cookie 完整操作庫:設定、讀取、刪除、檢查存在、序列化字串

前言

Cookie 是客戶端持久化少量資料的經典機制。本文提供功能完整的 Cookie 操作工具集,包含設定/讀取/刪除/全刪、依名稱/值查詢、序列化輸出,均支援編碼、路徑、網域、安全旗標、過期天數等完整選項。

核心 API

// 設定 Cookie
var SetCookie = function (name, value, expiresDays, path, domain, secure) {
    var exp = '';
    if (expiresDays) {
        var d = new Date();
        d.setDate(d.getDate() + expiresDays);
        exp = ';expires=' + d.toUTCString();
    }
    document.cookie = encodeURIComponent(name) + '=' + encodeURIComponent(value)
        + exp
        + (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 cookies = document.cookie.split(';');
    var now = new Date().toUTCString();
    for (var i = cookies.length - 1; i >= 0; i--) {
        document.cookie = cookies[i] + '; expires=' + now;
    }
};

// 正則特殊字符義 (內部用)
var EscapeReg = function (str) {
    return str.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, '\\$&');
};

// 檢查 Cookie 名稱是否存在 (不區分大小寫)
var CNameExists = function (name) {
    if (!document.cookie) return false;
    var reg = new RegExp('(^|;)\\s*' + EscapeReg(name) + '=([^;]*)(;|$)', 'i');
    return reg.test(decodeURIComponent(document.cookie));
};

// 檢查 Cookie 值是否存在
var CValueExists = function (value) {
    if (!document.cookie) return false;
    var reg = new RegExp('=' + EscapeReg(value) + '(;|$)', 'i');
    return reg.test(decodeURIComponent(document.cookie));
};

// 依值反查名稱
var CNameGet = function (value) {
    if (!document.cookie) return '';
    var reg = new RegExp('(^|;)\\s*([^=]*)=' + EscapeReg(value) + '(;|$)', 'i');
    var m = decodeURIComponent(document.cookie).match(reg);
    return m ? m[2] : '';
};

// 依名稱取值 (最常用)
var CValueGet = function (name) {
    if (!document.cookie) return '';
    var reg = new RegExp('(^|;)\\s*' + EscapeReg(name) + '=([^;]*)(;|$)', 'i');
    var m = decodeURIComponent(document.cookie).match(reg);
    return m ? m[2] : '';
};

// 序列化所有 Cookie 為字串 (適合顯示在 textarea)
var CookieStr = function () {
    return decodeURIComponent(document.cookie)
        .replace(/([^=;]+)=([^;]*)[;\s]*/g, '$1 ($2)\n') || '';
};

使用範例

// 設定 7 天有效、全站可用、HTTPS 傳輸
SetCookie('token', 'abc123', 7, '/', '.example.com', true);

// 讀取
var token = CValueGet('token'); // 'abc123'

// 檢查
if (CNameExists('token')) { /* ... */ }

// 刪除
DeleteCookie('token', '/', '.example.com');

// 列印所有
console.log(CookieStr());

注意事項

  • 所有名稱/值自動 encodeURIComponent,支援中文、特殊字符。
  • 過期時間以「天」為單位,內部換算為 UTC 日期字串。
  • path、domain 設定需與寫入時一致才能正確讀取/刪除。
  • secure 僅在 HTTPS 頁面生效。
  • 單一 Cookie 上限約 4KB,總數限制視瀏覽器而定 (通常每域 50~180 個)。

現代替代方案

若需儲存較大資料或結構化資料,建議使用 localStorage/sessionStorage (5MB+、同步 API、不隨請求發送)。Cookie 仍適用於需隨 HTTP 請求自動攜帶的場景 (如 Session ID、Token)。

總結

這組 Cookie 工具函式涵蓋全生命週期操作,代碼精簡、編碼安全、跨瀏覽器相容,可直接納入專案通用工具庫。

copyright © 萬盛學電腦網 all rights reserved