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 相关文章推荐
引用外部脚本时script标签关闭的写法
Jan 20 Javascript
完美兼容各大浏览器的jQuery仿新浪图文淡入淡出间歇滚动特效
Nov 12 Javascript
创建、调用JavaScript对象的方法集锦
Dec 24 Javascript
javascript实现平滑无缝滚动
Aug 09 Javascript
jQuery解决$符号命名冲突
Jun 18 Javascript
JavaScript比较当前时间是否在指定时间段内的方法
Aug 02 Javascript
前端把html表格生成为excel表格的实例
Sep 19 Javascript
详解angularjs popup-table 弹出框表格指令
Sep 20 Javascript
Javascript通过控制类名更改样式
May 24 Javascript
vue把输入框的内容添加到页面的实例讲解
Nov 11 Javascript
Vue数据双向绑定底层实现原理
Nov 22 Javascript
Ant Design的可编辑Tree的实现操作
Oct 31 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
PHP Session_Regenerate_ID函数双释放内存破坏漏洞
2011/01/27 PHP
使用配置类定义Codeigniter全局变量
2014/06/12 PHP
thinkPHP5框架实现基于ajax的分页功能示例
2018/06/12 PHP
双击滚屏-常用推荐
2006/11/29 Javascript
javascript function调用时的参数检测常用办法
2010/02/26 Javascript
brook javascript框架介绍
2011/10/10 Javascript
jQuery使用$.get()方法从服务器文件载入数据实例
2015/03/25 Javascript
Struts2+jquery.form.js实现图片与文件上传的方法
2016/05/05 Javascript
简单实现js间歇或无缝滚动效果
2016/06/29 Javascript
利用angularjs1.4制作的简易滑动门效果
2017/02/28 Javascript
整理关于Bootstrap警示框的慕课笔记
2017/03/29 Javascript
jquery与js实现全选功能的区别
2017/06/11 jQuery
Windows下使用Nodejs运行js的方法
2017/09/02 NodeJs
bootstrap Table服务端处理分页(后台是.net)
2017/10/19 Javascript
微信小程序实现手势图案锁屏功能
2018/01/30 Javascript
es6数值的扩展方法
2019/03/11 Javascript
使用typescript快速开发一个cli的实现示例
2020/12/09 Javascript
[29:59]完美世界DOTA2联赛PWL S3 Forest vs access 第二场 12.11
2020/12/13 DOTA
python3.0 字典key排序
2008/12/24 Python
python 实现将字典dict、列表list中的中文正常显示方法
2018/07/06 Python
Python实现获取汉字偏旁部首的方法示例【测试可用】
2018/12/18 Python
python中while和for的区别总结
2019/06/28 Python
详解python播放音频的三种方法
2019/09/23 Python
python实现跨excel sheet复制代码实例
2020/03/03 Python
在线购买廉价折扣书籍和小说:BookOutlet.com
2018/02/19 全球购物
PyQt 如何创建自定义QWidget
2021/03/24 Python
中专生毕业自我鉴定
2013/11/01 职场文书
报表员工作失误检讨书范文
2014/09/19 职场文书
2014领导班子专题民主生活会对照检查材料思想汇报
2014/09/23 职场文书
我的中国梦主题教育活动总结
2015/05/07 职场文书
2015年度电厂个人工作总结
2015/05/13 职场文书
投资申请报告
2015/05/19 职场文书
周末问候语大全
2015/11/10 职场文书
详解MySQL 用户权限管理
2021/04/20 MySQL
python和C/C++混合编程之使用ctypes调用 C/C++的dll
2022/04/29 Python
MySQL数据库中的锁、解锁以及删除事务
2022/05/06 MySQL