Javascript getCookie函数

时间:2010-10-23 11:53:36

标签: javascript cookies

我找到了两个使用Javascript获取Cookie数据的函数,一个在w3schools.com上,另一个在quirksmode.org上 我想知道应该使用哪一个?

例如,我相信我在某处读到某些浏览器分割;分号时出现问题?

W3Schools的:

function getCookie(c_name) {
    if (document.cookie.length > 0) {
        c_start = document.cookie.indexOf(c_name + "=");
        if (c_start != -1) {
            c_start = c_start + c_name.length + 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 "";
}

怪异模式:

function readCokie(name) {
    var nameEQ = name + "=";
    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, c.length);
        if (c.indexOf(nameEQ) == 0) return c.substring(nameEQ.length, c.length);
    }
    return null;
}

5 个答案:

答案 0 :(得分:90)

W3CSchool的功能是错误的。如果有多个cookie具有相同的后缀,则会失败,如:

ffoo=bar; foo=baz

当您搜索foo时,它将返回 ffoo 的值,而不是 foo

现在我要做的是:首先,您需要了解cookie的传输方式。 Netscape的原始规范(只有像this one at haxx.se这样的副本)使用分号分隔多个cookie,而每个名称/值对具有以下语法:

  

NAME = VALUE
  此字符串是一系列字符,不包括分号,逗号和空格。如果需要在名称或值中放置此类数据,建议使用某种编码方法,例如URL样式%XX编码,但不定义或要求编码。

因此,在分号或逗号中分割document.cookie字符串是一个可行的选择。

除此之外,RFC 2109还指定cookie由分号或逗号分隔:

cookie          =       "Cookie:" cookie-version
                        1*((";" | ",") cookie-value)
cookie-value    =       NAME "=" VALUE [";" path] [";" domain]
cookie-version  =       "$Version" "=" value
NAME            =       attr
VALUE           =       value
path            =       "$Path" "=" value
domain          =       "$Domain" "=" value

虽然两者都是允许的,但首选逗号,因为它们是HTTP中列表项的默认分隔符。

  

注意:为了向后兼容,请使用Cookie标头中的分隔符      到处都是分号(;)。服务器也应该接受逗号(,)      作为cookie值之间的分隔符,以便将来兼容。

此外,名称/值对还有一些进一步的限制,因为 VALUE 也可以是RFC 2616中指定的带引号的字符串:

attr        =     token
value       =     token | quoted-string

所以这两个cookie版本需要单独处理:

if (typeof String.prototype.trimLeft !== "function") {
    String.prototype.trimLeft = function() {
        return this.replace(/^\s+/, "");
    };
}
if (typeof String.prototype.trimRight !== "function") {
    String.prototype.trimRight = function() {
        return this.replace(/\s+$/, "");
    };
}
if (typeof Array.prototype.map !== "function") {
    Array.prototype.map = function(callback, thisArg) {
        for (var i=0, n=this.length, a=[]; i<n; i++) {
            if (i in this) a[i] = callback.call(thisArg, this[i]);
        }
        return a;
    };
}
function getCookies() {
    var c = document.cookie, v = 0, cookies = {};
    if (document.cookie.match(/^\s*\$Version=(?:"1"|1);\s*(.*)/)) {
        c = RegExp.$1;
        v = 1;
    }
    if (v === 0) {
        c.split(/[,;]/).map(function(cookie) {
            var parts = cookie.split(/=/, 2),
                name = decodeURIComponent(parts[0].trimLeft()),
                value = parts.length > 1 ? decodeURIComponent(parts[1].trimRight()) : null;
            cookies[name] = value;
        });
    } else {
        c.match(/(?:^|\s+)([!#$%&'*+\-.0-9A-Z^`a-z|~]+)=([!#$%&'*+\-.0-9A-Z^`a-z|~]*|"(?:[\x20-\x7E\x80\xFF]|\\[\x00-\x7F])*")(?=\s*[,;]|$)/g).map(function($0, $1) {
            var name = $0,
                value = $1.charAt(0) === '"'
                          ? $1.substr(1, -1).replace(/\\(.)/g, "$1")
                          : $1;
            cookies[name] = value;
        });
    }
    return cookies;
}
function getCookie(name) {
    return getCookies()[name];
}

答案 1 :(得分:9)

是的,W3Schools解决方案不正确

对于那些想要的人,这里有一个更简单的解决方案。它只是预先设置一个空格,因此对indexOf()的单次调用只返回正确的cookie。

function getCookie(c_name) {
    var c_value = " " + document.cookie;
    var c_start = c_value.indexOf(" " + c_name + "=");
    if (c_start == -1) {
        c_value = null;
    }
    else {
        c_start = c_value.indexOf("=", c_start) + 1;
        var c_end = c_value.indexOf(";", c_start);
        if (c_end == -1) {
            c_end = c_value.length;
        }
        c_value = unescape(c_value.substring(c_start,c_end));
    }
    return c_value;
}

答案 2 :(得分:6)

这来自w3schools, 不正确 ,因为它可能会导致错误的Cookie:

c_start = document.cookie.indexOf(c_name + "=");

如果你去寻找一个名为foo的cookie(我们假设它是一个现有的cookie),那么document.cookie中的某个地方就是字符串foo=bar

但是,无法保证 不会是字符串xfoo=something。请注意,这仍包含子串foo=,因此w3schools代码将找到它。如果首先列出xfoo Cookie,您将获得something值(错误!)而不是预期的bar

考虑到两段代码之间的选择,永远不要选择那个从根本上破坏的代码。

答案 3 :(得分:2)

上面显示的所有代码都是BROKEN。两个常见问题是(1)如果一个cookie名称是另一个cookie名称的正确后缀,则getcookie函数可能返回错误的值; (2)setcookie函数不保护cookie值,这意味着如果cookie值包括(例如)&#34 ;;&#34;然后所有的cookie都被破坏了,无法解析。

TL; DR使用这个编写良好的库代替: https://github.com/js-cookie/js-cookie

答案 4 :(得分:0)

这是我的版本,它涵盖了带引号的边值情况。

function getCookies() {
  const REGEXP = /([\w\.]+)\s*=\s*(?:"((?:\\"|[^"])*)"|(.*?))\s*(?:[;,]|$)/g;
  let cookies = {};
  let match;
  while( (match = REGEXP.exec(document.cookie)) !== null ) {
    let value = match[2] || match[3];
    cookies[match[1]] = decodeURIComponent(value);
  }
  return cookies;
}