JS前端操作 Cookie原始碼範例解析

2022-12-27 14:01:38

引言

前端操作Cookie的場景其實並不多見，Cookie也因為各種問題被逐漸淘汰，但是我們不用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 &amp;&amp; !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 &lt; 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建立了一個物件，這個物件有set、get、remove、withAttributes、withConverter這幾個方法，這幾個方法都是在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'

最後將name、value、stringifiedAttributes拼接起來，然後賦值給document.cookie。

get

function get(name) {
    if (typeof document === 'undefined' || (arguments.length &amp;&amp; !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 &lt; 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 &lt; cookies.length; i++) {
    var parts = cookies[i].split('=')
    var value = parts.slice(1).join('=')
}

這一步是隻要cookie的name和value，其他的一些額外附加資訊都不需要。

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

這裡是將name進行了解碼，然後將name和value儲存到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))
    }
})

這兩個方法就是用來設定defaultAttributes和defaultConverter的，這兩個物件是用來設定cookie的預設屬性和預設的converter。