mm_ret 1.4.1 → 1.4.3

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
+};