Cache
多级缓存
weroll中设计了一套多级缓存系统, 默认支持二级缓存, 一级缓存使用memory-cache库对内存读写, 二级缓存使用redis.
使用 weroll/model/Model 对象就可以进行缓存读写
| Method | Description |
| Model.cacheSave | |
| Model.cacheRead | |
| Model.cacheRemove | |
| Model.setExpireTime | |
| Model.refreshExpireTime | |
示例代码如下：
var Model = require("weroll/model/Model");
//callBack
Model.cacheSave("name", "Jay", function(err) {
if (err) return console.error(err);
//saved, then try to read
Model.cacheRead("name", function(err, value) {
if (err) return console.error(err);
//read
console.log(value); //echo "Jay"
});
});
//Promise
Model.cacheSave("name", "Jay").then(function() {
//saved, then try to read
Model.cacheRead("name").then(function(value) {
//read
console.log(value); //echo "Jay"
});
});
//async & await
async function() {
//save
var result = await Model.cacheSave("name", "Jay");
console.log(result); //echo "Jay"
//read
result = await Model.cacheRead("name");
console.log(result); //echo "Jay"
}
/********************* 二级缓存读写 *********************/
async function() {
//save into Level-2, and will expire after 5 seconds
var person = { name:"Jay" };
await Model.cacheSave("person", person, 5, 2);
//read from Level-2
var result = await Model.cacheRead("person", 2);
console.log(result); //echo { "name":"Jay" }
console.log(result.name); //echo "Jay"
//sleep 6 seconds, and read again
setTimeout(function() {
result = await Model.cacheRead("person", 2);
console.log(result); //echo undefined
}, 6000);
}
缓存配置
weroll的多级缓存配置可以实现一级和二级缓存联动刷新，即允许用户通过配置，缓存数据时，同时存储到一级和二级缓存里（即内存和redis里）并设置不同的失效时间；在读取缓存时，weroll会优先从一级缓存读取数据，若数据失效则自动从二级缓存读取数据，并将数据重新写到一级缓存中。
缓存配置文件是 ./server/config/%ENV%/cache.config，示例如下：
{
"general": {
"user_info": { "level":0, "expired.1":600, "expired.2":86400 },
"key-1": { "level":1, "expired.1":600 },
"key-2": { "level":2, "expired.2":600 }
}
}
一个典型的缓存配置如下：
"key":{ "level":LEVEL, "expired.1":LEVEL_1_EXPIRE_TIME, "expired.2":LEVEL_2_EXPIRE_TIME }
- key定义缓存的键值
- level定义缓存的级别，1表示一级缓存，2表示二级缓存，0表示一、二级缓存同时使用
- expired.1定义一级缓存过期时间，单位是秒
- expired.2定义二级缓存过期时间，单位是秒
使用cache.config配置的缓存，在使用时可以不需要指定level，weroll将自动识别该键值使用的缓存等级。示例代码如下：
/* ./server/config/%ENV%/cache.config
define a cache using Level-2
*/
"my_key": { "level":2, "expired.2":600 }
/* somewhere */
var Model = require("weroll/model/Model");
//save to Level-2
await Model.cacheSave("my_key", "Jay");
//read
var result = await Model.cacheRead("my_key");
console.log(result); //echo "Jay"
//or
result = await Model.cacheRead("my_key", 2);
console.log(result); //echo "Jay"
//but no cache in Level-1
result = await Model.cacheRead("my_key", 1);
console.log(result); //echo undefined
注意：在cache.config中，user_info 这个缓存配置被用来处理weroll的Session读写，如果要使用weroll原生的Session功能，请保留这个缓存配置。
扩展N级缓存
如果开发者希望使用文件系统或其他方式来处理缓存, 可以自行扩展三级缓存或更高级别的缓存, 开发者需要实现一个缓存处理对象, 该对象需要实现以下方法:
/* cache handler */
exports.setExpireTime = function(key, val) {
//实现设置缓存失效时间
}
exports.registerExpiredTime = function(key, expireTime) {
//实现预先注册缓存失效时间, 方便在使用时可以不再显式指定失效时间
}
exports.save = function(key, val, expireTime, callBack) {
//实现写缓存, 需要返回Promise对象
return new Promise(function(resolve, reject) {
//your codes
//如果callBack存在, 则使用callBack, 不使用resolve和reject
});
}
exports.read = function(key, callBack) {
//实现读缓存, 需要返回Promise对象
return new Promise(function(resolve, reject) {
//your codes
//如果callBack存在, 则使用callBack, 不使用resolve和reject
});
}
exports.remove = function(key, callBack) {
//实现删除缓存, 需要返回Promise对象
return new Promise(function(resolve, reject) {
//your codes
//如果callBack存在, 则使用callBack, 不使用resolve和reject
});
}
我们用文件系统缓存作为示例:
/* somewhere */
var Model = require("weroll/model/Model");
var FileCache = {};
FileCache.setExpireTime = function(key, val) {
//暂不实现
}
FileCache.registerExpiredTime = function(key, expireTime) {
//暂不实现
}
FileCache.save = function(key, val, expireTime, callBack) {
return new Promise(function(resolve, reject) {
if (key instanceof Array) key = key.join("-");
var cache = typeof val == "object" ? JSON.stringify(val) : val;
fs.writeFile(path.join(CACHE_FOLDER, key), cache, { encoding:"utf8" }, function(err) {
if (callBack) return callBack(err, val);
err ? reject(err) : resolve(val);
});
});
}
FileCache.read = function(key, callBack) {
return new Promise(function(resolve, reject) {
if (key instanceof Array) key = key.join("-");
fs.readFile(path.join(CACHE_FOLDER, key), { encoding:"utf8" }, function(err, cache) {
if (err && err.code == "ENOENT") {
//file is not exist
err = null;
cache = null;
}
var val = cache;
if (val) {
try {
val = JSON.parse(cache);
} catch (exp) {
//it is a non-object value
val = cache;
}
}
if (callBack) return callBack(err, val);
err ? reject(err) : resolve(val);
});
});
}
FileCache.remove = function(key, callBack) {
return new Promise(function(resolve, reject) {
if (key instanceof Array) key = key.join("-");
fs.unlink(path.join(CACHE_FOLDER, key), function(err) {
if (err && err.code == "ENOENT") {
//no such file, ignores this error
err = null;
}
if (callBack) return callBack(err);
err ? reject(err) : resolve();
});
});
}
//注册为第三级缓存
Model.registerCacheSystem(3, FileCache);
/***************** Test *****************/
var val = { name:"Jay" };
var result = await Model.cacheSave("user", val, null, 3);
assert(result);
assert.equal(result, val);
result = await Model.cacheRead("user", 3);
assert(result);
assert.equal(result.name, val.name);
await Model.cacheRemove("user", 3);
result = await Model.cacheRead("user", 3);
assert.equal(result, undefined);
具体代码请参考Model的测试用例.