mm_ret 1.4.1 → 1.4.3

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.3",
     "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,104 @@
-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 }], 35);
+	$.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();
+
+// var reqCS = new Req();
+// const request = reqCS.send('getProfile', { userId: 123 });
+// $.log.debug("封装:", JSON.stringify(request));
+
+// var model = reqCS.parse({
+// 	id: "1231233",
+// 	method: 'getProfile',
+// 	params: [{ userId: 123 }]
+// });
+// $.log.debug("解析:", model);