不会健身的程序员
不是好作家

纯脚本实现用户历史浏览记录

网站右边适当的添加一些小功能可以留住用户的心,比如历史浏览记录,用户在历史浏览记录中找到最近他在这个网站看过的几个文章, 我希望通过这个功能挽留一下读者. 比如: 某人经常通过搜索引擎进来我的网站, 可能发现以前在这里也看过一些文章, 比较合他口味, 久而久之就能发展成常客。

实现原理

这个功能实现非常简单, 平白一点来说就是找个地方将页面一些信息保存起来, 如果页面两次被访问, 新的内容覆盖掉旧的内容; 在页面加载的时候, 将保存的信息取出显示.

实现方法也很多, 最土的是将内容保存在 cookie 中, 但用 cookie 储存数据存在一些问题. 比如: cookie 是随 HTTP 响应一起被发送的, 会对服务器端响应时间产生一定程度的影响, 尤其是在使用 XMLHttpRequest 对象向服务器端发送或请求数据的时候.

利用 cookie 虽然比较土, 但最实用, 因为几乎可以兼容所有浏览器. 我这里使用的 localStorage, 数据完全保存在浏览器中, 不会有影响服务器响应, 但 IE6/7 中不能使用.

这里要完成以下几个功能点:

  • 将存储内容转成数组对象, 因为 localStorage 只能保存字符串.
  • 去重, 如果保存的内容已经存在, 则删除旧数据, 以最新的为准.
  • 限制保存数量, 没有必要无限保存历史导致列表超长.

实现步骤

步骤一:引入viewhistory.js

我已经写好了一个名为 View History 的脚本, 不到 50 行代码, 就是为了实现上述的三个功能. 可以在

下面就是ViewHistory脚本

ViewHistory = function() {

    this.config = {
        limit: 10,
        storageKey: 'viewHistory',
        primaryKey: 'url'
    };

    this.cache = {
        localStorage:  null,
        userData:  null,
        attr:  null
    };
};

ViewHistory.prototype = {

    init: function(config) {
        this.config = config || this.config;
        var _self = this;

        // define localStorage
        if (!window.localStorage && (this.cache.userData = document.body) && this.cache.userData.addBehavior && this.cache.userData.addBehavior('#default#userdata')) {
            this.cache.userData.load((this.cache.attr = 'localStorage'));

            this.cache.localStorage = {
                'getItem': function(key) {
                    return _self.cache.userData.getAttribute(key);
                },
                'setItem': function(key, value) {
                    _self.cache.userData.setAttribute(key, value);
                    _self.cache.userData.save(_self.cache.attr);
                }
            };

        } else {
            this.cache.localStorage = window.localStorage;
        }
    },

    addHistory: function(item) {
        var items = this.getHistories();
        for(var i=0, len=items.length; i<len; i++) {
            if(item[this.config.primaryKey] && items[i][this.config.primaryKey] && item[this.config.primaryKey] === items[i][this.config.primaryKey]) {
                items.splice(i, 1);
                break;
            }
        }

        items.push(item);

        if(this.config.limit > 0 && items.length > this.config.limit) {
            items.splice(0, 1);
        }

        var json = JSON.stringify(items);
        this.cache.localStorage.setItem(this.config.storageKey, json);
    },

    getHistories: function() {
        var history = this.cache.localStorage.getItem(this.config.storageKey);
        if(history) {
            return JSON.parse(history);
        }
        return [];
    }
};
步骤二:添加下面脚本方法
核心代码是上面部分,不过小林还封装了方法给页面调用,小林建议,如果是自己控制js的话,最好把所有js合并成一个(好处随便说2个:1、减少请求次数,2、缓存)参考如下
function linove_viewHistory(config){
    if(typeof localStorage !== 'undefined' && typeof JSON !== 'undefined') {
        var viewHistory = new ViewHistory();
        viewHistory.init({
            limit: config.limit,
            storageKey: config.storageKey,
            primaryKey: config.primaryKey
        });
    }
    // 如果
    var wrap = document.getElementById(config.storageKey);
    if(!viewHistory){
        if(wrap){
            wrap.style.display = 'none';
        }
        return;
    }
    // 如果 ViewHistory 的实例存在,并且外层节点存在,则可显示历史浏览记录
    if(viewHistory && wrap) {
           // 获取浏览记录
        var histories = viewHistory.getHistories();
            // 组装列表
        var list = document.createElement('ul');
        if(histories && histories.length > 0) {
            for(var i=histories.length-1; i>=0; i--) {
                var history = histories[i];
                var item = document.createElement('li');
                var link = document.createElement('a');
                link.href = history.url;
                link.innerHTML = history.title;
                item.appendChild(link);
                list.appendChild(item);
            }
            // 插入页面特定位置
            wrap.appendChild(list);
        }
    }
    if( viewHistory && config.addHistory) {
        var page = {
            "title": document.getElementsByTagName('title')[0].innerHTML.split(config.titleSplit)[0],
            "url": location.href // 这是 primaryKey
            // "time": new Date()
            // "author": ...
            // 这里可以写入更多相关内容作为浏览记录中的信息
        };
        viewHistory.addHistory(page);
    }
}
第三步:在需要添加显示历史记录的地方添加
    <div class="widget" id="linove_viewHistory" >
        <h3>您刚刚看过</h3>
    </div>

这里注意:id属性的值可以随便取,但是后面要用到

第四步,调用脚本方法

你可以在document.onload事件中添加下面代码,也可以在</body>前添加下面脚本

linove_viewHistory({
    limit: 5,
    storageKey: 'linove_viewHistory',
    primaryKey: 'url',
    addHistory:  true;
    titleSplit: '|'
});
  • limit用于记录显示的条数和存储的条数
  • storyageKey用于配置需要显示的id,也代表着localStorage保存这些历史记录的为一个值
  • primaryKey用户表示存储字段中以什么字段作为数据唯一的判断(一般以url)
  • addHistory是否添加历史记录,一般主页不需要保存,而文章页需要保存

    如果你用的是wordpress那可以用下面逻辑判断

    addHistory:  <?php if ( is_single() ) { ?> true <?php }else{ ?>false<?php } ?>,
  • titleSplit用于表示标题以什么作为切割,切割之后取第一截(做seo优化的时候,小林的文章展示页面的表示下面格式)

    文章标题 | 博客名称

    所以记录数据的时候需要截取前半部分。

后话

只用 localStorage 做历史浏览记录不能解决时效性问题, 也就是不能获得最新的文章信息. 如果我将文章评论数加到浏览记录中, 那么用户看到的仅是他访问当时的评论数量. 解决办法是有的, 有些网站只保存文章的 ID, 在页面加载时再动态加载文章信息, 比如: 评论数和平均评价.

在我看来, 作为博客保存到 localStorage 已经足够了

小林注:上面说的功能在ie6,7下无法显示,不过也不影响效果,所以个人建议把需要显示浏览记录的div先隐藏掉,小林已经在脚本中判断是否可以记录数据,如果可以就显示那个div。

赞(0)
转载请注明出处:林俊龙博客 » 纯脚本实现用户历史浏览记录

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址

年年岁岁花相识,岁岁年年人不同

给我留言网站地图

谢主隆恩

支付宝扫一扫打赏

微信扫一扫打赏