DIV CSS 佈局教程網

封裝成物件形式的 JavaScript Cookie 工具類完整指南
編輯:關於JavaScript     

為什麼要封裝

直接用 document.cookie 操作相容性最好,但也最麻煩:它是一串字串,讀取要自己 split、寫入要自己拼 expires、刪除還得把時間設成過去。用久了實在受不了,於是包了一個工具類。順帶也提醒自己:寫程式之餘,把思路寫下來同樣重要。

設計思路

怎麼包:用原生 JS 封裝,不依賴任何框架,這樣放進任何專案都能用。底層仍然全部基於 document.cookie。

包成什麼樣:以物件形式存在,提供 getter/setter 風格的方法呼叫。

要哪些方法:get()、set(name, value, opts)、remove(name)、clear()、getCookies(),再加上一個避免全域衝突的 noConflict()。這些就足以應付日常所有場景。

程式碼

/*
 * HTTP Cookie:用於儲存會話資訊
 * 名稱與值傳送時必須經過 URL 編碼
 * Cookie 綁定在特定網域下,非本網域無法共用;但主站可將 cookie 分享給子站
 * 各瀏覽器對數量與大小有限制(單筆建議 < 4KB),因此只依「必要」原則設定
 * 名稱不區分大小寫;建議為值做 URL 編碼
 * path 是區分 cookie 在不同情境下傳遞的好方式
 * 加上 secure 標記後,只有 SSL 連線才會送出,http 不會
 * 建議同時設定 expires、domain、path
 */
(function (global) {
    // 把 document.cookie 解析成物件
    function getCookiesObj() {
        var cookies = {};
        if (document.cookie) {
            var objs = document.cookie.split('; ');
            for (var i in objs) {
                var index = objs[i].indexOf('='),
                    name = objs[i].substr(0, index),
                    value = objs[i].substr(index + 1, objs[i].length);
                cookies[name] = value;
            }
        }
        return cookies;
    }

    // 設定 cookie
    function set(name, value, opts) {
        if (name && value) {
            var cookie = encodeURIComponent(name) + '=' + encodeURIComponent(value);
            if (opts) {
                if (opts.maxAge) { cookie += '; max-age=' + opts.maxAge; }
                if (opts.path)   { cookie += '; path=' + opts.path; }
                if (opts.domain) { cookie += '; domain=' + opts.domain; }
                if (opts.secure) { cookie += '; secure'; }
            }
            document.cookie = cookie;
            return cookie;
        }
        return '';
    }

    // 讀取單一 cookie
    function get(name) {
        return decodeURIComponent(getCookiesObj()[name]) || null;
    }

    // 刪除單一 cookie:把 max-age 設為 0
    function remove(name) {
        if (getCookiesObj()[name]) {
            document.cookie = name + '=; max-age=0';
        }
    }

    // 清空所有 cookie
    function clear() {
        var cookies = getCookiesObj();
        for (var key in cookies) {
            document.cookie = key + '=; max-age=0';
        }
    }

    function getCookies() { return getCookiesObj(); }

    // 命名衝突處理
    function noConflict(name) {
        if (name && typeof name === 'string') {
            if (window['cookie']) {
                window[name] = window['cookie'];
                delete window['cookie'];
                return window[name];
            }
        } else {
            var c = window['cookie'];
            delete window['cookie'];
            return c;
        }
    }

    global['cookie'] = {
        'getCookies': getCookies,
        'set': set,
        'get': get,
        'remove': remove,
        'clear': clear,
        'noConflict': noConflict
    };
})(window);

使用範例

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">
    <title>cookie example</title>
</head>
<body>
<script type="text/javascript" src="cookie.js"></script>
<script type="text/javascript">
console.log('----------cookie 物件-------------');
console.log(cookie);

console.log('----------寫入 name-------------');
console.log(cookie.set('name', 'wlh'));

console.log('----------覆寫 name-------------');
console.log(cookie.set('name', 'wlh123'));

console.log('----------寫入 age-------------');
console.log(cookie.set('age', 20));

console.log('----------讀取 name-------------');
console.log(cookie.get('name'));

console.log('----------取得全部-------------');
console.log(cookie.getCookies());

console.log('----------刪除 age-------------');
cookie.remove('age');
console.log(cookie.getCookies());

console.log('----------清空-------------');
cookie.clear();
console.log(cookie.getCookies());

console.log('----------改名避免衝突-------------');
var $Cookie = cookie.noConflict('myCookie');
console.log($Cookie.getCookies());
</script>
</body>
</html>

幾處值得修正的地方

max-age 的單位:原寫法直接把 opts.maxAge 拼上去,但 HTTP 規範中 max-age 的單位是秒。若你希望呼叫時傳「天數」,記得在內部乘上 86400。另外 IE8 以下不認 max-age,需要相容時得改用 expires 並格式化為 UTC 字串。

remove 的 path 要對得上:刪除 cookie 時,若不指定與寫入時相同的 path 與 domain,瀏覽器會認為你刪的是另一個 cookie,導致刪不掉。實務上建議让 remove 也接受 opts 並傳入相同設定。

get 的 falsy 判斷:decodeURIComponent(...) || null 在值為空字串或 "0" 時會回傳 null,可能不是你想要的。改成先判斷 undefined 再回傳會更精確。

用 for...in 走物件:解析與遍歷時建議加上 hasOwnProperty 檢查,避免被原型鏈上的屬性干擾。

程式碼已放在 https://github.com/vczero/cookie ,可以直接取用。若要在新專案中使用,我會建議把註解裡提到的 SameSite 屬性也一併加入(Lax 是現今瀏覽器的合理預設),並在設定敏感資料前三思——Cookie 會隨每次請求自動送出,敏感資訊應該留在伺服器端的 Session 裡。

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