mm_tpl 2.4.4 → 2.4.6

package/hook.js

@@ -2,30 +2,39 @@ const {
 	types
 } = require("util");
 
+/**
+ * 钩子管理类
+ * @class
+ */
 class Hook {
+	/**
+	 * 创建钩子实例
+	 */
 	constructor() {
-		this.dict_func = {};
-		this.dict_action = {};
-		this.dict_filter = {};
+		this._func = {};
+		this._action = {};
+		this._filter = {};
 	}
 }
 
 /**
- * 排序
- * @param {Array} list 钩子列表
+ * 排序钩子列表
+ * @param {Array} list - 钩子列表
+ * @returns {Array} 排序后的列表
  */
-Hook.prototype.sort = function(list) {
+Hook.prototype.sort = function (list) {
 	return list.sort((o1, o2) => {
 		return o2.sort - o1.sort
 	});
 }
 
 /**
- * 获取别名
- * @param {Function} func 钩子函数
- * @param {String} alias 别名
+ * 获取函数别名
+ * @param {Function} func - 钩子函数
+ * @param {string} alias - 别名
+ * @returns {string} 函数别名
  */
-Hook.prototype.getName = function(func, alias) {
+Hook.prototype._getName = function (func, alias) {
 	if (!alias) {
 		var str = func.toString();
 		var name = str.between('function ', "(").trim();
@@ -40,70 +49,73 @@ Hook.prototype.getName = function(func, alias) {
 
 /**
  * 添加函数钩子
- * @param {String} name 钩子名称
- * @param {Function} func 钩子函数
- * @param {Number} sort 执行顺序
- * @param {String} alias 函数别名，用于删除
+ * @param {string} name - 钩子名称
+ * @param {Function} func - 钩子函数
+ * @param {number} sort - 执行顺序
+ * @param {string} alias - 函数别名
+ * @returns {string} 函数别名
  */
-Hook.prototype.addFunc = function(name, func, sort, alias) {
-	alias = this.getName(func, alias);
+Hook.prototype.addFunc = function (name, func, sort = 100, alias = "") {
+	alias = this._getName(func, alias);
 	var obj = {
 		func,
 		sort,
 		alias
 	}
-	var arr = this.dict_func[name];
+	var arr = this._func[name];
 	if (!arr) {
 		arr = [];
 	}
 	arr.push(obj);
-	this.dict_func[name] = this.sort(arr);
+	this._func[name] = this.sort(arr);
 	return alias;
 }
 
 /**
  * 添加动作钩子
- * @param {String} name 钩子名称
- * @param {Function} func 钩子函数
- * @param {Number} sort 执行顺序
- * @param {String} alias 函数别名，用于删除
+ * @param {string} name - 钩子名称
+ * @param {Function} func - 钩子函数
+ * @param {number} sort - 执行顺序
+ * @param {string} alias - 函数别名
+ * @returns {string} 函数别名
  */
-Hook.prototype.addAction = function(name, func, sort, alias) {
-	alias = this.getName(func, alias);
+Hook.prototype.addAction = function (name, func, sort, alias) {
+	alias = this._getName(func, alias);
 	var obj = {
 		func,
 		sort,
 		alias
 	}
-	var arr = this.dict_action[name];
+	var arr = this._action[name];
 	if (!arr) {
 		arr = [];
 	}
 	arr.push(obj);
-	this.dict_action[name] = this.sort(arr);
+	this._action[name] = this.sort(arr);
 	return alias;
 }
 
 /**
  * 添加过滤钩子
- * @param {String} name 钩子名称
- * @param {Function} func 钩子函数
- * @param {Number} sort 执行顺序
- * @param {String} alias 函数别名，用于删除
+ * @param {string} name - 钩子名称
+ * @param {Function} func - 钩子函数
+ * @param {number} sort - 执行顺序
+ * @param {string} alias - 函数别名
+ * @returns {string} 函数别名
  */
-Hook.prototype.addFilter = function(name, func, sort, alias) {
-	alias = this.getName(func, alias);
+Hook.prototype.addFilter = function (name, func, sort, alias) {
+	alias = this._getName(func, alias);
 	var obj = {
 		func,
 		sort,
 		alias
 	}
-	var arr = this.dict_filter[name];
+	var arr = this._filter[name];
 	if (!arr) {
 		arr = [];
 	}
 	arr.push(obj);
-	this.dict_filter[name] = this.sort(arr);
+	this._filter[name] = this.sort(arr);
 	return alias;
 }
 
@@ -112,12 +124,17 @@ Hook.prototype.addFilter = function(name, func, sort, alias) {
  * @param {String} name 钩子名称
  * @param {String} alias 函数别名
  */
-Hook.prototype.delFunc = function(name, alias) {
-	var arr = this.dict_func[name];
+Hook.prototype.delFunc = function (name, alias) {
+	var arr = this._func[name];
 	if (arr) {
-		arr.del({
-			alias
-		});
+		var list = [];
+		for (var i = 0; i < arr.length; i++) {
+			var item = arr[i];
+			if (item.alias !== alias) {
+				list.push(item);
+			}
+		}
+		this._func[name] = list;
 	}
 }
 
@@ -126,12 +143,17 @@ Hook.prototype.delFunc = function(name, alias) {
  * @param {String} name 钩子名称
  * @param {String} alias 函数别名
  */
-Hook.prototype.delAction = function(name, alias) {
-	var arr = this.dict_action[name];
+Hook.prototype.delAction = function (name, alias) {
+	var arr = this._action[name];
 	if (arr) {
-		arr.del({
-			alias
-		});
+		var list = [];
+		for (var i = 0; i < arr.length; i++) {
+			var item = arr[i];
+			if (item.alias !== alias) {
+				list.push(item);
+			}
+		}
+		this._action[name] = list;
 	}
 }
 
@@ -140,32 +162,42 @@ Hook.prototype.delAction = function(name, alias) {
  * @param {String} name 钩子名称
  * @param {String} alias 函数别名
  */
-Hook.prototype.delFilter = function(name, alias = "") {
-	var arr = this.dict_filter[name];
+Hook.prototype.delFilter = function (name, alias = "") {
+	var arr = this._filter[name];
 	if (arr) {
-		arr.del({
-			alias
-		});
+		var list = [];
+		for (var i = 0; i < arr.length; i++) {
+			var item = arr[i];
+			if (item.alias !== alias) {
+				list.push(item);
+			}
+		}
+		this._filter[name] = list;
 	}
 }
 
 /**
- * 运行动作钩子
- * @param {String} name 钩子名称
- * @param {Object} model 模型
- * @param {Object} args 附加参数
+ * 执行函数钩子
+ * @param {string} name - 钩子名称
+ * @param {Object} param - 参数
+ * @param {Function} func - 钩子函数
  */
-Hook.prototype.runAction = function(name, model, ...args) {
-	var ret = "";
-	var dict = this.dict_action;
-	var list = dict[name];
+Hook.prototype.runFunc = async function (name, model, req, ...args) {
+	var ret;
+	var list = this._func[name];
 	if (list) {
 		for (var i = 0; i < list.length; i++) {
-			var o = list[i];
+			var item = list[i];
 			try {
-				ret += o.func(model, ...args);
+				var ret_new = item.func(model, req, ...args);
+				if (types.isPromise(ret_new)) {
+					ret_new = await ret_new;
+					if (ret_new) {
+						ret = ret_new;
+					}
+				}
 			} catch (err) {
-				$.log.error(ret);
+				$.log.error(`[${this.constructor.name}] 执行函数钩子失败 ${item.alias}`, err);
 			}
 		}
 	}
@@ -173,22 +205,22 @@ Hook.prototype.runAction = function(name, model, ...args) {
 }
 
 /**
- * 运行过滤钩子
- * @param {String} name 钩子名称
- * @param {Object} model 模型
- * @param {Object} ret 结果
- * @param {Object} args 附加参数
+ * 执行动作钩子
+ * @param {string} name - 钩子名称
+ * @param {Object} model - 模型对象
+ * @param {...any} args - 附加参数
+ * @returns {Object} 执行结果
  */
-Hook.prototype.runFilter = function(name, model, ret, ...args) {
-	var dict = this.dict_filter;
-	var list = dict[name];
+Hook.prototype.runAction = function (name, model, ...args) {
+	var ret = '';
+	var list = this._action[name];
 	if (list) {
 		for (var i = 0; i < list.length; i++) {
 			var o = list[i];
 			try {
-				ret = o.func(model, ret, ...args);
+				ret += o.func(model, ...args);
 			} catch (err) {
-				$.log.error(ret);
+				$.log.error(`[${this.constructor.name}] 执行动作钩子失败 ${o.alias}`, err);
 			}
 		}
 	}
@@ -196,30 +228,83 @@ Hook.prototype.runFilter = function(name, model, ret, ...args) {
 }
 
 /**
- * 运行函数钩子
- * @param {String} name 钩子名称
- * @param {Object} model 模型
- * @param {Object} req 请求参数
- * @param {Object} args 附加参数
+ * 执行过滤钩子
+ * @param {string} name - 钩子名称
+ * @param {Object} model - 模型对象
+ * @param {Object} ret - 返回值
+ * @param {...any} args - 附加参数
+ * @returns {Object} 过滤后的参数
  */
-Hook.prototype.runFunc = async function(name, model, req, ...args) {
-	var ret;
-	var dict = this.dict_func;
-	var list = dict[name];
+Hook.prototype.runFilter = function (name, model, ret, ...args) {
+	var list = this._filter[name];
 	if (list) {
 		for (var i = 0; i < list.length; i++) {
-			var o = list[i];
+			var item = list[i];
 			try {
-				ret = o.func(model, req, ...args);
-				if (ret) {
-					ret = await ret;
-				}
+				ret = item.func(model, ret, ...args) || ret;
 			} catch (err) {
-				$.log.error(ret);
+				$.log.error(`[${this.constructor.name}] 执行过滤钩子失败 ${item.alias}`, err);
 			}
 		}
 	}
 	return ret;
 }
 
+/**
+ * 删除钩子
+ * @param {string} name - 钩子名称
+ * @param {string} alias - 函数别名
+ */
+Hook.prototype.del = function (name, alias) {
+	var arr = this._func[name];
+	if (arr) {
+		var list = [];
+		for (var i = 0; i < arr.length; i++) {
+			var item = arr[i];
+			if (item.alias !== alias) {
+				list.push(item);
+			}
+		}
+		this._func[name] = list;
+	}
+	arr = this._action[name];
+	if (arr) {
+		var list = [];
+		for (var i = 0; i < arr.length; i++) {
+			var item = arr[i];
+			if (item.alias !== alias) {
+				list.push(item);
+			}
+		}
+		this._action[name] = list;
+	}
+	arr = this._filter[name];
+	if (arr) {
+		var list = [];
+		for (var i = 0; i < arr.length; i++) {
+			var item = arr[i];
+			if (item.alias !== alias) {
+				list.push(item);
+			}
+		}
+		this._filter[name] = list;
+	}
+}
+
+/**
+ * 清空钩子
+ * @param {string} name - 钩子名称
+ */
+Hook.prototype.clear = function (name) {
+	if (name) {
+		delete this._func[name];
+		delete this._action[name];
+		delete this._filter[name];
+	} else {
+		this._func = {};
+		this._action = {};
+		this._filter = {};
+	}
+}
+
 module.exports = Hook;