@x-9lab/xlab 1.0.13 → 1.2.0

package/@types/config/index.d.ts

@@ -3,7 +3,7 @@
  * @param  cat  业务类型
  * @param  type 日志等级
  */
-declare function commonLog(cat: string, type: string): void;
+declare function commonLog(cat: string, type: string, ...rest: any[]): void;
 export { commonLog as log };
 /**
  * 默认配置

package/@types/global.d.ts

@@ -83,6 +83,15 @@ declare global {
             /**操作结果 */
             success?: boolean;
         }
+        /**中间件配置 */
+        type MiddlewareConfig = {
+            /**中间件名称 */
+            name?: string;
+            /**中间件位置 */
+            index?: number;
+            /**中间件配置 */
+            config?: Record<string, JsonValue>;
+        };
         interface IConfig {
             /**服务(应用)名称 */
             name?: string;
@@ -110,8 +119,13 @@ declare global {
             enableComboCache?: boolean;
             /**是否开启定时任务 */
             enableCron?: boolean;
-            /**开启的中间件列表 */
+            /**
+             * 开启的中间件列表
+             * @deprecated since version 1.1.0, 1.3.0 后将完全删除
+             */
             middleware?: (string | (string | Record<string, any>)[])[];
+            /**开启的中间件列表 */
+            middlewares?: Record<string, boolean | MiddlewareConfig>;
             /**自定模块配置 */
             custom?: string[];
             /**是否启用严格 ssl */

package/README.md

@@ -64,6 +64,11 @@ X-9lab 通用服务端
                 - `method` 接口类型，如 `get` 或 `post`
                 - `middleware` 接口中间件
                 - `handler` 接口处理函数
+        - 特殊文件夹
+            - 以 `@` 开头的文件夹, 该文件夹不会被当成接口文件夹，但可在正常的接口中作为普通模块使用
+            - 以 `$` 开头的文件夹, 该文件夹中的文件会成为后续接口的通用中间件，可以用于某类型业务的统一处理，如后台某些接口的额外身份处理。为了防止滥用，该文件夹不会递归查找，也就是说不支持子文件夹的组织形式。
+                - 整个 api 地址的每个父层都可以有独立的中间件文件，执行顺序会按照目录层级执行
+                - 中间件文件夹内的文件只会按照文件名做简单排序，因此请特别注意执行顺序是否符合自己的预期，或采用带序号的文件名
     - 自定义逻辑，存放于 `custom` 目录，模块需要导出一个函数作为执行入口
     - 中间件，存放于 `middleware` 目录
     - 定时任务，存放于 `cron` 目录
@@ -175,7 +180,9 @@ X-9lab 通用服务端
 |staticHtmlFileMaxage|`number`|0|静态 html 文件缓存时间|
 |enableComboCache|`boolean`|true|是否开启 Combo 缓存|
 |enableCron|`boolean`|false|是否开启定时任务|
-|middleware|`Array<string | (string | Record<string, any>)[]>`|[]|开启的中间件列表 |
+|middleware|`Array<string | (string | Record<string, any>)[]>`|[]|开启的中间件列表。因不方便合并替换，v1.1.0 开始建议使用 `middlewares` 来配置 |
+|middlewares|`Record<string, MiddlewareConfig>`|{}|开启的中间件列表 |
+||MiddlewareConfig||`index` 用于定义中间件位置，不提供将使用配置对象中的默认顺序<br/> `name` 中间件名称，不提供将使用配置对象的键名<br/>`config` 中间件配置|
 |custom|`string[]`||自定模块配置|
 |strictSSL|`boolean`||是否启用严格 ssl|
 |apis|`Record<string, string>`|{}|页端注入的 api 设置|

package/dist/config/index.js

@@ -46,7 +46,7 @@ const logger = _log.globalLog.getLogger("config");
  * 通用日志方法
  * @param  cat  业务类型
  * @param  type 日志等级
- */ function commonLog(cat, type) {
+ */ function commonLog(cat, type, ...rest) {
     var logArr;
     var setp = 0;
     switch(arguments.length){

package/dist/middlewares.js

@@ -25,20 +25,64 @@ const cwd = process.cwd();
     "compress": true,
     "cors": true
 };
+/**兼容老的中间件声明 */ function compatibleWithOldVer(list) {
+    const middlewares = {};
+    list.forEach((item, index)=>{
+        var subject;
+        var name;
+        subject = {
+            index
+        };
+        if ((0, _utils.isString)(item)) {
+            name = item;
+        } else if ((0, _utils.isArray)(item)) {
+            name = item[0];
+            if (item[1]) {
+                subject.config = item[1];
+            }
+        }
+        middlewares[name] = subject;
+    });
+    return middlewares;
+}
+/**获取中间件加载执行列表 */ function getExeList() {
+    const config = getSysConfig();
+    var mConfig;
+    if (config.middlewares) {
+        mConfig = config.middlewares;
+    } else if ((0, _utils.isArray)(config.middleware) && config.middleware.length) {
+        masterLog("middlewares", "warn", "middleware 配置已弃用并将在 v1.3.0 之后删除，请使用 middlewares 配置中间件");
+        mConfig = compatibleWithOldVer(config.middleware);
+    } else {
+        mConfig = null;
+    }
+    if (mConfig) {
+        return Object.keys(mConfig).filter((key)=>(0, _utils.isBoolean)(mConfig[key]) ? mConfig[key] : true).map((key, index)=>{
+            if ((0, _utils.isBoolean)(mConfig[key])) {
+                mConfig[key] = {};
+            }
+            if (!(0, _utils.isString)(mConfig[key].name)) {
+                mConfig[key].name = key;
+            }
+            if (!(0, _utils.isNumber)(mConfig[key].index)) {
+                mConfig[key].index = index;
+            }
+            return mConfig[key];
+        }).sort((now, next)=>now.index - next.index);
+    }
+    return [];
+}
 // ［最后3个中间件固定是 系统路由，静态文件服务，错误请求处理模块］
 /**加载中间件 */ function loadMiddleware(app) {
-    const config = getSysConfig();
-    if ((0, _utils.isArray)(config.middleware) && config.middleware.length) {
-        config.middleware.forEach((item)=>{
-            const isSrtItem = (0, _utils.isString)(item);
-            let name = isSrtItem ? item : item[0];
-            const conf = isSrtItem ? null : item[1];
-            if (INTERNAL_MIDDLEWARE[name]) {
-                app.use((0, _common.getRealDefaultMod)(require(`./middleware/${name}`))(conf));
+    const list = getExeList();
+    if ((0, _utils.isArray)(list) && list.length) {
+        list.forEach((item)=>{
+            if (INTERNAL_MIDDLEWARE[item.name]) {
+                app.use((0, _common.getRealDefaultMod)(require(`./middleware/${item.name}`))(item.config));
             } else {
-                app.use((0, _common.getRealDefaultMod)(require(`${cwd}/${_defaultXConfig.default.businessDir}/middleware/${name}`))(conf));
+                app.use((0, _common.getRealDefaultMod)(require(`${cwd}/${_defaultXConfig.default.businessDir}/middleware/${item.name}`))(item.config));
             }
-            masterLog(`MIDDLEWARE >>> [${name}] launch`);
+            masterLog(`MIDDLEWARE >>> [${item.name}] launch`);
         });
         console.log("");
     }

package/dist/router.js

@@ -10,6 +10,7 @@ const _utils = require("@x-drive/utils");
 const _common = require("./components/common");
 const _defaultXConfig = /*#__PURE__*/ _interopRequireDefault(require("./default-x-config"));
 const _path = /*#__PURE__*/ _interopRequireDefault(require("path"));
+const _fs = /*#__PURE__*/ _interopRequireDefault(require("fs"));
 function _interopRequireDefault(obj) {
     return obj && obj.__esModule ? obj : {
         default: obj
@@ -21,9 +22,41 @@ function _interopRequireDefault(obj) {
     }
     return `/api${api}`;
 }
+/**
+ * 递归处理文件夹
+ * @param  path         文件目录
+ * @param  middlewares  接口中间件
+ * @param  callback     查找到文件时的处理函数
+ */ function walk(dir, middlewares, callback) {
+    var files = _fs.default.readdirSync(dir);
+    files.forEach(function(item) {
+        if (!item.startsWith(".") && !item.endsWith(".d.ts")) {
+            var tmpPath = _path.default.join(dir, item);
+            var stats = _fs.default.statSync(tmpPath);
+            if (stats.isDirectory() && item.startsWith("$")) {
+                // 接口级别中间件
+                let middlewaresFiles = _fs.default.readdirSync(tmpPath);
+                middlewaresFiles.forEach(function(name) {
+                    let tmpMwPath = _path.default.join(tmpPath, name);
+                    let fileStat = _fs.default.statSync(tmpMwPath);
+                    if (!fileStat.isDirectory() && !item.startsWith(".") && !item.endsWith(".d.ts")) {
+                        middlewares.push(tmpMwPath);
+                    }
+                });
+                // 简单做下排序
+                middlewares.sort();
+            }
+            if (stats.isDirectory() && !item.startsWith("@") && !item.startsWith("$")) {
+                walk(tmpPath, middlewares, callback);
+            } else if (!stats.isDirectory()) {
+                callback(tmpPath, item, middlewares);
+            }
+        }
+    });
+}
 /**加载业务服务接口 */ function appRouter(router) {
     const IS_API_REGEXP = /^\/api\//;
-    var processBusiness = function(modPath, item) {
+    var processBusiness = function(modPath, item, middlewares) {
         var mod = require(_path.default.resolve(modPath));
         if (mod) {
             mod = (0, _common.getRealDefaultMod)(mod);
@@ -84,17 +117,26 @@ function _interopRequireDefault(obj) {
                     modName = "get";
                 }
             }
+            if (middlewares && middlewares.length) {
+                let mws = middlewares.map((name)=>(0, _common.getRealDefaultMod)(require(name)));
+                mod.splice.apply(mod, [
+                    1,
+                    0,
+                    ...mws
+                ]);
+                mws = null;
+            }
             router[modName].apply(router, mod);
             masterLog("router", `Handling API >>> [${modName}] ${api}`);
         }
     };
     // 业务基本目录
     var _p = _path.default.resolve(__dirname, "business");
-    (0, _common.walk)(_p, 0, processBusiness);
+    walk(_p, [], processBusiness);
     // 支持自定义 api
     _p = _path.default.resolve(process.cwd(), _defaultXConfig.default.businessDir, "business");
     if (process.cwd() !== __dirname && (0, _common.checkFileStat)(_p)) {
-        (0, _common.walk)(_p, 0, processBusiness);
+        walk(_p, [], processBusiness);
     }
     processBusiness = null;
     console.log("");

package/package.json

@@ -1,8 +1,8 @@
 {
     "name": "@x-9lab/xlab",
-    "version": "1.0.13",
+    "version": "1.2.0",
     "description": "9lab 服务端模块",
-    "versionDesc": "originHost 现在所有请求都会带上",
+    "versionDesc": "业务 api 文件夹支持接口级别通用中间件定义",
     "scripts": {
         "dev": "swc src -D ./src/bin --config-file .swcrc -d dist -w",
         "compile": "swc src -D ./src/bin --config-file .swcrc -d dist",