mm_ret 1.4.1 → 1.4.2

package/index.js

@@ -3,266 +3,24 @@
  * @author <a href="http://qww.elins.cn">邱文武</a>
  * @version 1.0
  */
-require('mm_expand');
-
-/**
- * @class 错误代码
- */
-class Error {
-	/**
-	 * @description 构造函数
-	 * @constructor
-	 */
-	constructor() {
-		this.type = [
-			{
-				code: -32700,
-				message: "not well formed"
-			},
-			{
-				code: -32701,
-				message: "unsupported encoding"
-			},
-			{
-				code: -32702,
-				message: "invalid character for encoding"
-			},
-			{
-				code: -32600,
-				message: "invalid json-rpc. not conforming to spec"
-			},
-			{
-				code: -32601,
-				message: "requested method not found"
-			},
-			{
-				code: -32602,
-				message: "invalid method parameters"
-			},
-			{
-				code: -32603,
-				message: "internal json-rpc error"
-			},
-			{
-				code: -32500,
-				message: "application error"
-			},
-			{
-				code: -32400,
-				message: "system error"
-			},
-			{
-				code: -32300,
-				message: "transport error"
-			},
-			{
-				code: 10000,
-				message: "业务逻辑脚本错误"
-			},
-			{
-				code: 30000,
-				message: "身份验证失败"
-			},
-			{
-				code: 40000,
-				message: "数据库执行错误"
-			},
-			{
-				code: 50000,
-				message: "服务端执行错误"
-			},
-			{
-				code: 70000,
-				message: "参数不正确"
-			}
-		];
-	}
-}
-
-/**
- * @description 获取错误
- * @param {String|Number} keyword  关键词 或 错误码
- */
-Error.prototype.get = function(keyword) {
-	var error = null;
-	if (typeof(keyword) === "string") {
-		for (var i = 0; i < this.type.length; i++) {
-			var o = this.type[i];
-			if (o.code === keyword) {
-				error = o;
-				break;
-			}
-		}
-	} else {
-		for (var i = 0; i < this.type.length; i++) {
-			var o = this.type[i];
-			if (o.message.has(keyword)) {
-				error = o;
-				break;
-			}
-		}
-	}
-	return error;
-};
-
-/**
- * @description json-rpc2.0响应函数
- * @class 
- */
-class Ret {
-	/**
-	 * @description 构造函数
-	 * @constructor
-	 */
-	constructor() {
-
-	}
+const { Error } = require('./lib/error.js');
+const { Req } = require('./lib/req.js');
+const { Ret } = require('./lib/ret.js');
+
+if (global.$) {
+    if (!$.error) {
+        $.error = new Error();
+    }
+    if (!$.req) {
+        $.req = new Req();
+    }
+    if (!$.ret) {
+        $.ret = new Ret();
+    }
 }
 
-/**
- * @description 取结果
- * @param {Object} result 返回的结果
- * @param {Object} error 返回的错误信息
- * @param {String} id 消息ID, 用于消息队列或多线程时
- * @return {Object} json-rpc 请求结果
- */
-Ret.prototype.body = function(result, error, id) {
-	var ret = {};
-	if (id) {
-		ret.id = id;
-	}
-	if (result) {
-		ret.result = result;
-	} else {
-		if (error) {
-			if (!error.code) {
-				error.code = 10000;
-			}
-			if (!error.message) {
-				error.message = "业务逻辑错误";
-			}
-		} else {
-			error = {
-				code: 10000,
-				message: "业务逻辑错误"
-			}
-		}
-		ret.error = error;
-	}
-	return ret;
-};
-
-/**
- * @description 取结果
- * @param {Number} code 返回的错误码
- * @param {String} message 返回的错误提示
- * @param {String} id 消息ID, 用于消息队列或多线程时
- * @return {Object} json-rpc 请求结果
- */
-Ret.prototype.error = function(code, message, id) {
-	var error = {
-		code: code,
-		message: message
-	};
-	return this.body(null, error, id);
-};
-
-/**
- * @description 取列表结果
- * @param {Array} list 返回列表
- * @param {Number} count 查询结果数
- * @param {String} id 消息ID, 用于消息队列或多线程时
- * @return {Object} json-rpc 请求结果
- */
-Ret.prototype.list = function(list, count, id) {
-	if (!list) {
-		list = [];
-	}
-	var result = {
-		list: list
-	};
-	if (count !== undefined) {
-		result.count = count;
-	}
-	return this.body(result, null, id);
-};
-
-/**
- * @description 取对象结果
- * @param {Object} obj 返回对象
- * @param {Object} id 消息ID, 用于消息队列或多线程时
- * @return {Object} json-rpc 请求结果
- */
-Ret.prototype.obj = function(obj, id) {
-	return this.body({
-		obj: obj
-	}, null, id);
-};
-
-/**
- * @description 取布尔型结果
- * @param {Boolean} bl 取布尔结果
- * @param {String} tip 返回对象
- * @param {String} id 操作结果提示
- */
-Ret.prototype.bl = function(bl, tip, id) {
-	if (!tip) {
-		tip = bl ? "成功" : "失败";
-	}
-	return this.body({
-		bl: bl,
-		tip: tip
-	}, null, id);
-};
-
-$.ret = new Ret();
-
-/**
- * @description json-rpc2.0请求函数
- * @class 
- */
-class Req {
-	/**
-	 * 构造函数
-	 * @constructor
-	 * @param {String} scope 作用域
-	 */
-	constructor(scope) {
-		// 作用域
-		this.scope = scope ? scope : "sys";
-		
-		// 模板集合
-		this.tpl = {};
-		
-		// 方法集合
-		this.methods = {};
-	}
-}
-
-/**
- * 发送请求
- * @param {String} method 方法
- * @param {Object} params 参数
- * @return {Object} 发送的json格式
- */
-Req.prototype.send = function(method, params) {
-	var tpl = this.tpl[method];
-	var pm;
-	if(tpl){
-		pm = Object.assign({}, tpl, params);
-	}
-	else {
-		pm = params
-	}
-	return {
-		id: this.scope + new Date().stamp(),
-		method: method,
-		params: pm
-	};
-};
-
-$.req = new Req();
-
-exports.Error = Error;
-exports.Ret = Ret;
-exports.Req = Req;
+module.exports = {
+    Error,
+    Ret,
+    Req
+}

package/lib/error.js

@@ -0,0 +1,163 @@
+/**
+ * @file 错误代码管理类
+ * @class Error
+ */
+class Error {
+    /**
+     * @description 构造函数
+     * @constructor
+     * @param {Object} config 配置项
+     */
+    constructor(config) {
+        /**
+         * @description 错误码配置项
+         */
+        this._config = {
+            lang: "zh-CN"
+        };
+        this.setConfig(config);
+        /**
+         * @description 错误码语言包
+         */
+        this._langs = {
+            "zh-CN": {
+                "10000": "业务逻辑错误",
+                "0": "成功",
+                "‌100": "继续",
+                "‌101": "切换协议‌",
+                "‌200": "确定",
+                "‌201": "已创建",
+                "‌202": "已接受",
+                "‌204": "无内容",
+                "‌301": "已永久移动",
+                "‌302": "已找到",
+                "‌303": "见其他",
+                "‌304": "未修改",
+                "‌307": "临时重定向‌",
+                "‌400": "错误请求",
+                "‌401": "未授权",
+                "‌403": "禁止访问",
+                "‌404": "未找到",
+                "‌405": "方法不允许",
+                "‌408": "请求超时",
+                "‌413": "Payload Too Large",
+                "‌415": "不支持的媒体类型",
+                "‌429": "请求过多",
+                "‌500": "内部服务器错误",
+                "‌501": "未实现",
+                "‌502": "错误网关",
+                "‌503": "服务不可用",
+                "‌504": "网关超时",
+                "-32700": "格式错误",
+                "-32701": "不支持的编码",
+                "-32702": "编码中包含无效字符",
+                "-32600": "无效的json-rpc. 不符合规范",
+                "-32601": "请求的方法未找到",
+                "-32602": "无效的方法参数",
+                "-32603": "内部json-rpc错误",
+                "-32500": "应用错误",
+                "-32400": "系统错误",
+                "-32300": "传输错误",
+                "30000": "身份验证失败",
+                "40000": "数据库执行错误",
+                "50000": "服务端执行错误",
+                "70000": "参数不正确"
+            },
+            "en-US": {
+                "10000": "business logic error",
+                "0": "success",
+                "‌100": "Continue",
+                "‌101": "Switching Protocols‌",
+                "‌200": "OK",
+                "‌201": "Created",
+                "‌202": "Accepted",
+                "‌204": "No Content",
+                "‌301": "Moved Permanently",
+                "‌302": "Found",
+                "‌303": "See Other",
+                "‌304": "Not Modified‌",
+                "‌307": "Temporary Redirect‌",
+                "‌400": "Bad Request",
+                "‌401": "Unauthorized",
+                "‌403": "Forbidden",
+                "‌404": "Not Found",
+                "‌405": "Method Not Allowed",
+                "‌408": "Request Timeout",
+                "‌413": "Payload Too Large",
+                "‌415": "Unsupported Media Type",
+                "‌429": "Too Many Requests‌",
+                "‌500": "Internal Server Error",
+                "‌501": "Not Implemented",
+                "‌502": "Bad Gateway",
+                "‌503": "Service Unavailable",
+                "‌504": "Gateway Timeout",
+                "-32700": "not well formed",
+                "-32701": "unsupported encoding",
+                "-32702": "invalid character for encoding",
+                "-32600": "invalid json-rpc. not conforming to spec",
+                "-32601": "requested method not found",
+                "-32602": "invalid method parameters",
+                "-32603": "internal json-rpc error",
+                "-32500": "application error",
+                "-32400": "system error",
+                "-32300": "transport error",
+                "30000": "authentication failed",
+                "40000": "database execution error",
+                "50000": "server execution error",
+                "70000": "parameter is incorrect"
+            }
+        };
+    }
+}
+
+/**
+ * @description 设置配置项
+ * @param {Object} config 配置项
+ */
+Error.prototype.setConfig = function (config) {
+    Object.assign(this._config, config);
+}
+
+/**
+ * @description 根据错误码获取错误信息
+ * @param {string|number} code 错误码
+ * @returns {string|null} 错误信息
+ */
+Error.prototype.get = function (code) {
+    const lang = this._config.lang;
+    const lang_pack = this._langs[lang];
+
+    if (lang_pack && lang_pack[code]) {
+        return lang_pack[code];
+    }
+
+    // 如果当前语言包没有，尝试英文包
+    if (lang !== "en-US" && this._langs["en-US"][code]) {
+        return this._langs["en-US"][code];
+    }
+
+    return null;
+};
+
+/**
+ * @description 设置语言
+ * @param {string} lang 语言代码
+ */
+Error.prototype.setLang = function (lang) {
+    this._config.lang = lang;
+};
+
+/**
+ * @description 获取当前语言
+ * @returns {string} 当前语言代码
+ */
+Error.prototype.getLang = function () {
+    return this._config.lang;
+};
+
+/**
+ * @description 导出错误管理类
+ */
+module.exports = {
+    Error
+}

package/lib/req.js

@@ -0,0 +1,241 @@
+/**
+ * @file 请求管理类
+ * @class Req
+ */
+class Req {
+    /**
+     * @description 构造函数
+     * @constructor
+     * @param {Object} config 配置项
+     */
+    constructor(config) {
+        // 配置项
+        this._config = {
+            /**
+             * @description 作用域
+             * @type {string}
+             * @default "sys"
+             */
+            scope: "sys",
+            /**
+             * @description 响应格式
+             * @type {string} "json-rpc" | "json-rpc3" | "restful"
+             * @default "json-rpc"
+             */
+            format: "json-rpc"
+        };
+        this.setConfig(config);
+
+        // 方法集合
+        this._methods = {};
+    }
+}
+
+/**
+ * @description 设置配置项
+ * @param {Object} config 配置项
+ */
+Req.prototype.setConfig = function (config) {
+    Object.assign(this._config, config);
+    this._config.format = this._config.format?.toLowerCase() || "json-rpc";
+}
+
+/**
+ * @description 生成新的ID
+ * @returns {string} 新的ID
+ */
+Req.prototype.newId = function () {
+    return this._config.scope + Date.now();
+}
+
+/**
+ * @description 发送请求
+ * @param {string} method 方法名
+ * @param {...any} args 参数
+ * @returns {Object} 发送的JSON格式
+ */
+Req.prototype.send = function (method, ...args) {
+    if (this._methods[method]) {
+        return this._methods[method](...args);
+    }
+    else if (this._config.format === "json-rpc") {
+        return this._sendJsonRPC(method, args);
+    }
+    else if (this._config.format === "json-rpc3") {
+        return this._sendJsonRPC3(method, ...args);
+    }
+    else {
+        return this._sendRESTful(method, ...args);
+    }
+};
+
+/**
+ * @description 发送JSON-RPC 2.0请求
+ * @param {string} method 方法名
+ * @param {Array} params 参数数组
+ * @param {string} [id] 请求ID
+ * @returns {Object} JSON-RPC 2.0格式
+ */
+Req.prototype._sendJsonRPC = function (method, params, id) {
+    return {
+        id: id || this.newId(),
+        method,
+        params
+    };
+}
+
+/**
+ * @description 发送JSON-RPC 3.0请求
+ * @param {string} method 方法名
+ * @param {Object} [query] 查询参数
+ * @param {Object} [body] 请求体
+ * @param {Array} [meta] 元数据数组
+ * @param {string} [id] 请求ID
+ * @returns {Object} JSON-RPC 3.0格式
+ */
+Req.prototype._sendJsonRPC3 = function (method, query, body, meta, id) {
+    return {
+        id: id || this.newId(),
+        method,
+        params: {
+            query: query || {},
+            body: body || {},
+            meta: meta || []
+        }
+    };
+}
+
+/**
+ * @description 发送RESTful请求
+ * @param {string} method 方法名
+ * @param {Object} [query] 查询参数
+ * @param {Object} [body] 请求体
+ * @param {Array} [meta] 元数据数组
+ * @param {string} [id] 请求ID
+ * @returns {Object} RESTful格式
+ */
+Req.prototype._sendRESTful = function (method, query, body, meta, id) {
+    return {
+        id: id || this.newId(),
+        method,
+        query: query || {},
+        body: body || {},
+        meta: meta || []
+    };
+}
+
+/**
+ * @description 解析请求
+ * @param {Object} req 请求对象
+ * @returns {Object} 解析后的对象
+ */
+Req.prototype.parse = function (req) {
+    const id = req.id;
+    const method = req.method;
+    let params = [];
+
+    if (req.params) {
+        if (Array.isArray(req.params)) {
+            params = req.params;
+        }
+        else {
+            if (typeof req.params === "object") {
+                let ctx = Object.assign({}, req.params);
+                if (ctx.query || ctx.body) {
+                    params.push(ctx.query || null);
+                    params.push(ctx.body || null);
+                    delete ctx.query;
+                    delete ctx.body;
+                    for (const key in ctx) {
+                        params.push(ctx[key]);
+                    }
+                }
+                else {
+                    params = [
+                        req.params
+                    ];
+                }
+            }
+            else {
+                params = [req.params];
+            }
+        }
+    }
+    else if (req.query || req.body) {
+        params.push(req.query || null);
+        params.push(req.body || null);
+        if (req.meta) {
+            params.push(req.meta || null);
+        }
+    }
+    if (this._config.format === "json-rpc") {
+        if (req.params) {
+            params = req.params;
+        }
+    }
+    else if (this._config.format === "json-rpc3") {
+        var pm = {};
+        pm.query = params.length > 0 ? params[0] || null : null;
+        pm.body = params.length > 1 ? params[1] || null : null;
+        pm.meta = params.length > 2 ? params[2] || null : null;
+        params = pm;
+    }
+    else if (this._config.format === "restful") {
+        var ret = {
+            id,
+            method,
+            query: params.length > 0 ? params[0] || null : null,
+            body: params.length > 1 ? params[1] || null : null
+        }
+        if (params.length > 2) {
+            ret.meta = params[2];
+        }
+        return ret;
+    }
+    return {
+        id,
+        method,
+        params
+    };
+}
+
+/**
+ * @description 注册自定义方法
+ * @param {string} method 方法名
+ * @param {Function} handler 处理方法
+ */
+Req.prototype.registerMethod = function (method, handler) {
+    this._methods[method] = handler;
+};
+
+/**
+ * @description 注销自定义方法
+ * @param {string} method 方法名
+ */
+Req.prototype.unregisterMethod = function (method) {
+    delete this._methods[method];
+};
+
+/**
+ * @description 设置请求格式
+ * @param {string} format 请求格式
+ */
+Req.prototype.setFormat = function (format) {
+    switch (format?.toLowerCase()) {
+        case "json":
+        case "json-rpc":
+            this._config.format = "json-rpc";
+            break;
+        case "json3":
+        case "json-rpc3":
+            this._config.format = "json-rpc3";
+            break;
+        default:
+            this._config.format = "restful";
+            break;
+    }
+}
+
+module.exports = {
+    Req
+};

package/lib/ret.js

@@ -0,0 +1,352 @@
+require('mm_expand');
+/**
+ * @file 响应管理类
+ * @class Ret
+ */
+class Ret {
+	/**
+	 * @description 构造函数
+	 * @param {Object} config 配置项
+	 * @constructor
+	 */
+	constructor(config) {
+		this._config = {
+			/**
+			 * @description 响应格式
+			 * @type {string} "json-rpc" | "restful"
+			 * @default "json-rpc"
+			 */
+			format: "json-rpc",
+			/**
+			 * @description 默认错误码
+			 * @type {number}
+			 * @default 10000
+			 */
+			error_code: 10000,
+			/**
+			 * @description 默认错误提示
+			 * @type {string}
+			 * @default "错误"
+			 */
+			error_message: "错误",
+			/**
+			 * @description 默认成功码
+			 * @type {number}
+			 * @default 0
+			 */
+			success_code: 0,
+			/**
+			 * @description 默认成功提示
+			 * @type {string}
+			 * @default "成功"
+			 */
+			success_message: "成功",
+			/**
+			 * @description 
+			 * @type {boolean} 
+			 * @default false
+			 */
+			message_diy: false
+		};
+
+		this.setConfig(config);
+	}
+}
+
+/**
+ * @description 设置配置项
+ * @param {Object} config 配置项
+ */
+Ret.prototype.setConfig = function (config) {
+	Object.assign(this._config, config);
+}
+
+/**
+ * @description 获取错误提示
+ * @param {number} code 错误码
+ * @returns {string} 错误提示
+ */
+Ret.prototype._getMessage = function (code) {
+	var message;
+	if ($.error) {
+		message = $.error.get(code);
+	}
+
+	if (!message) {
+		if (code === this._config.success_code) {
+			message = this._config.success_message;
+		}
+		else {
+			message = this._config.error_message;
+		}
+	}
+	return message;
+}
+
+/**
+ * @description 生成JSON-RPC 2.0响应格式
+ * @param {Object} result 返回的结果
+ * @param {Object} error 返回的错误信息
+ * @param {Object.code} error.code 返回的错误码
+ * @param {Object.message} error.message 返回的错误提示
+ * @param {string} id 消息ID
+ * @param {boolean} diy 是否自定义错误提示
+ * @returns {Object} JSON-RPC 2.0响应格式
+ */
+Ret.prototype._toJsonRPC = function (result, error, id, diy = false) {
+	const ret = {
+		id
+	};
+
+	if (result) {
+		ret.result = result;
+	}
+	else if (error) {
+		if (!error.code) {
+			error.code = this._config.error_code;
+		}
+		diy = diy || this._config.message_diy;
+		if (!diy) {
+			error.message = this._getMessage(error.code) || error.message;
+		}
+		else if (!error.message) {
+			error.message = this._getMessage(error.code);
+		}
+		ret.error = error;
+	}
+	else {
+		ret.error = {
+			code: this._config.error_code,
+			message: this._getMessage(this._config.error_code)
+		};
+	}
+	return ret;
+}
+
+/**
+ * @description 生成RESTful响应格式
+ * @param {*} result 返回的结果
+ * @param {Object} error 返回的错误信息
+ * @param {Object.code} error.code 返回的错误码
+ * @param {Object.message} error.message 返回的错误提示
+ * @param {string} id 消息ID
+ * @param {boolean} diy 是否自定义错误提示
+ * @returns {Object} RESTful响应格式
+ */
+Ret.prototype._toRESTful = function (result, error, id, diy = false) {
+	var code;
+	var msg;
+	if (result) {
+		code = this._config.success_code;
+		msg = this._getMessage(this._config.success_code);
+	}
+	else if (error) {
+		code = error.code || this._config.error_code;
+		diy = diy || this._config.message_diy;
+		if (!diy) {
+			msg = this._getMessage(code) || error.message || error.msg;
+		}
+		else if (!error.message && !error.msg) {
+			msg = this._getMessage(code);
+		}
+		else {
+			msg = error.message || error.msg || this._getMessage(code);
+		}
+	}
+	else {
+		code = this._config.error_code;
+		msg = this._getMessage(code);
+	}
+	return {
+		id,
+		code,
+		msg,
+		data: result
+	};
+}
+
+/**
+ * @description 生成响应体
+ * @param {Object} result 返回的结果
+ * @param {Object} error 返回的错误信息
+ * @param {string} id 消息ID
+ * @param {boolean} diy 是否自定义错误提示
+ * @returns {Object} 响应格式
+ */
+Ret.prototype.body = function (result, error, id, diy = false) {
+	if (this._config.format === "json-rpc") {
+		return this._toJsonRPC(result, error, id, diy);
+	}
+	else {
+		return this._toRESTful(result, error, id, diy);
+	}
+};
+
+/**
+ * @description 生成错误响应
+ * @param {number} code 错误码
+ * @param {string} message 错误信息
+ * @param {string} id 消息ID
+ * @param {boolean} diy 是否自定义错误提示
+ * @returns {Object} 错误响应格式
+ */
+Ret.prototype.error = function (code, message, id, diy = false) {
+	const error = {
+		code,
+		message
+	};
+	return this.body(null, error, id, diy);
+};
+
+/**
+ * @description 生成列表响应
+ * @param {Array} list 返回列表
+ * @param {number} count 查询结果数
+ * @param {string} id 消息ID
+ * @param {boolean} diy 是否自定义错误提示
+ * @returns {Object} 列表响应格式
+ */
+Ret.prototype.list = function (list, count, id, diy = false) {
+	if (!list) {
+		list = [];
+	}
+	const result = {
+		list: list
+	};
+	if (count !== undefined) {
+		result.count = count;
+	}
+	return this.body(result, null, id, diy);
+};
+
+/**
+ * @description 生成对象响应
+ * @param {Object} obj 返回对象
+ * @param {string} id 消息ID
+ * @returns {Object} 对象响应格式
+ */
+Ret.prototype.obj = function (obj, id) {
+	return this.body(obj, null, id);
+};
+
+/**
+ * @description 生成布尔型响应
+ * @param {boolean} bl 布尔结果
+ * @param {string} tip 提示信息
+ * @param {string} id 消息ID
+ * @returns {Object} 布尔响应格式
+ */
+Ret.prototype.bl = function (bl, tip, id) {
+	if (!tip) {
+		tip = bl ? this._config.success_message : this._config.error_message;
+	}
+	return this.body({
+		bl,
+		tip
+	}, null, id);
+};
+
+/**
+ * @description 添加数据项到响应结果
+ * @param {Object} res 响应对象
+ * @param {string} key 数据项键
+ * @param {*} value 数据项值
+ */
+Ret.prototype.add = function (res, key, value) {
+	if (this._config.format === "json-rpc") {
+		if (!res.result) {
+			res.result = {};
+		}
+		res.result[key] = value;
+	}
+	else {
+		if (!res.data) {
+			res.data = {};
+		}
+		res.data[key] = value;
+	}
+}
+
+/**
+ * @description 解析响应
+ * @param {Object} res 响应对象
+ * @returns {Object} 解析后的格式
+ */
+Ret.prototype.parse = function (res) {
+	let error;
+	let result;
+
+	if (res.error) {
+		error = res.error;
+	}
+	else if (res.result) {
+		result = res.result;
+	} else if (res.data) {
+		result = res.data;
+	}
+	else if (res.msg || res.message) {
+		error = {
+			code: res.code || this._config.error_code,
+			message: res.msg || res.message || this._config.error_message
+		};
+	}
+
+	const ret = {};
+	if (this._config.format === "json-rpc") {
+		if (error) {
+			ret.error = error;
+		}
+		else if (result) {
+			ret.result = result;
+		}
+	}
+	else {
+		if (error) {
+			ret.code = error.code || this._config.error_code;
+			ret.msg = error.message || this._config.error_message;
+			ret.data = null;
+		}
+		else if (result) {
+			ret.code = this._config.success_code;
+			ret.msg = this._getMessage(this._config.success_code);
+			ret.data = result;
+		}
+		else {
+			ret.code = this._config.success_code;
+			ret.msg = this._getMessage(this._config.success_code);
+		}
+	}
+	return ret;
+}
+
+/**
+ * @description 获取当前配置
+ * @returns {Object} 配置对象
+ */
+Ret.prototype.getConfig = function () {
+	return this._config;
+};
+
+/**
+ * @description 设置响应格式
+ * @param {string} format 响应格式
+ */
+Ret.prototype.setFormat = function (format) {
+	switch (format?.toLowerCase()) {
+		case "json":
+		case "json-rpc":
+			this._config.format = "json-rpc";
+			break;
+		case "json3":
+		case "json-rpc3":
+			this._config.format = "json-rpc3";
+			break;
+		default:
+			this._config.format = "restful";
+			break;
+	}
+}
+
+module.exports = {
+	Ret
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mm_ret",
-    "version": "1.4.1",
+    "version": "1.4.2",
     "description": "这是超级美眉http请求结果输出类函数模块，用于输出json-rpc2.0标准结果",
     "main": "index.js",
     "scripts": {
@@ -30,6 +30,6 @@
     },
     "homepage": "https://gitee.com/qiuwenwu91/mm_ret#readme",
     "dependencies": {
-        "mm_expand": "^1.8.3"
+        "mm_expand": "^1.9.6"
     }
 }

package/test.js

@@ -1,36 +1,93 @@
-require('./index.js');
+const { Ret, Req } = require('./index.js');
 
 /* 调用示例 */
-async function test() {
+async function retTest(out) {
+	if (!out) {
+		out = $.ret;
+	}
 	var body;
-	body = $.ret.error(10000, '错误');
-	console.log(JSON.stringify(body));
-	
+	body = $.ret.error(10000, "这是一个错误", null, true);
+	$.log.debug("封装:", JSON.stringify(body));
+	$.log.debug("解析结果:", out.parse(body));
+
 	body = $.ret.body("这是一个结果");
-	console.log(JSON.stringify(body));
-	
-	body = $.ret.obj({ "name": "张三",  age: 18});
-	console.log(JSON.stringify(body));
-	
-	body = $.ret.list([{ "name": "张三",  age: 18}, { "name": "李四",  age: 24}]);
-	console.log(JSON.stringify(body));
-	
+	$.log.debug("封装:", JSON.stringify(body));
+	$.log.debug("解析结果:", out.parse(body));
+
+	body = $.ret.obj({ "name": "张三", age: 18 });
+	$.log.debug("封装:", JSON.stringify(body));
+	$.log.debug("解析结果:", out.parse(body));
+
+	body = $.ret.list([{ "name": "张三", age: 18 }, { "name": "李四", age: 24 }]);
+	$.log.debug("封装:", JSON.stringify(body));
+	$.log.debug("解析结果:", out.parse(body));
+
 	body = $.ret.bl(true, "修改成功");
-	console.log(JSON.stringify(body));
+	$.log.debug("封装:", JSON.stringify(body));
+	$.log.debug("解析结果:", out.parse(body));
 }
 
-test();
-
-async function test2() {
-	var body = $.req.send('test', "你好吗");
-	console.log(body);
-	
-	$.req.tpl.message = {
-		"to_user": "",
-		"from_user": "",
-		"content": ""
-	};
-	body = $.req.send('message', { content: "你好吗?", "media": { "title": "牛" } });
-	console.log(body);
+function retDemo() {
+	$.log.debug("=== 测试JSON-RPC风格 进出 === ");
+	retTest();
+
+	$.log.debug("=== 测试RESTful风格 进出 === ");
+	$.ret.setFormat("restful");
+	retTest();
+
+	$.log.debug("=== 测试RESTful风格 进，JSON-RPC风格 出 === ");
+	retTest(new Ret());
+
+	$.log.debug("=== 测试JSON-RPC风格 进，RESTful风格 出 === ");
+	$.ret.setFormat("json-rpc");
+	retTest(new Ret({ format: "restful" }));
 }
-test2();
+
+retDemo();
+
+/* 调用示例 */
+async function reqTest(out) {
+	if (!out) {
+		out = $.req;
+	}
+	var body;
+	body = $.req.send("test_method", "param1", "param2", "param3");
+	$.log.debug("封装:", JSON.stringify(body));
+	$.log.debug("解析结果:", out.parse(body));
+
+	body = $.req.send("set", {
+		user_id: 1
+	}, {
+		"name": "张三",
+		"age": 18
+	}, {
+		"token": "xxxxx"
+	});
+	$.log.debug("封装:", JSON.stringify(body));
+	$.log.debug("解析结果:", out.parse(body));
+}
+
+function reqDemo() {
+	$.log.debug("=== 测试JSON-RPC风格请求 进出 === ");
+	reqTest();
+
+	$.log.debug("=== 测试JSON-RPC3风格请求 进出 === ");
+	$.req.setFormat("json-rpc3");
+	reqTest();
+
+	$.log.debug("=== 测试RESTful风格请求 进出 === ");
+	$.req.setFormat("restful");
+	reqTest();
+
+	$.log.debug("=== 测试RESTful风格请求 进，JSON-RPC风格请求 出 === ");
+	reqTest(new Req());
+
+	$.log.debug("=== 测试RESTful风格请求 进，JSON-RPC3风格请求 出 === ");
+	reqTest(new Req({ format: "json-rpc3" }));
+
+	$.log.debug("=== 测试JSON-RPC风格请求 进，RESTful风格请求 出 === ");
+	$.req.setFormat("json-rpc");
+	reqTest(new Req({ format: "restful" }));
+}
+
+reqDemo();