源碼分析之:cookies.js

# 0

這個系列會做一些優(yōu)秀開源項目的源碼解析出皇,一是為了沉淀和整理自己一年多來所學,二也是希望自己能堅持多做分享放祟,多做開源磷箕。文章由初級工程師面向初級工程師冤吨,也請大神們多多指點蒿柳。
小廣告:一個vue slider組件

# 1

這次分享的是一個前端操作cookie的庫(cookies.js),一共約80行代碼漩蟆,十分小巧簡潔(由于功能&&80行的定位垒探,我們不從工程角度分析這個庫)。從第一個commit到現(xiàn)在不過十來天怠李,就已經(jīng)有將近2k的star了圾叼,這個庫暴露出來的api非常簡單,設計和實現(xiàn)的確有很多值得學習的地方捺癞。

# 2

cookies:

var cookies = function (data, opt) {
  // 一個合并對象屬性的方法夷蚊,和Object.assign有些類似
  function defaults (obj, defs) {
    obj = obj || {};
    for (var key in defs) {
      // 對象屬性不存在時,進行淺拷貝
      if (obj[key] === undefined) {
        obj[key] = defs[key];
      }
    }
    return obj;
  }

初始化配置:

這里cookies是外層的cookies
函數(shù)依然可以像對象一樣去使用髓介,見我的一篇回答
https://www.zhihu.com/question/44990793/answer/99612521
為函數(shù)對象添加屬性是為了能通過下面這種簡單的方式改變?nèi)帜J配置
(defaults函數(shù)在對象屬性不存在時惕鼓,才進行淺拷貝,對象屬性存在則不做改動
所以提前賦值能起到改變?nèi)帜J配置的作用):
cookies.expires = 100 * 24 * 3600; // The time to expire in seconds
cookies.domain = false; // The domain for the cookie
cookies.path = '/'; // The path for the cookie
cookies.secure = https ? true : false; // Require the use of https

  defaults(cookies, {
    // cookie配置唐础,詳見 https://developer.mozilla.org/zh-CN/docs/Web/API/Document/cookie
    // 這里不清楚作者為什么不使用Cache-Control箱歧,有大神能解答一下嗎
    expires: 365 * 24 * 3600,
    path: '/',
    secure: window.location.protocol === 'https:',

    // Advanced矾飞,詳見 https://github.com/franciscop/cookies.js#advanced-options
    nulltoremove: true,
    autojson: true,
    autoencode: true,
    encode: function (val) {
      return encodeURIComponent(val);
    },
    decode: function (val) {
      return decodeURIComponent(val);
    }
  });

  // 設置某個cookie時單獨改變配置
  opt = defaults(opt, cookies);

  // expires的值需要Date.toUTCString()格式的,即 Mon, 03 Jul 2006 21:44:38 GMT 這種格式
  // 如果傳入的expires值不是一個Data對象呀邢,則進行轉(zhuǎn)換
  function expires (time) {
    var expires = time;
    if (!(expires instanceof Date)) {
      expires = new Date();
      expires.setTime(expires.getTime() + (time * 1000));
    }
    return expires.toUTCString();
  }

查詢cookie:

  // 如果data為字串洒沦,則查詢cookie
  if (typeof data === 'string') {
    // 分割document.cookie中的每個cookie
    var value = document.cookie.split(/;\s*/)
      // 如果autoencode為true,則數(shù)組中的每個cookie通過decode進行處理价淌,否則直接返回
      .map(opt.autoencode ? opt.decode : function (d) { return d; })
      // 再將每個cookie分割成[ key, value ]的結(jié)構(gòu)
      .map(function (part) { return part.split('='); })
      // 新建對象申眼,將[ [ key1, value1 ], [ key2, value2 ] ]結(jié)構(gòu)
      // 轉(zhuǎn)換為{ key1: value1, key2: value2 }結(jié)構(gòu)
      .reduce(function (parts, part) {
        parts[part[0]] = part[1];
        return parts;
      }, {})[data];  // 獲取指定cookie值,將值賦給value
    // 是否將json字串轉(zhuǎn)換為object輸出
    if (!opt.autojson) return value;
    try {
      return JSON.parse(value);
    } catch (e) {
      return value;
    }
  }

新增cookie:


  // data為object蝉衣,則設置每個cookie
  for (var key in data) {
    // 當設置的值為undefined豺型,或nulltoremove為true且設置的值為null時,將expired設為true
    // 準備用于清除cookie值
    var expired = data[key] === undefined || (opt.nulltoremove && data[key] === null);
    // autojson為true時买乃,將object轉(zhuǎn)為json字串。若不轉(zhuǎn)為字串钓辆,object將會以'[object Object]'存入cookie
    var str = opt.autojson ? JSON.stringify(data[key]) : data[key];
    // 是否對uri自動進行編碼 https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent
    var encoded = opt.autoencode ? opt.encode(str) : str;
    // 如果expired為true剪验,將cookie設空,以清除cookie
    if (expired) encoded = '';
    // 連接cookie的key,value以及各項設置
    var res = opt.encode(key) + '=' + encoded +
      (opt.expires ? (';expires=' + expires(expired ? -10000 : opt.expires)) : '') +
      ';path=' + opt.path +
      (opt.domain ? (';domain=' + opt.domain) : '') +
      (opt.secure ? ';secure' : '');
    // 如果opt中有test方法前联,執(zhí)行test方法
    if (opt.test) opt.test(res);
    // 種入cookie
    document.cookie = res;
  }
  // 返回cookies功戚,能做到如下串聯(lián)調(diào)用
  // cookies({ token: 42 })({ token: '42' })
  // var token = cookies({ token: '42' })('token')      token === '42'
  return cookies;
};

模塊化相關:

該模塊通過commonjs的module.exports暴露出去 或 通過AMD的define暴露出去 或 通過this['cookies'](global.cookies)暴露出去,具體看if條件似嗤。

webpack配置output中的libraryTarget設置為umd,就會在打包時自動添加這段代碼
這樣這個模塊就可以通過多種方式引入(AMD, commonjs, global)
具體可查看(https://webpack.github.io/docs/configuration.html#output-librarytarget)
當然直接把這段代碼加到模塊末尾也是ok的啸臀。

(function webpackUniversalModuleDefinition (root) {
  if (typeof exports === 'object' && typeof module === 'object') {
    module.exports = cookies;
  } else if (typeof define === 'function' && define.amd) {
    define('cookies', [], cookies);
  } else if (typeof exports === 'object') {
    exports['cookies'] = cookies;
  } else {
    root['cookies'] = cookies;
  }
})(this);

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市烁落,隨后出現(xiàn)的幾起案子乘粒,更是在濱河造成了極大的恐慌,老刑警劉巖伤塌,帶你破解...
    沈念sama閱讀 211,194評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件灯萍,死亡現(xiàn)場離奇詭異,居然都是意外死亡每聪,警方通過查閱死者的電腦和手機旦棉,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,058評論 2 385
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來药薯,“玉大人绑洛,你說我怎么就攤上這事⊥荆” “怎么了真屯?”我有些...
    開封第一講書人閱讀 156,780評論 0 346
  • 文/不壞的土叔 我叫張陵,是天一觀的道長巾陕。 經(jīng)常有香客問我讨跟,道長纪他,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,388評論 1 283
  • 正文 為了忘掉前任晾匠,我火速辦了婚禮茶袒,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘凉馆。我一直安慰自己薪寓,他們只是感情好,可當我...
    茶點故事閱讀 65,430評論 5 384
  • 文/花漫 我一把揭開白布澜共。 她就那樣靜靜地躺著向叉,像睡著了一般。 火紅的嫁衣襯著肌膚如雪嗦董。 梳的紋絲不亂的頭發(fā)上母谎,一...
    開封第一講書人閱讀 49,764評論 1 290
  • 那天,我揣著相機與錄音京革,去河邊找鬼奇唤。 笑死,一個胖子當著我的面吹牛匹摇,可吹牛的內(nèi)容都是我干的咬扇。 我是一名探鬼主播,決...
    沈念sama閱讀 38,907評論 3 406
  • 文/蒼蘭香墨 我猛地睜開眼廊勃,長吁一口氣:“原來是場噩夢啊……” “哼懈贺!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起坡垫,我...
    開封第一講書人閱讀 37,679評論 0 266
  • 序言:老撾萬榮一對情侶失蹤梭灿,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后冰悠,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體胎源,經(jīng)...
    沈念sama閱讀 44,122評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,459評論 2 325
  • 正文 我和宋清朗相戀三年屿脐,在試婚紗的時候發(fā)現(xiàn)自己被綠了涕蚤。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,605評論 1 340
  • 序言:一個原本活蹦亂跳的男人離奇死亡的诵,死狀恐怖万栅,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情西疤,我是刑警寧澤烦粒,帶...
    沈念sama閱讀 34,270評論 4 329
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響扰她,放射性物質(zhì)發(fā)生泄漏兽掰。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 39,867評論 3 312
  • 文/蒙蒙 一徒役、第九天 我趴在偏房一處隱蔽的房頂上張望孽尽。 院中可真熱鬧,春花似錦忧勿、人聲如沸杉女。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,734評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽熏挎。三九已至,卻和暖如春晌砾,著一層夾襖步出監(jiān)牢的瞬間坎拐,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,961評論 1 265
  • 我被黑心中介騙來泰國打工养匈, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留廉白,地道東北人。 一個月前我還...
    沈念sama閱讀 46,297評論 2 360
  • 正文 我出身青樓乖寒,卻偏偏與公主長得像,于是被迫代替她去往敵國和親院溺。 傳聞我的和親對象是個殘疾皇子楣嘁,可洞房花燭夜當晚...
    茶點故事閱讀 43,472評論 2 348

推薦閱讀更多精彩內(nèi)容

  • 1.幾種基本數(shù)據(jù)類型?復雜數(shù)據(jù)類型?值類型和引用數(shù)據(jù)類型?堆棧數(shù)據(jù)結(jié)構(gòu)? 基本數(shù)據(jù)類型:Undefined、Nul...
    極樂君閱讀 5,502評論 0 106
  • 從三月份找實習到現(xiàn)在珍逸,面了一些公司逐虚,掛了不少,但最終還是拿到小米谆膳、百度叭爱、阿里、京東漱病、新浪买雾、CVTE、樂視家的研發(fā)崗...
    時芥藍閱讀 42,209評論 11 349
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理杨帽,服務發(fā)現(xiàn)漓穿,斷路器,智...
    卡卡羅2017閱讀 134,629評論 18 139
  • 在線閱讀 http://interview.poetries.top[http://interview.poetr...
    程序員poetry閱讀 114,309評論 24 450
  • 在《鳳凰項目:一個IT運維的傳奇故事》中提到了“三步工作法”注盈,三步工作法旨在闡明指導開發(fā)運維的流程與實踐的價值觀與...
    申國斌青藍信息閱讀 1,168評論 0 0