29
2013
01

HTML5新特性应用:利用localStorage来处理你的Javascript脚本错误

localStorage作为HTML5中的新特性,它的出现可以说对于前端性能体验来讲可以获得相当大的改善。存储一些用户经常用到而又不是涉及隐私和安全的东西,的确是一个非常好的选择。下面分享一下用localStorage来处理客户端代码错误的例子来了解一下它的用途吧。


对于Javascript脚本的一些不确定性的错误,做前端的人都知道有时候很难捕获。某些错误错误甚至跟一连串的操作有关,那么如何捕捉错误就成了一门可以研究学问,这不是本文的重点,重点是用localStorage在客户端记录下错误,然后用户碰到错误(当然用户不知道脚本错误,只要用户操作出现问题就可以发送错误,这得看我们的代码如何处理用户使用过程中的异常了)可以选择性的发送到服务器。


下面抛砖引玉上代码

核心localStorage管理代码,这里重新对localStorage进行模块化主要是为了将错误信息已JSON的格式记载。代码比较简单,就不解释了。

define(function() {
    var METHOD = {
        GET : 0,
        SET : 1,
        REMOVE : 2,
        CLEAR : 3
    }, 
    _localStorageFactory = function(method, key, value) {
        if(localStorage) {
            switch(method) {
                case METHOD.GET:
                    return localStorage.getItem(key);
                case METHOD.SET:
                    localStorage.setItem(key, value);
                    break;
                case METHOD.REMOVE:
                    localStorage.removeItem(key);
                    break;
                case METHOD.CLEAR:
                    localStorage.clear();
                    break;
            }
            return true;
        }
        return false;
    };
        
    return {
        getItem : function(type, key) {
            var item = JSON.parse(_localStorageFactory(METHOD.GET, type));
            if(item) {
                return item[key];
            }
            return null;
        },
        setItem : function(type, key, value) {
            var item = JSON.parse(_localStorageFactory(METHOD.GET, type));
    
            if(!item) {
                _localStorageFactory(METHOD.SET, type, '{"' + key + '": ' + JSON.stringify(value) + '}');
            } else {
                item[key] = value;
                _localStorageFactory(METHOD.SET, type, JSON.stringify(item));
            }
        },
        removeItem : function(type, key) {
            var items = _localStorageFactory(METHOD.GET, type);
            delete items[key];
    
            _localStorageFactory(METHOD.SET, type, items);
        },
        clear : function(type) {
            _localStorageFactory(METHOD.REMOVE, type);
        },
        clearAll : function() {
            _localStorageFactory(METHOD.CLEAR);
        }
    };
});


错误处理代码,利用window.onerror来捕捉系统错误信息,当然如果其他自定义错误信息完全可以自己定义了。这里只做了系统错误的处理。

require.config({
    baseUrl : '../',
    paths : {
        app : 'demo/msLocalStorage',
        require : 'libs/require',
    }
});
  
require(['jquery', 'modules/msLocalStorage'], function($, msLocalStorage) {
    var type='ERROR_LOG', key = 'SystemError';
    window.onerror = function(msg, url, line) {
        var errorMsg = {
            message : msg,
            url : url,
            line : line,
            datetime : new Date()
        }, value = msLocalStorage.getItem(type, key) || [];
  
        if(value.length > 10) { //just have 10 records are stored
            value.shift();
        }
  
        value.push(errorMsg);
  
        console.log(value);
  
        msLocalStorage.setItem(type, key, value);
  
        //other handle here.
          
        return false;
    };
      
    $(document).ready(function(){
        $('#btnCreateScriptError').click(function(){
            alert(a);
        });
          
        $('#btnCreateCatchError').click(function(){
            try{
                alert(a);
            }
            catch(e){
                throw 'error! error!!'+ e.message;
            }
        });
          
        $('#btnSubmit').click(function(){
            var value = msLocalStorage.getItem(type, key);
              
            // You can use ajax send the value to server
              
            alert('成功发送错误信息到后台!');
        });
    });
});


基本HTML代码

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="utf-8" />
        <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
        <title>use localstorage to create log error</title>
        <script data-main="apps/msLocalStorage.js" src="../libs/require-jquery.js"></script>
        <style type="text/css">
            body{
                font-size: 11px;
            }
            div{
                margin: 50px;
                width: 400px;
                border: 1px solid #ccc;
            }
            label{
                display: inline-block;
                width: 100px;
            }
            p{
                padding: 5px 20px;
            }
        </style>
    </head>
    <body>
        <div id="container2">
            <p>请用调试工具查看错误打印信息</p>
            <p><input type="button" id="btnCreateScriptError" value="产生一个脚本错误" /></p>
            <p><input type="button" id="btnCreateCatchError" value="产生一个抛出脚本错误" /></p>
            <p><input type="button" id="btnSubmit" value="提交错误到后台" /></p>
        </div>
    </body>
</html>


代码使用require.js来管理处理Javascript,大家可以自己去了解这方面的信息。


关于兼容性:

你问我IE6,IE7...一系列的低版本浏览器不支持怎么办?


答:确实这里只考虑了支持HTML5的浏览器。对于低版本浏览器那么我的见解是让用户少一个报告体验,相信还是说得过去的。理由有些牵强,但如果你的产品能很好的引导,让用户能换最新浏览器玩得更嗨,体验更爽,用户是愿意的。这得看你的用户群体是否为那个愿意接受新事物的群体啦,这里涉及太多,省略N个字。


当然对于本地存储低版本浏览器也是有的,科普一下Javascript对浏览器本地存储的方案吧.


Cookie: 在web中得到广泛应用,但局限性非常明显,容量太小,有些站点会因为出于安全的考虑而禁用cookie,cookie没有想象中的那么安全,Cookie 的内容会随着页面请求一并发往服务器。


Flash SharedObject: 使用的是kissy的store模块来调用Flash SharedObject。Flash SharedObject的优点是容量适中,基本上不存在兼容性问题,缺点是要在页面中引入特定的swf和js文件,增加额外负担,处理繁琐;还是有部分机子没有flash运行环境。


Google Gears: Google的离线方案,已经停止更新,官方推荐使用html5的localStorage方案。


User Data: 是微软为IE专门在系统中开辟的一块存储空间,所以说只支持Windows+IE的组合,实际测试在2000(IE5.5)、XP(IE6、IE7),Vista(IE7)下都是可以正常使用的。在XP下,一般位于C:\Documents and Settings\用户名\UserData,有些时候会在C:\Documents and Settings\用户名\Application Data\Microsoft\Internet Explorer\UserData。在Vista下,位于C:\Users\用户名\AppData\Roaming\Microsoft\Internet Explorer\UserData;单个文件的大小限制是128KB,一个域名下总共可以保存1024KB的文件,文件个数应该没有限制。在受限站点里这两个值分别是64KB和640KB,所以如果考虑到各种情况的话,单个文件最好能控制64KB以下。


localStorage: 相对于上述本地存储方案,localStorage有自身的优点:容量大、易用、强大、原生支持;缺点是兼容性差些(chrome, safari, firefox,IE 9,IE8都支持 localStorage,主要是IE8以下版本不支持)、安全性也差些(所以请勿使用localStorage保存敏感信息)。


关于用户体验:

用户不愿意点这个发送错误按钮怎么办?用户为什么会知道错误了?

答:这里还是引导。web2.0后用户在浏览网页的时候做的事多了,乐趣也多了。大部分用户愿意尝试点击页面上的新玩意儿。如何引导?此处省略N字,交给UI设计师和PM处理。


用户不愿意做,没关系。既然客户机本地有存储,我们也可以在不经意的一个时刻把错误返回到服务端,ajax不就是处理这种问题的吗!至于什么时间,大侠们自己分析吧。

« 上一篇下一篇 »

评论列表:

发表评论:

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。