feat(0.1.0): 发布0.1.0，修复相关问题

Author: ruixiaozi

CHANGELOG.md

@@ -3,7 +3,17 @@
 > 次版本：每季度发布一次，向下兼容的功能性新增  
 > 修订版本：每周发布一次(紧急版本随时发布)，向下兼容的问题修正
 
-## 0.0.7 [Current] 
+## 0.1.0 [Current] 
+###### 发布日期：2023-11-04
+###### 兼容性：0.1.x
+
++ swagger的operateId使用tag名称结合，不兼容以前的swagger
++ 添加hook
++ 暴露返回swagger配置方法
++ 修复路由处理逻辑，保证无请求处理器的路由不进拦截器
++ 修复请求类型枚举值的问题
+
+## 0.0.7
 ###### 发布日期：2023-09-20
 ###### 兼容性：0.x.x
 

jest.config.ts

@@ -7,7 +7,7 @@ export default {
     // 所有文件总的覆盖率要求
     global: {
       branches: 70,
-      functions: 90,
+      functions: 70,
       lines: 90,
       statements: 90,
     },
@@ -35,4 +35,5 @@ export default {
       },
     ],
   },
+  maxWorkers: 1,
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "brisk-controller",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "fast light brisk controller in nodejs(koa)",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -35,9 +35,9 @@
   },
   "homepage": "https://github.com/ruixiaozi/brisk-controller#readme",
   "dependencies": {
-    "brisk-ioc": "0.0.7",
-    "brisk-log": "0.0.7",
-    "brisk-ts-extends": "0.0.7",
+    "brisk-ioc": "0.1.0",
+    "brisk-log": "0.1.0",
+    "brisk-ts-extends": "0.1.0",
     "co-body": "6.1.0",
     "formidable": "3.5.1",
     "koa": "2.14.1",

src/core/core.ts

@@ -26,17 +26,31 @@ import { isValid, parseBoolean } from './utils';
 import { addRoute, BriskControllerError, reInitRouter, isFormData, isJson, isXml, router, setBaseUrl, isFile } from './router';
 import { getBean, setBean } from 'brisk-ioc';
 
+export interface BriskControllerHooks {
+  priority: number;
+  handler: () => Promise<void> | void;
+}
 
 // 保存运行时region
 const globalVal: {
   _briskControllerRegion?: symbol,
+  _briskControllerBefores?: BriskControllerHooks[],
+  _briskControllerAfters?: BriskControllerHooks[],
   [key: string | symbol | number]: any,
 } = globalThis;
 
 if (!globalVal._briskControllerRegion) {
   globalVal._briskControllerRegion = Symbol('briskController');
 }
 
+if (!globalVal._briskControllerBefores) {
+  globalVal._briskControllerBefores = [];
+}
+
+if (!globalVal._briskControllerAfters) {
+  globalVal._briskControllerAfters = [];
+}
+
 
 const logger = getLogger(globalVal._briskControllerRegion);
 logger.configure({
@@ -45,6 +59,22 @@ logger.configure({
 });
 
 
+const sortBy = (hookA: BriskControllerHooks, hookB: BriskControllerHooks) => hookA.priority - hookB.priority;
+
+// 添加钩子
+export function addHook(pos: 'before_start' | 'after_start', hook: BriskControllerHooks) {
+  switch (pos) {
+    case 'before_start':
+      globalVal._briskControllerBefores?.push(hook);
+      break;
+    case 'after_start':
+      globalVal._briskControllerAfters?.push(hook);
+      break;
+    default:
+      break;
+  }
+}
+
 /**
  * 抛出错误响应
  * @deprecated
@@ -137,15 +167,15 @@ function validateAndTransParameter(param: BriskControllerParameter, value: any):
     const timestamp = Date.parse(value);
     // 无法转换成日期
     if (Number.isNaN(timestamp)) {
-      logger.error(`validateAndTransParameter param '${param.name}' type error`);
+      logger.error(`validateAndTransParameter param '${param.name}' type '${param.type}' error`);
       throwError(400, `param '${param.name}' type error`);
     }
     return new Date(timestamp);
   }
 
   if (getParentTypeKind(param.type) === 'Array') {
     if (!Array.isArray(value)) {
-      logger.error(`validateAndTransParameter param '${param.name}' type error`);
+      logger.error(`validateAndTransParameter param '${param.name}' type '${param.type}' error`);
       throwError(400, `param '${param.name}' type error`);
     }
     return value.map((item: any) => validateAndTransParameter({ ...param, type: getSubTypeKind(param.type) as TypeKind }, item));
@@ -157,21 +187,21 @@ function validateAndTransParameter(param: BriskControllerParameter, value: any):
     }
 
     if (typeof value !== 'string') {
-      logger.error(`validateAndTransParameter param '${param.name}' type error`);
+      logger.error(`validateAndTransParameter param '${param.name}' type '${param.type}' error`);
       throwError(400, `param '${param.name}' type error`);
     }
     switch (param.type) {
       case 'string':
         return value;
       case 'number':
         if (Number.isNaN(Number(value))) {
-          logger.error(`validateAndTransParameter param '${param.name}' type error`);
+          logger.error(`validateAndTransParameter param '${param.name}' type '${param.type}' error`);
           throwError(400, `param '${param.name}' type error`);
         }
         return Number(value);
       case 'boolean':
         if (parseBoolean(value) === undefined) {
-          logger.error(`validateAndTransParameter param '${param.name}' type error`);
+          logger.error(`validateAndTransParameter param '${param.name}' type '${param.type}' error`);
           throwError(400, `param '${param.name}' type error`);
         }
         return parseBoolean(value);
@@ -181,18 +211,19 @@ function validateAndTransParameter(param: BriskControllerParameter, value: any):
   }
 
   if (!isLike<any>(value, param.type)) {
-    logger.error(`validateAndTransParameter param '${param.name}' type error`);
+    logger.error(`validateAndTransParameter param '${param.name}' type '${param.type}' error`);
     throwError(400, `param '${param.name}' type error`);
   }
 
   const typedes = get(param.type);
 
   // 枚举直接返回
-  if (typedes.enums) {
+  if (typedes?.enums) {
     return value;
   }
 
-  return typedes.properties.reduce((pre, current) => {
+  // 消毒处理，仅转换类型描述里的属性，多余属性自动过滤掉
+  return typedes?.properties.reduce((pre, current) => {
     pre[current.key] = value[current.key];
     return pre;
   }, {} as any);
@@ -380,7 +411,7 @@ export async function start(port: number = 3000, option?: BriskControllerOption)
 
   if (option?.swagger) {
     addRequest('/swagger.json', getSwaggerHandler(realPort, globalBaseUrl), {
-      title: 'swagger文件(仅开启swagger后有效)',
+      title: 'swagger接口文档',
       description: '获取swagger.json',
       tag: {
         name: 'System',
@@ -397,6 +428,11 @@ export async function start(port: number = 3000, option?: BriskControllerOption)
     }));
   }
 
+  globalVal._briskControllerBefores?.sort(sortBy);
+  for (let beforeHook of globalVal._briskControllerBefores!) {
+    await Promise.resolve(beforeHook.handler());
+  }
+
   await new Promise((resolve) => {
     const server = app.listen(realPort, '0.0.0.0', () => {
       logger.info(`listen http://0.0.0.0:${realPort}${globalBaseUrl}`);
@@ -410,6 +446,11 @@ export async function start(port: number = 3000, option?: BriskControllerOption)
     setBean('KoaServer', server, globalVal._briskControllerRegion);
   });
 
+  globalVal._briskControllerAfters?.sort(sortBy);
+  for (let afterHook of globalVal._briskControllerAfters!) {
+    await Promise.resolve(afterHook.handler());
+  }
+
   return app;
 }
 

src/core/index.ts

@@ -1,2 +1,3 @@
 export * from './core';
-export { BriskControllerError } from './router';
+export { BriskControllerError, getBaseUrl } from './router';
+export { getSwaggerConfig } from './swagger';

src/core/router.ts

@@ -39,6 +39,10 @@ export function setBaseUrl(_baseUrl: string) {
   globalVal._briskControllerBaseUrl = _baseUrl;
 }
 
+export function getBaseUrl() {
+  return globalVal._briskControllerBaseUrl;
+}
+
 export class BriskControllerError extends Error {
 
   status!: number;
@@ -180,6 +184,7 @@ function parseBody(ctx: Context) {
 }
 
 
+// eslint-disable-next-line complexity
 export const router: Middleware = async(ctx: Context, next: Next) => {
   try {
     // 路径匹配
@@ -212,21 +217,37 @@ export const router: Middleware = async(ctx: Context, next: Next) => {
       return;
     }
 
-    // 先执行所有拦截器
+
+    const interceptors: BriskControllerRouterHandler[] = [];
+    const requests: BriskControllerRouterHandler[] = [];
+
+    // 获取所有匹配的拦截器和请求器
     for (const pathInfo of pathInfos) {
       // 路径参数放入pathParams
       (ctx.request as any).pathParams = pathInfo.params;
-      const interceptors = pathInfo.methodMap
+      interceptors.push(...(pathInfo.methodMap
         ?.get(ctx.request.method.toLowerCase() as BRISK_CONTROLLER_METHOD_E)
         ?.get(BRISK_CONTROLLER_ROUTER_TYPE_E.INTERCEPTOR)
-        || [];
+        || []));
+      requests.push(...(pathInfo.methodMap
+        ?.get(ctx.request.method.toLowerCase() as BRISK_CONTROLLER_METHOD_E)
+        ?.get(BRISK_CONTROLLER_ROUTER_TYPE_E.REQUEST)
+        || []));
+    }
 
-      for (const interceptor of interceptors) {
-        const interceptorRes = await interceptor(ctx);
-        // 返回false，则终止后续所有处理
-        if (!interceptorRes) {
-          return;
-        }
+    // 没有请求处理的，不需要拦截，也不需要再执行请求器
+    if (!requests.length) {
+      // 执行后续中间件
+      await next();
+      return;
+    }
+
+    // 先执行所有拦截器
+    for (const interceptor of interceptors) {
+      const interceptorRes = await interceptor(ctx);
+      // 返回false，则终止后续所有处理
+      if (!interceptorRes) {
+        return;
       }
     }
 
@@ -247,20 +268,11 @@ export const router: Middleware = async(ctx: Context, next: Next) => {
     }
 
     // 执行所有请求处理器
-    for (const pathInfo of pathInfos) {
-      // 路径参数放入pathParams
-      (ctx.request as any).pathParams = pathInfo.params;
-      const requests = pathInfo.methodMap
-        ?.get(ctx.request.method.toLowerCase() as BRISK_CONTROLLER_METHOD_E)
-        ?.get(BRISK_CONTROLLER_ROUTER_TYPE_E.REQUEST)
-        || [];
-
-      for (const request of requests) {
-        const requestRes = await request(ctx);
-        // 返回false，则终止后续所有处理
-        if (!requestRes) {
-          return;
-        }
+    for (const request of requests) {
+      const requestRes = await request(ctx);
+      // 返回false，则终止后续所有处理
+      if (!requestRes) {
+        return;
       }
     }
 

src/core/swagger.ts

@@ -274,9 +274,11 @@ export function addSwaggerRoute(routePath: string, option?: BriskControllerReque
 
   const methods = Array.isArray(option?.method) ? option!.method : [option?.method || BRISK_CONTROLLER_METHOD_E.GET];
   methods.forEach((method) => {
+    const tagName = option?.tag?.name || defaultTag.name;
     globalVal._briskSwaggerConfig!.paths[transRoutePath][method] = {
-      operationId: option?.name,
-      tags: [option?.tag?.name || defaultTag.name],
+      // operationId应该保障全局唯一
+      operationId: (option?.name || Math.floor(Math.random() * 10000).toFixed(16)) + tagName,
+      tags: [tagName],
       summary: option?.title,
       description: option?.description,
       parameters: option?.params
@@ -329,3 +331,7 @@ export function getSwaggerHandler(port: number, basePath: string) {
   globalVal._briskSwaggerConfig!.info.description = `<b>注意：仅开启swagger选项有效，建议上线前关闭该选项</b>\n\n${packageInfo.description}`;
   return () => globalVal._briskSwaggerConfig!;
 }
+
+export function getSwaggerConfig() {
+  return globalVal._briskSwaggerConfig!;
+}

src/decorator/index.ts

@@ -1,7 +1,7 @@
 import { setBean } from 'brisk-ioc';
 import { DecoratorFactory } from 'brisk-ts-extends';
 import { getParentTypeKind, getSubTypeKind } from 'brisk-ts-extends/runtime';
-import { addInterceptor, addRequest } from '../core';
+import { addHook, addInterceptor, addRequest } from '../core';
 import {
   BriskControllerDecoratorInterceptor,
   BriskControllerDecoratorOption,
@@ -12,8 +12,8 @@ import {
 
 
 enum BRISK_CONTROLLER_DECORATOR_ROUTE_TYPE_E {
-  REQUEST,
-  INTERCEPTOR,
+  INTERCEPTOR = '0',
+  REQUEST = '1',
 }
 
 /**
@@ -216,3 +216,36 @@ export function Interceptor(path: string, option?: BriskControllerDecoratorInter
     })
     .getDecorator();
 }
+
+
+/**
+ * 控制层启动前
+ * @param priority 优先级，默认10
+ * @returns
+ */
+export function BeforeControllerStart(priority: number = 10): Function {
+  return new DecoratorFactory()
+    .setMethodCallback((target, key, descriptor) => {
+      addHook('before_start', {
+        priority,
+        handler: descriptor.value?.bind(target),
+      });
+    })
+    .getDecorator();
+}
+
+/**
+ * 控制层启动后
+ * @param priority 优先级，默认10
+ * @returns
+ */
+export function AfterControllerStart(priority: number = 10): Function {
+  return new DecoratorFactory()
+    .setMethodCallback((target, key, descriptor) => {
+      addHook('after_start', {
+        priority,
+        handler: descriptor.value?.bind(target),
+      });
+    })
+    .getDecorator();
+}