Ethan's Blog

不负好时光

JS 实现的文章浏览历史记录功能

对于技术类网站常常会针对某一个问题开展讨论或者提供教程,有时候将会分几篇文章来进行讲述,读者在查看这些文章的时候常常会希望能够非常方便地找到自己已经看到过的文章,这次分享的 JS 实现的文章浏览历史记录功能正是如此。

代码并非原创,而是来自 http://www.neoease.com/recently-viewed-items/,鉴于原博主提供的代码和步骤相对来说较为简略,我之前在应用的时候也碰到了一些问题,因此再做一个详细的记录。

准备 JS 文件

首先新建一个 js 文件,命名为 view-history.js,将下面的代码拷入:

/**
* @author: mg12 [http://www.neoease.com/]
* @update: 2013/01/09
*
* IE6/7 need a third-party JSON library to polyfill this feature. [https://github.com/douglascrockford/JSON-js/blob/master/json2.js]
*/

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 [];
    }
};

//初始化
if (typeof localStorage !== 'undefined' && typeof JSON !== 'undefined') {
    var viewHistory = new ViewHistory();
    viewHistory.init({
        limit: 8,
        storeagekey: 'viewHistory',
        primaryKey: 'url'
    });
}

//保存页面信息 如果 ViewHistory 的实例存在,则可以将页面信息写入。
if (viewHistory) {
    var page = {
        "title": document.getElementsByTagName('title')[0].innerHTML,
        "url": location.href // 这是 primaryKey
        // "time": new Date()
        // "author": ...
        // 这里可以写入更多相关内容作为浏览记录中的信息
        // 截断的办法:"title": document.getElementsByTagName('title')[0].innerHTML.split(" | ")[0]
    };
    viewHistory.addHistory(page);
}

var wrap = document.getElementById('view-history');

// 如果 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);
    }
}

页面中引入

首先引入 JS 文件:

<script src=”view-history.js”></script>

再次在需要展示浏览记录的地方写入代码:

<div id=”view-history”></div>

WordPress 中解决只记录文章页的方法

如果在 WordPress 中使用的时候需要只记录文章页而不记录首页和分类页面等其他页面可以在底部加载 JS 文件的时候使用一个判断,只在当前页面为文章页的时候才进行加载:

<?php if ( is_singular() ){ ?>
  <script type="text/javascript" src="<?php bloginfo('template_url'); ?>/js/view-history.js"></script>
<?php } ?>