javascript制作的cookie封装及使用指南


Posted in Javascript onJanuary 02, 2015

一、前言

之前使用cookie,都是document.cookie的形式去操作,兼容性虽好,但是麻烦。个人又是个比较喜欢造轮子的人,所以针对cookie,封装了个工具类。很长时间以来,我都喜欢写代码,而不太喜欢文字总结,也不太喜欢写些零碎的东西,看来得改。

二、思路

(1)如何封装,封装成啥样

如何封装:就是使用原生的js封装成工具,那样到哪里都能能用。针对document.cookie封装是最好的方式,所有的操作都基于document.cookie。

封装成啥样:封装成能够以对象的形式存在,同时可以使用getter & setter方法的实行。

(2)封装哪些方法

get()、set(name, value, opts)、remove(name)、clear()、getCookies()等等,个人觉得封装这么多方法足矣使用cookie了。

三、行动

(1)了解cookie, cookie的实质是HTTP cookie,在客户端表现的对象时document.cookie.更多了解,可以看我下面的代码即注释

(2)上代码:这些代码应该都很直观,并且可以配合项目代码一起压缩。我觉得下面的开头的注释是重点。

/*

 * HTTP Cookie:存储会话信息

 * 名称和值传送时必须是经过RUL编码的

 * cookie绑定在指定的域名下,非本域无法共享cookie,但是可以是在主站共享cookie给子站

 * cookie有一些限制:比如IE6 & IE6- 限定在20个;IE7 50个;Opear 30个...所以一般会根据【必须】需求才设定cookie

 * cookie的名称不分大小写;同时建议将cookie URL编码;路径是区分cookie在不同情况下传递的好方式;带安全标志cookie

 *     在SSL情况下发送到服务器端,http则不会。建议针对cookie设置expires、domain、 path;每个cookie小于4KB

 * */

//对cookie的封装,采取getter、setter方式

(function(global){

    //获取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){

        //opts maxAge, path, domain, secure

        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;

        }else{

            return '';

        }

    }

    //获取cookie

    function get(name){

        return decodeURIComponent(getCookiesObj()[name]) || null;

    }

    //清除某个cookie

    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';

        }

    }

    //获取所有cookies

    function getCookies(name){

        return getCookiesObj();

    }

    //解决冲突

    function noConflict(name){

        if(name && typeof name === 'string'){

            if(name && window['cookie']){

                window[name] = window['cookie'];

                delete window['cookie'];

                return window[name];

            }

        }else{

            return window['cookie'];

            delete window['cookie'];

        }

    }

    global['cookie'] = {

        'getCookies': getCookies,

        'set': set,

        'get': get,

        'remove': remove,

        'clear': clear,

        'noConflict': noConflict

    };

})(window);

 (3)example

<!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('----------对象-------------');

            console.log(cookie.getCookies());

            console.log('----------设置cookie-------------');

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

            console.log('----------设置cookie 123-------------');

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

            console.log('----------设置cookie age-------------');

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

            console.log('----------获取cookie-------------');

            console.log(cookie.get('name'));

            console.log('----------获取所有-------------');

            console.log(cookie.getCookies());

            console.log('----------清除age-------------');

            console.log(cookie.remove('age'));

            console.log('----------获取所有-------------');

            console.log(cookie.getCookies());

            console.log('----------清除所有-------------');

            console.log(cookie.clear());

            console.log('----------获取所有-------------');

            console.log(cookie.getCookies());

            console.log('----------解决冲突-------------');

            var $Cookie = cookie.noConflict(true /*a new name of cookie*/);

            console.log($Cookie);

            console.log('----------使用新的命名-------------');

            console.log($Cookie.getCookies());

        </script>

    </body>

</html>

(4)代码地址:https://github.com/vczero/cookie

Javascript 相关文章推荐
jQuery ajax在GBK编码下表单提交终极解决方案(非二次编码方法)
Oct 20 Javascript
jquery js 重置表单 reset()具体实现代码
Aug 05 Javascript
AngularJS实用基础知识_入门必备篇(推荐)
Jul 10 Javascript
React中使用collections时key的重要性详解
Aug 07 Javascript
通过js控制时间,一秒一秒自己动的实例
Oct 25 Javascript
详解Angular6学习笔记之主从组件
Sep 05 Javascript
Vue slot用法(小结)
Oct 22 Javascript
使用pm2部署node生产环境的方法步骤
Mar 09 Javascript
jquery操作checkbox的常用方法总结【附测试源码下载】
Jun 10 jQuery
webpack4.0+vue2.0利用批处理生成前端单页或多页应用的方法
Jun 28 Javascript
Vue filter 过滤当前时间 实现实时更新效果
Dec 20 Javascript
JS实现购物车基本功能
Nov 08 Javascript
分享一则javascript 调试技巧
Jan 02 #Javascript
javascript实现无限级select联动菜单
Jan 02 #Javascript
javascript实现表格排序 编辑 拖拽 缩放
Jan 02 #Javascript
原生javascript实现DIV拖拽并计算重复面积
Jan 02 #Javascript
javascript使用smipleChart实现简单图表
Jan 02 #Javascript
原生javascript实现简单的datagrid数据表格
Jan 02 #Javascript
浅谈jQuery事件绑定原理
Jan 02 #Javascript
You might like
详解WordPress开发中过滤属性以及Sql语句的函数使用
2015/12/25 PHP
JavaScript delete 属性的使用
2009/10/08 Javascript
jquery.jstree 增加节点的双击事件代码
2010/07/27 Javascript
js DOM的学习笔记
2011/12/22 Javascript
jQuery学习笔记之总体架构
2014/06/03 Javascript
关于javascript中dataset的问题小结
2015/11/16 Javascript
浅析JavaScript中的变量复制、参数传递和作用域链
2016/01/13 Javascript
Bootstrap整体框架之JavaScript插件架构
2016/12/15 Javascript
JavaScript中英文字符长度统计方法示例【按照中文占2个字符】
2017/01/17 Javascript
vue.js前后端数据交互之提交数据操作详解
2018/04/24 Javascript
vue.js自定义组件directives的实例代码
2018/11/09 Javascript
vue微信分享的实现(在当前页面分享其他页面)
2019/04/16 Javascript
JS实现移动端点击按钮复制文本内容
2019/07/28 Javascript
Vue快速实现通用表单验证的示例代码
2020/01/09 Javascript
移动端JS实现拖拽两种方法解析
2020/10/12 Javascript
Vue实现图书管理案例
2021/01/20 Vue.js
[43:51]2014 DOTA2国际邀请赛中国区预选赛 Dream Times VS TongFu
2014/05/22 DOTA
Python下载网络文本数据到本地内存的四种实现方法示例
2018/02/05 Python
python 自动去除空行的实例
2018/07/24 Python
解决python 无法加载downsample模型的问题
2018/10/25 Python
Python创建字典的八种方式
2019/02/27 Python
Python下利用BeautifulSoup解析HTML的实现
2020/01/17 Python
解决Pymongo insert时会自动添加_id的问题
2020/12/05 Python
深入CSS3 动画效果的总结详解
2013/05/09 HTML / CSS
哈曼俄罗斯官方网上商店:Harman.club
2020/07/24 全球购物
幼儿园家长会邀请函
2014/01/15 职场文书
2014年预备党员学习两会心得体会
2014/03/17 职场文书
市场营销毕业生自荐信范文
2014/04/01 职场文书
党员群众路线对照检查材料
2014/08/31 职场文书
房产协议书范本2014
2014/09/30 职场文书
2014年电厂工作总结
2014/12/04 职场文书
行政处罚决定书
2015/06/24 职场文书
2016学习医德医风心得体会
2016/01/25 职场文书
《田忌赛马》教学反思
2016/02/19 职场文书
Mysql分库分表之后主键处理的几种方法
2022/02/15 MySQL
Python尝试实现蒙特卡罗模拟期权定价
2022/04/21 Python