mm_redis 1.4.1 → 1.4.2

package/index.js

@@ -99,7 +99,6 @@ Redis.prototype.main = async function(channel, message) {};
  * @param {String} message 消息
  */
 Redis.prototype.message = function(channel, message) {
-	console.log("我接收到信息了" + message);
 	var func = this.func_list[channel];
 	if (func) {
 		func(message);
@@ -314,6 +313,9 @@ Redis.prototype.del = function(key) {
 Redis.prototype.set = function(key, value, seconds) {
 	var _this = this;
 	return new Promise((resolve, reject) => {
+		if (typeof(value) == "object") {
+			value = JSON.stringify(value);
+		}
 		_this.conn.set(key, value, function(err, ret) {
 			if (err) {
 				reject(err);
@@ -369,11 +371,18 @@ Redis.prototype.add = function(key, value, seconds) {
 Redis.prototype.get = function(key) {
 	var _this = this;
 	return new Promise((resolve, reject) => {
-		_this.conn.get(key, function(err, ret) {
+		_this.conn.get(key, function(err, value) {
 			if (err) {
 				reject(err);
 			} else {
-				resolve(ret);
+				if (typeof(value) == "string") {
+					if (value.startsWith("{") && value.endsWith("}")) {
+						value = JSON.parse(value);
+					} else if (value.startsWith("[") && value.endsWith("]")) {
+						value = JSON.parse(value);
+					}
+				}
+				resolve(value);
 			}
 		});
 	});
@@ -670,4 +679,4 @@ function redis_admin(scope, dir) {
 /**
  * @description 导出redis管理函数
  */
-exports.redis_admin = redis_admin;
+exports.redis_admin = redis_admin;

package/index_new.js

@@ -0,0 +1,585 @@
+/**
+ * @fileOverview redis缓存帮助类函数
+ * @author <a href="http://qww.elins.cn">邱文武</a>
+ * @version 1.2
+ * redis: ^4.7.0
+ */
+require('mm_expand');
+const {
+	createClient
+} = require('redis');
+
+/* 创建Redis帮助类函数 */
+/// 构造函数
+class Redis {
+	/**
+	 * @description 创建Redis帮助类函数 (构造函数)
+	 * @param {String} scope 作用域
+	 * @param {String} dir 当前路径
+	 * @constructor
+	 */
+	constructor(scope, dir) {
+		// 作用域
+		this.scope;
+		if (scope) {
+			this.scope = scope;
+		} else {
+			this.scope = $.val.scope + '';
+		}
+		// 当前目录
+		this.dir = __dirname;
+		if (dir) {
+			this.dir = dir;
+		}
+
+		// 配置参数
+		this.config = {
+			// 服务器地址
+			"host": "localhost",
+			// 端口号
+			"port": 6379,
+			// 密码
+			"password": "asd123",
+			// 数据库
+			"database": 0,
+			// 前缀
+			"prefix": ""
+		};
+		// 唯一标识符
+		this.identifier = this.config.host + "/" + this.config.database;
+		// 数据库连接器
+		this.conn;
+
+		// 订阅回调函数
+		this.func_list = {};
+	}
+}
+
+/**
+ * 消息订阅
+ * @param {String} channel 订阅的频道
+ * @param {Function} func 操作回调函数，可判断成功与否
+ */
+Redis.prototype.subscribe = function(channel, func) {
+	this.conn.subscribe(channel);
+	this.func_list[channel] = func;
+};
+
+/**
+ * 取消订阅
+ * @param {String} channel 订阅的频道
+ */
+Redis.prototype.unsubscribe = function(channel) {
+	this.conn.unsubscribe(channel);
+	delete this.func_list[channel];
+};
+
+/**
+ * 发布消息
+ * @param {String} channel 频道
+ * @param {String} message 订阅的消息
+ * @param {Function} func 消息发布成功回调函数
+ */
+Redis.prototype.publish = function(channel, message, func) {
+	this.conn.publish(channel, message, func);
+};
+
+/**
+ * 订阅消息处理, 如果没有订阅函数，则其他的订阅消息会进入该函数
+ * @param {String} channel
+ * @param {String} message
+ */
+Redis.prototype.main = async function(channel, message) {};
+
+/**
+ * 消息通知
+ * @param {String} channel 频道
+ * @param {String} message 消息
+ */
+Redis.prototype.message = function(channel, message) {
+	var func = this.func_list[channel];
+	if (func) {
+		func(message);
+	} else {
+		this.main(channel, message);
+	}
+};
+
+/**
+ * @description 设置配置
+ * @param {Object} cg 配置对象或配置路径
+ */
+Redis.prototype.setConfig = function(cg) {
+	var obj;
+	if (typeof(cg) === "string") {
+		obj = cg.loadJson(this.dir);
+	} else {
+		obj = cg;
+	}
+	$.push(this.config, obj, true);
+	this.identifier = this.config.host + "/" + this.config.database;
+};
+
+/**
+ * @description 连接Redis数据库
+ */
+Redis.prototype.open = async function() {
+	var cg = this.config;
+	var password = cg.password;
+	if (!this.conn) {
+		var _this = this;
+		this.conn = await createClient(cg).on("ready", function() {
+			// 监听订阅成功事件
+			this.on("subscribe", function(channel, count) {
+				console.log("频道" + channel + "订阅成功, 当前总计订阅数：" + count);
+			});
+			// 监听取消订阅事件
+			this.on("unsubscribe", function(channel, count) {
+				console.log("频道" + channel + "取消订阅, 当前总计订阅数：" + count);
+			});
+			// 收到消息后执行回调，message是redis发布的消息
+			this.on("message", (channel, message) => {
+				this.message(channel, message);
+			});
+		}).connect();
+		if (password) {
+			this.conn.auth({
+				password
+			});
+		}
+	}
+
+};
+
+/**
+ * @description 关闭连接
+ */
+Redis.prototype.close = function() {
+	var cg = this.config;
+	if (this.conn) {
+		this.conn.quit();
+		this.conn = null;
+	}
+};
+
+/**
+ * @description 查询或是设置缓存过期时间
+ * @param {String} key 键
+ * @param {Number} seconds 秒, 为空则查询有效时长
+ * @return {Promise|Number|Boolean} 查询时长或设置结果, 时长为-1表示永不过期
+ */
+Redis.prototype.ttl = async function(key, seconds) {
+	var ret;
+	if (seconds) {
+		if (seconds > 0) {
+			ret = await this.conn.expire(key, seconds);
+		} else {
+			ret = await this.conn.persist(key);
+		}
+	} else {
+		ret = await this.conn.ttl(key);
+	}
+	return ret;
+};
+
+/**z
+ * @description 增加整数值(负数为减)
+ * @param {String} key 键
+ * @param {Number} num 数值
+ * @return {Promise|Number} 计算后的结果
+ */
+Redis.prototype.addInt = async function(key, num) {
+	var value = await this.get(key);
+	var n = 0;
+	if (value) {
+		n = Number(value);
+	}
+	n += num;
+	this.set(key, n);
+	return n;
+};
+
+/**
+ * @description 增加浮点数值(负数为减)
+ * @param {String} key 键
+ * @param {Number} num 数值
+ * @return {Promise|Number} 计算后的结果
+ */
+Redis.prototype.addFloat = async function(key, num) {
+	var value = await this.get(key);
+	var n = 0;
+	if (value) {
+		n = Number(value);
+	}
+	n += num;
+	this.set(key, n);
+	return n;
+};
+
+/**
+ * @description 增加字符串值到指定缓存
+ * @param {String} key 键
+ * @param {String} str 添加的字符串
+ * @return {Promise|String} 添加后的字符串
+ */
+Redis.prototype.addStr = async function(key, str) {
+	var ret = 0;
+	try {
+		ret = await this.conn.append(key, str);
+	} catch (err) {
+		console.error(err);
+	}
+	return ret;
+};
+
+/**
+ * @description 删除缓存
+ * @param {String} key 键
+ * @return {Promise|Boolean} 成功返回true,失败返回false
+ */
+Redis.prototype.del = async function(key) {
+	var n = await this.conn.del(key);
+	return n === 1;
+};
+
+/**
+ * @description 修改缓存
+ * @param {String} key 键
+ * @param {Object} value 值
+ * @param {Number} seconds 秒
+ * @return {Object} 值
+ */
+Redis.prototype.set = async function(key, value, seconds) {
+	if (typeof(value) == "object") {
+		value = JSON.stringify(value);
+	}
+	var ret;
+
+	try {
+		if (seconds) {
+			ret = await this.conn.set(key, value, {
+				EX: seconds,
+				NX: true
+			});
+		} else {
+			ret = await this.conn.set(key, value);
+		}
+	} catch (err) {
+		console.log(err);
+	}
+	return ret === "OK";
+};
+
+/**
+ * @description 判断键是否存在
+ * @param {String} key 键
+ * @return {Promise|Boolean} 有返回true, 没有返回false
+ */
+Redis.prototype.has = async function(key) {
+	var has = await this.conn.exists(key);
+	if (has) {
+		return true
+	}
+	return false;
+};
+
+/**
+ * @description 修改缓存
+ * @param {String} key 键
+ * @param {Object} value 值
+ * @param {Number} seconds 秒
+ * @return {Promise|Object} 值
+ */
+Redis.prototype.add = async function(key, value, seconds) {
+	var has = await this.has(key);
+	if (has) {
+		return false
+	}
+	return await this.set(key, value, seconds);
+};
+
+/**
+ * @description 查询缓存
+ * @param {String} key 键
+ * @return {Promise|Object} 查询值
+ */
+Redis.prototype.get = async function(key) {
+	var value = await this.conn.get(key);
+	if (typeof(value) == "string") {
+		if (value.startsWith("{") && value.endsWith("}")) {
+			value = JSON.parse(value);
+		} else if (value.startsWith("[") && value.endsWith("]")) {
+			value = JSON.parse(value);
+		}
+	}
+	return value;
+};
+
+/**
+ * @description 查询缓存的字符串中的一段字符串
+ * @param {String} key 键
+ * @param {Number} start 开始位置
+ * @param {Number} end 结束位置
+ * @return {Promise|String} 查询值
+ */
+Redis.prototype.getrange = function(key, start, end) {
+	var _this = this;
+	return new Promise((resolve, reject) => {
+		_this.conn.getrange(key, start, end, function(err, ret) {
+			if (err) {
+				reject(err);
+			} else {
+				resolve(ret);
+			}
+		});
+	});
+};
+
+/**
+ * 在指定位置插入文本
+ * @param {String} str 原字符串
+ * @param {Number} index 索引
+ * @param {String} str_sub 插入的字符串
+ */
+Redis.prototype.insertString = function(str, index, str_sub) {
+	return str.substring(0, index) + str_sub + str.substring(index);
+}
+
+/**
+ * @description 在值的指定位置开始增加一段字符串
+ * @param {String} key 键
+ * @param {Number} index 开始位置
+ * @param {String} value 变更的值
+ * @return {Promise|Number} 字符串长度
+ */
+Redis.prototype.setrange = async function(key, index, value) {
+	var str = await this.get(key);
+	if (str && str.length > index) {
+		str = this.insertString(str, index, value);
+		await this.set(key, str);
+	}
+	return str
+};
+
+/**
+ * @description 清空缓存
+ * @param {String} key 键, 为空则清空所有
+ * @return {Promise|Array} 执行结果
+ */
+Redis.prototype.clear = async function(key) {
+	var ret;
+	if (key) {
+		ret = await this.conn.del(key);
+	} else {
+		console.log(this.conn);
+		ret = await this.conn();
+	}
+	return ret;
+};
+
+/**
+ * @description 排序
+ * @param {String} key 键
+ * @param {String} way = [asc|desc]排序方式, 可以为空
+ * @param {String} obj_key 排序成员的键
+ * @return {Promise|Array} 排序后的数组
+ */
+Redis.prototype.sort = function(key) {
+	var _this = this;
+	return new Promise((resolve, reject) => {
+		_this.conn.sort(key, function(err, ret) {
+			if (err) {
+				reject(err);
+			} else {
+				resolve(ret);
+			}
+		});
+	});
+};
+
+/**
+ * @description 获取所有键名
+ * @param {String} key 键 支持*号, 前面加*表示后面名称一致, 前后加*表示包含名称, 后面加*表示前面名称一致
+ * @return {Promise|Array} 键数组
+ */
+Redis.prototype.keys = function(key) {
+	var _this = this;
+	if (!key) {
+		key = "*";
+	}
+	return new Promise((resolve, reject) => {
+		_this.conn.keys(key, function(err, ret) {
+			if (err) {
+				reject(err);
+			} else {
+				resolve(ret);
+			}
+		});
+	});
+};
+
+/**
+ * @description 修改数组缓存
+ * @param {String} key 键
+ * @param {Object} value 值
+ * @param {Number} seconds 秒
+ * @return {Promise|Array} 执行结果
+ */
+Redis.prototype.list_set = function(key, value, seconds) {
+	var _this = this;
+	return new Promise((resolve, reject) => {
+		_this.conn.rpush(key, value, function(err, ret) {
+			if (err) {
+				reject(err);
+			} else {
+				if (seconds) {
+					_this.conn.expire(key, seconds);
+				}
+				resolve(ret);
+			}
+		});
+	});
+};
+
+/**
+ * @description 数组缓存追加对象
+ * @param {String} key 键
+ * @param {Object} value 值
+ * @return {Promise|String} 追加后的数组
+ */
+Redis.prototype.list_push = function(key, value) {
+	var _this = this;
+	return new Promise((resolve, reject) => {
+		_this.conn.rpush(key, value, function(err, ret) {
+			if (err) {
+				reject(err);
+			} else {
+				resolve(ret);
+			}
+		});
+	});
+};
+
+/**
+ * @description 判断成员是否存在
+ * @param {String} key 键
+ * @param {Object} value 值
+ * @return {Promise|Boolean} 存在返回true, 否则返回false
+ */
+Redis.prototype.list_has = function(key, value) {
+	var _this = this;
+	return new Promise(async (resolve, reject) => {
+		if (!value) {
+			reject('值不能为空');
+		}
+		var arr = await _this.list_get(key);
+		var has = false;
+		var len = arr.length;
+		for (var i = 0; i < len; i++) {
+			if (value == arr[i]) {
+				has = true;
+				break;
+			}
+		}
+		resolve(has);
+	});
+};
+
+/**
+ * @description 查询数组缓存
+ * @param {String} key 键
+ * @param {Number} start 起始位置
+ * @param {Number} end 结束位置
+ * @return {Promise|Array} 查询到的数组
+ */
+Redis.prototype.list_get = function(key, start, end) {
+	var _this = this;
+	if (start === undefined) {
+		start = 0;
+	}
+	if (end === undefined) {
+		end = -1;
+	}
+	return new Promise((resolve, reject) => {
+		_this.conn.lrange(key, start, end, function(err, ret) {
+			if (err) {
+				reject(err);
+			} else {
+				resolve(ret);
+			}
+		});
+	});
+};
+
+/**
+ * @description 清空数组缓存
+ * @param {String} key 键
+ * @param {Array} value 新成员, 没有则删除数组
+ * @return {Promise|Boolean} 成功返回true，是否返回false
+ */
+Redis.prototype.list_clear = function(key, value) {
+	var _this = this;
+	return new Promise((resolve, reject) => {
+		if (key) {
+			if (value) {
+				// 如果有值则删除其他成员，保留新值
+				_this.list_push(key, value).then(function(len) {
+					_this.conn.ltrim(key, len - value.length, len - 1, function(err, ret) {
+						if (err) {
+							reject(err);
+						} else {
+							resolve(ret === "OK");
+						}
+					});
+				}, function(er) {
+					reject(er);
+				});
+			} else {
+				// 直接删除键
+				_this.conn.del(key, function(err, ret) {
+					if (err) {
+						reject(err);
+					} else {
+						resolve(ret === "OK");
+					}
+				});
+			}
+		} else {
+			reject('键不能为空');
+		}
+	});
+};
+/**
+ * @description 导出Redis类
+ */
+exports.Redis = Redis;
+
+/**
+ * @description redis连接池
+ */
+if (!$.pool.redis) {
+	$.pool.redis = {};
+}
+
+/**
+ * @description 缓存管理器，用于创建缓存
+ * @param {String} scope 作用域
+ * @param {String} dir 当前路径
+ * @return {Object} 返回一个缓存类
+ */
+function redis_admin(scope, dir) {
+	if (!scope) {
+		scope = $.val.scope
+	}
+	var obj = $.pool.redis[scope];
+	if (!obj) {
+		$.pool.redis[scope] = new Redis(scope, dir);
+		obj = $.pool.redis[scope];
+	}
+	return obj;
+}
+
+/**
+ * @description 导出redis管理函数
+ */
+exports.redis_admin = redis_admin;

package/package.json

@@ -1,10 +1,11 @@
 {
     "name": "mm_redis",
-    "version": "1.4.1",
+    "version": "1.4.2",
     "description": "这是超级美眉redis缓存帮助类",
     "main": "index.js",
     "scripts": {
-        "test": "node test.js"
+        "test": "node test.js",
+		"dev": "nodemon test.js"
     },
     "repository": {
         "type": "git",
@@ -26,7 +27,7 @@
     },
     "homepage": "https://github.com/qiuwenwu/mm_redis#readme",
     "dependencies": {
-        "mm_expand": "^1.7.0",
-        "redis": "^2.8.0"
+        "mm_expand": "^1.7.2",
+		"redis": "^2.8.0"
     }
 }

package/test.js

@@ -5,58 +5,89 @@ async function test() {
 	var rs = new Redis();
 	var config = './config.json'.loadJson(__dirname);
 	rs.setConfig(config);
-	rs.open();
+	await rs.open();
 	// await rs.set("a", "张三", 10);
 	// await rs.set("a_c", "张三", 10);
 	// await rs.set("b", "李四", 10);
 	// 
 	// await rs.set("c", "王五", 10);
 	// await rs.set("d", "十五", 10);
-	bl = await rs.set("age", 10, 10);
-	console.log("修改" + bl);
+	// bl = await rs.del("a");
+	// console.log("删除", bl);
+	// bl = await rs.del("age");
+	// console.log("删除", bl);
+	// bl = await rs.set("age", 10, 10);
+	// var ss = await rs.ttl("age");
+	// console.log("修改age", bl, ss);
+	// bl = await rs.ttl("age", 20);
+	// ss = await rs.ttl("age");
+	// console.log("修改age", bl, ss);
+	// bl = await rs.ttl("age", -3);
+	// ss = await rs.ttl("age");
+	// console.log("修改age", bl, ss);
 
-	//bl = await rs.del("d");  
-	bl = await rs.add("d", "十五", 10);
-	console.log("添加" + bl);
+	// bl = await rs.del("d");  
+	// bl = await rs.add("d", "十五", 10);
+	// console.log("添加" + bl);
+	// bl = await rs.add("d", "十五", 10);
+	// console.log("添加" + bl);
 
+	rs.set("uuid_123456", {
+		name: "李四",
+		age: 18
+	});
+
+	var user = await rs.get("uuid_123456");
+	console.log("测试输出", user);
+	// bl = await rs.set("age", 10, 10);
 	// var num = await rs.addInt("age", 11);
-	// console.log(num);
-	// 
-	// msg = await rs.setrange("a", 0, "asd");
+
+	// await rs.set("a", "哈哈");
+	// var len = await rs.addStr("a", "丰B");
+	// var str = await rs.get("a");
+	// console.log("测试A", str, len);
+	// bl = await rs.del("a");
+	// console.log("测试A删除", bl);
+
+	// msg = await rs.setrange("a", 1, "asd");
 	// var len = await rs.addStr("a", "丰");
-	// console.log("追加文本" + len);
-	// 
+
+	// var str = await rs.get("a");
+	// console.log("追加文本", str, len);
+	
 	// var bl = await rs.has("a");
-	// console.log("是否存在" + bl);
+	// console.log("是否存在", bl);
+	// var bl = rs.clear();
+	// console.log("清空所有", bl);
+	
+	// bl = await rs.list_clear("arr", ['第三', '第四', '第w']); // 清空数组,并重新增加成员
+	// console.log("清空数组" + bl);
 
-	bl = await rs.list_clear("arr", ['第三', '第四', '第w']); // 清空数组,并重新增加成员
-	console.log("清空数组" + bl);
+	// num = await rs.list_set("arr", ['第一', '第二'], 10);
+	// console.log("设置数组" + num);
+
+	// time = await rs.ttl("arr");
+	// console.log(time);
+	// bl = await rs.ttl("arr", -11);
+	// console.log(bl);
+	// time = await rs.ttl("arr");
+	// console.log(time);
 
-	num = await rs.list_set("arr", ['第一', '第二'], 10);
-	console.log("设置数组" + num);
+	// // var bl = await rs.list_has("arr", '第一');
+	// // console.log(bl);
+	// // await rs.sort("arr");
+	// var ar = await rs.list_get("arr");
+	// console.log(ar);
 
-	time = await rs.ttl("arr");
-	console.log(time);
-	bl = await rs.ttl("arr", -11);
-	console.log(bl);
-	time = await rs.ttl("arr");
-	console.log(time);
+	// //console.log("取值" + JSON.stringify(arr));
 
-	// var bl = await rs.list_has("arr", '第一');
+	// //rs.del('a');
+	// // ret = await rs.clear(); // 清空缓存
+	// // console.log(ret);
+	// // var ret = await rs.getrange("a", 1, 3);
+	// // var arr = await rs.keys("a*");
+	// // console.log("取值" + arr);
+	// var bl = rs.close();
 	// console.log(bl);
-	// await rs.sort("arr");
-	var ar = await rs.list_get("arr");
-	console.log(ar);
-
-	//console.log("取值" + JSON.stringify(arr));
-
-	//rs.del('a');
-	// ret = await rs.clear(); // 清空缓存
-	// console.log(ret);
-	// var ret = await rs.getrange("a", 1, 3);
-	// var arr = await rs.keys("a*");
-	// console.log("取值" + arr);
-	var bl = rs.close();
-	console.log(bl);
 }
 test();