温馨提示×

温馨提示×

您好,登录后才能下订单哦!

密码登录×
登录注册×
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》

js的cookie怎么使用

发布时间:2022-12-27 16:25:53 来源:亿速云 阅读:124 作者:iii 栏目:开发技术

本篇内容主要讲解“js的cookie怎么使用”,感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷,实用性强。下面就让小编来带大家学习“js的cookie怎么使用”吧!

    源码分析

    使用

    根据README,我们可以看到js-cookie的使用方式:

    // 设置
    Cookies.set('name', 'value');
    // 设置过期时间
    Cookies.set('name', 'value', { expires: 7 })
    // 获取
    Cookies.get('name') // => 'value'
    // 获取所有
    Cookies.get() // => { name: 'value' }
    // 获取指定域名下
    Cookies.get('foo', { domain: 'sub.example.com' })
    // 删除
    Cookies.remove('name')

    还有很多其他用和配置说明,大家可以自己去看看。

    源码

    js-cookie的源码并不多,src目录下的api.mjs就是我们要分析的源码,只有一百行左右。

    /* eslint-disable no-var */
    import assign from './assign.mjs'
    import defaultConverter from './converter.mjs'
    function init (converter, defaultAttributes) {
      function set (name, value, attributes) {
        if (typeof document === 'undefined') {
          return
        }
        attributes = assign({}, defaultAttributes, attributes)
        if (typeof attributes.expires === 'number') {
          attributes.expires = new Date(Date.now() + attributes.expires * 864e5)
        }
        if (attributes.expires) {
          attributes.expires = attributes.expires.toUTCString()
        }
        name = encodeURIComponent(name)
          .replace(/%(2[346B]|5E|60|7C)/g, decodeURIComponent)
          .replace(/[()]/g, escape)
        var stringifiedAttributes = ''
        for (var attributeName in attributes) {
          if (!attributes[attributeName]) {
            continue
          }
          stringifiedAttributes += '; ' + attributeName
          if (attributes[attributeName] === true) {
            continue
          }
          // Considers RFC 6265 section 5.2:
          // ...
          // 3.  If the remaining unparsed-attributes contains a %x3B (";")
          //     character:
          // Consume the characters of the unparsed-attributes up to,
          // not including, the first %x3B (";") character.
          // ...
          stringifiedAttributes += '=' + attributes[attributeName].split(';')[0]
        }
        return (document.cookie =
          name + '=' + converter.write(value, name) + stringifiedAttributes)
      }
      function get (name) {
        if (typeof document === 'undefined' || (arguments.length && !name)) {
          return
        }
        // To prevent the for loop in the first place assign an empty array
        // in case there are no cookies at all.
        var cookies = document.cookie ? document.cookie.split('; ') : []
        var jar = {}
        for (var i = 0; i < cookies.length; i++) {
          var parts = cookies[i].split('=')
          var value = parts.slice(1).join('=')
          try {
            var found = decodeURIComponent(parts[0])
            jar[found] = converter.read(value, found)
            if (name === found) {
              break
            }
          } catch (e) {}
        }
        return name ? jar[name] : jar
      }
      return Object.create(
        {
          set: set,
          get: get,
          remove: function (name, attributes) {
            set(
              name,
              '',
              assign({}, attributes, {
                expires: -1
              })
            )
          },
          withAttributes: function (attributes) {
            return init(this.converter, assign({}, this.attributes, attributes))
          },
          withConverter: function (converter) {
            return init(assign({}, this.converter, converter), this.attributes)
          }
        },
        {
          attributes: { value: Object.freeze(defaultAttributes) },
          converter: { value: Object.freeze(converter) }
        }
      )
    }
    export default init(defaultConverter, { path: '/' })
    /* eslint-enable no-var */

    分析

    js-cookie的源码并不多,我们先来看看导出的是什么:

    export default init(defaultConverter, { path: '/' })

    这里是直接导出了init函数的返回值,我们来看看init函数的返回值:

    function init (converter, defaultAttributes) {
      // ...
      return Object.create(
        {
          set: set,
          get: get,
          remove: function (name, attributes) {
            set(
              name,
              '',
              assign({}, attributes, {
                expires: -1
              })
            )
          },
          withAttributes: function (attributes) {
            return init(this.converter, assign({}, this.attributes, attributes))
          },
          withConverter: function (converter) {
            return init(assign({}, this.converter, converter), this.attributes)
          }
        },
        {
          attributes: { value: Object.freeze(defaultAttributes) },
          converter: { value: Object.freeze(converter) }
        }
      )
    }

    这里是使用Object.create创建了一个对象,这个对象有setgetremovewithAttributeswithConverter这几个方法,这几个方法都是在init函数内部定义的,我们来看看这几个方法的实现:

    set

    function set(name, value, attributes) {
        if (typeof document === 'undefined') {
            return
        }
        attributes = assign({}, defaultAttributes, attributes)
        if (typeof attributes.expires === 'number') {
            attributes.expires = new Date(Date.now() + attributes.expires * 864e5)
        }
        if (attributes.expires) {
            attributes.expires = attributes.expires.toUTCString()
        }
        name = encodeURIComponent(name)
            .replace(/%(2[346B]|5E|60|7C)/g, decodeURIComponent)
            .replace(/[()]/g, escape)
        var stringifiedAttributes = ''
        for (var attributeName in attributes) {
            if (!attributes[attributeName]) {
                continue
            }
            stringifiedAttributes += '; ' + attributeName
            if (attributes[attributeName] === true) {
                continue
            }
            // Considers RFC 6265 section 5.2:
            // ...
            // 3.  If the remaining unparsed-attributes contains a %x3B (";")
            //     character:
            // Consume the characters of the unparsed-attributes up to,
            // not including, the first %x3B (";") character.
            // ...
            stringifiedAttributes += '=' + attributes[attributeName].split(';')[0]
        }
        return (document.cookie =
            name + '=' + converter.write(value, name) + stringifiedAttributes)
    }

    一行一行来看:

    if (typeof document === 'undefined') {
        return
    }

    首先判断是否有document对象,如果没有则直接返回,这说明js-cookie只能在浏览器环境下使用。

    attributes = assign({}, defaultAttributes, attributes)

    然后合并配置项,将defaultAttributes和传入的attributes合并,这里的assign大家直接理解为Object.assign就好了。

    if (typeof attributes.expires === 'number') {
        attributes.expires = new Date(Date.now() + attributes.expires * 864e5)
    }
    if (attributes.expires) {
        attributes.expires = attributes.expires.toUTCString()
    }

    然后判断expires是否是一个数字,如果是数字则将其转换为一个Date对象;

    这里的864e5是一个常量,结尾的e5代表后面加5个0,也就是86400000表示一天的毫秒数。

    然后判断expires是否存在,如果存在则将其转换为UTC时间。

    name = encodeURIComponent(name)
        .replace(/%(2[346B]|5E|60|7C)/g, decodeURIComponent)
        .replace(/[()]/g, escape)

    这里对name进行了编码,然后将name中的%()进行了转义。

    escape是一个内置函数,它的作用是将一个字符串转换为UTF-8编码的字符串,这里的escape是将()转换为%28%29

    参考:escape()

    var stringifiedAttributes = ''
    for (var attributeName in attributes) {
        if (!attributes[attributeName]) {
            continue
        }
        stringifiedAttributes += '; ' + attributeName
        if (attributes[attributeName] === true) {
            continue
        }
        // Considers RFC 6265 section 5.2:
        // ...
        // 3.  If the remaining unparsed-attributes contains a %x3B (";")
        //     character:
        // Consume the characters of the unparsed-attributes up to,
        // not including, the first %x3B (";") character.
        // ...
        stringifiedAttributes += '=' + attributes[attributeName].split(';')[0]
    }

    这里是将attributes转换为字符串,这里的stringifiedAttributes是一个字符串,最后的结果是这样的:

    stringifiedAttributes = '; path=/; expires=Wed, 21 Oct 2015 07:28:00 GMT'

    最后将namevaluestringifiedAttributes拼接起来,然后赋值给document.cookie

    get

    function get(name) {
        if (typeof document === 'undefined' || (arguments.length && !name)) {
            return
        }
        // To prevent the for loop in the first place assign an empty array
        // in case there are no cookies at all.
        var cookies = document.cookie ? document.cookie.split('; ') : []
        var jar = {}
        for (var i = 0; i < cookies.length; i++) {
            var parts = cookies[i].split('=')
            var value = parts.slice(1).join('=')
            try {
                var found = decodeURIComponent(parts[0])
                jar[found] = converter.read(value, found)
                if (name === found) {
                    break
                }
            } catch (e) {
            }
        }
        return name ? jar[name] : jar
    }

    get方法的实现比较简单,主要是解析document.cookie,然后将其转换为一个对象,来逐行解析:

    if (typeof document === 'undefined' || (arguments.length && !name)) {
        return
    }

    对比于set方法,这里多了一个(arguments.length && !name)的判断,这里是防止传入空字符串的name

    var cookies = document.cookie ? document.cookie.split('; ') : []

    这里是将document.cookie分割为一个数组,每一项是一个cookie

    var jar = {}
    for (var i = 0; i < cookies.length; i++) {
        var parts = cookies[i].split('=')
        var value = parts.slice(1).join('=')
    }

    这一步是只要cookienamevalue,其他的一些额外附加信息都不需要。

    try {
        var found = decodeURIComponent(parts[0])
        jar[found] = converter.read(value, found)
        if (name === found) {
            break
        }
    } catch (e) {
    }

    这里是将name进行了解码,然后将namevalue存储到jar对象中,如果传入了name,则在找到对应的name后就跳出循环。

    return name ? jar[name] : jar

    最后返回jar对象,如果传入了name,则返回对应的value,否则返回整个jar对象。

    这里的核心是converter.read,这个方法是用来解析value的,这里的converter是一个对象,它有两个方法:

    /* eslint-disable no-var */
    export default {
      read: function (value) {
        if (value[0] === '"') {
          value = value.slice(1, -1)
        }
        return value.replace(/(%[\dA-F]{2})+/gi, decodeURIComponent)
      },
      write: function (value) {
        return encodeURIComponent(value).replace(
          /%(2[346BF]|3[AC-F]|40|5[BDE]|60|7[BCD])/g,
          decodeURIComponent
        )
      }
    }
    /* eslint-enable no-var */

    read方法是将value进行解码,write方法是将value进行编码。

    remove

    function remove(name, attributes) {
        set(
            name,
            '',
            assign({}, attributes, {
                expires: -1
            })
        )
    }

    remove方法就是使用set方法将value设置为空字符串,然后将expires设置为-1,这样就相当于删除了cookie

    withAttributes & withConverter

    Object.create({
        withAttributes: function (attributes) {
            return init(assign({}, defaultAttributes, attributes))
        },
        withConverter: function (converter) {
            return init(assign({}, defaultConverter, converter))
        }
    })

    这两个方法就是用来设置defaultAttributesdefaultConverter的,这两个对象是用来设置cookie的默认属性和默认的converter

    到此,相信大家对“js的cookie怎么使用”有了更深的了解,不妨来实际操作一番吧!这里是亿速云网站,更多相关内容可以进入相关频道进行查询,关注我们,继续学习!

    向AI问一下细节

    免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

    AI