Node.js 实现简单的无侵入式缓存框架的方法

python 的flask.ext.cache 通过注解这样对方法返回结果进行缓存:

@cache.cached(timeout=300, key_prefix='view_%s', unless=None) def hello(name=None): print 'view hello called' return render_template('hello.html', name=name)

这类实现方式对业务逻辑没有丝毫的侵入性,非常之优雅。

最近在做 Node.js 地项目,然而 js ES 7 之前都不支持注解,目前见到的缓存框架虽然在 API 设计上都很简洁、很有想法。

可是痛点在于它们都是侵入式的,需要在业务逻辑代码中插入缓存逻辑,这些方式很不优雅。

正题

今天花点时间研究下js有没有办法,以比较优雅地方法实现缓存。

我对缓存框架的诉求:

不对原方法进行更改

能实现对不同参数地缓存

支持缓存时间

我了解到的 js 能力:

隐藏参数arguments可以获取参数列表

prototype 可用来重写覆盖原方法

可行性?

看了看 

直觉告诉我看起来可行,以下是官方的说明:

当一个函数被调用时,调用的参数被保留在类似数组 "变量" 的参数中。例如, 在调用 "myFn (a、b、c)"时, 在myFn 的主体内的参数将包含 3个类似数组的元素对应于 (a、b、c)。 使用钩子修改原型时,只需通过调用该函数的 apply (),将 this 与参数 (调用状态) 传递给当前行为。这种模式可以用于任何原型,如 Node.prototype、 Function.prototype 等.

var current = Object.prototype.valueOf; // 由于我的属性 "-prop-value"是交叉性的, 并不总是 // 在同一个原型链上,我想要修改 Object.prototype: Object.prototype.valueOf = function() { if (this.hasOwnProperty('-prop-value')) { return this['-prop-value']; } else { // 它看起来不像我的对象之一,因此,让我们退回到 // 默认行为,通过尽可能地复制当前行为来实现. // 此apply的行为类似于其他语言中的"super". // 即使 valueOf() 不带参数, 其他的钩子可能会带有. return current.apply(this, arguments); } }

从示例不难看出,我可以在某些条件下通过 apply() 方法调用函数原逻辑,某些条件执行我需要的新逻辑。

写个 demo 测试一下

// 重写Function的原型方法cache Function.prototype.cache = function () { var _self = this; return function() { console.log('arguments', arguments); var key = arguments[0]; if (cache.has(key)) { return cache.get(key) } else { return _self.apply(this, arguments) } } }

定义 cache,当且仅当 key 为 1 时有值

var cache = { has: (key) => { if (key === 1) return true else return false }, get: (key) => { return "cached value " + key } }

定义测试方法

function request(key) { return 'value of ' + key }

应用注入

request = request.cache()

执行一下

request(2) "value of 2" request(1) "cached value 1"

看到结果按照预期输出,完美!

最后实现

项目引用了 memory-cache 作为基础缓存库,实现了相关的缓存功能。

simple-cache.js const cache = require('memory-cache'); Function.prototype.cache = function (cachekey, time) { var _self = this; return function() { var key = cachekey(arguments); var value = cache.get(key); if (!value) { value = _self.apply(this, arguments) cache.put(key, value, time); } return value; } } var simpleCache = { cache: function(f, cacheKey, cacheTime) { return f.cache(cacheKey, cacheTime); } } module.exports = simpleCache sample.js const cache = require('simple-cache-z').cache; function cachekey(args) { return args[0] } function request(key) { return (new Date()).getTime(); } request = cache(request, cachekey, 5000); console.log('request 1 ', request(1)); setTimeout(() => { console.log('request 2 ', request(2)); }, 1000) setTimeout(()=> { console.log('request 1 ', request(1)) console.log('request 1 ', request(1)) console.log('request 1 ', request(1)) console.log('request 2 ', request(2)); console.log('request 2 ', request(2)); console.log('request 2 ', request(2)); }, 2000); setTimeout(()=> { console.log('request 1 ', request(1)); console.log('request 1 ', request(1)); console.log('request 1 ', request(1)); console.log('request 2 ', request(2)); console.log('request 2 ', request(2)); console.log('request 2 ', request(2)); }, 10000);

输出结果

request 1  1563000551142
// 1000 ms
request 2  1563000552150
// 2000 ms
request 1  1563000551142
request 1  1563000551142
request 1  1563000551142
request 2  1563000552150
request 2  1563000552150
request 2  1563000552150
// 10000 ms
request 1  1563000561151
request 1  1563000561151
request 1  1563000561151
request 2  1563000561151
request 2  1563000561151
request 2  1563000561151

大功告成!

今日研究成果

事实证明方案可行,应用到我的项目中对执行效率和代码可读性的提升非常明显。

我已经把框架打成了包,上传到 npm 仓库 simple-cache-z ,可通过如下方式引用。

npm install --save simple-cache-z

用法和代码上传至 github 仓库,欢迎提交代码和 star:

https://github.com/auv1107/simple-cache-nodejs

总结

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:http://www.heiqu.com/e8929244a64b3dc77fdf714417ad6b16.html