feat(0.0.5): 拦截器和请求处理器可配置多个method，发布0.0.5

Author: ruixiaozi

CHANGELOG.md

@@ -3,7 +3,14 @@
 > 次版本：每季度发布一次，向下兼容的功能性新增  
 > 修订版本：每周发布一次(紧急版本随时发布)，向下兼容的问题修正
 
-## 0.0.4 [Current] 
+## 0.0.5 [Current] 
+###### 发布日期：2023-06-27
+###### 兼容性：0.x.x
+
++ 拦截器和请求处理器可配置多个method
+
+
+## 0.0.4
 ###### 发布日期：2023-05-23
 ###### 兼容性：0.x.x
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "brisk-controller",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "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.4",
-    "brisk-log": "0.0.4",
-    "brisk-ts-extends": "0.0.4",
+    "brisk-ioc": "0.0.5",
+    "brisk-log": "0.0.5",
+    "brisk-ts-extends": "0.0.5",
     "co-body": "^6.1.0",
     "koa": "2.14.1",
     "koa-cors": "0.0.16",

src/core/core.ts

@@ -80,7 +80,7 @@ export async function forward<T>(targetPath: string, method = BRISK_CONTROLLER_M
 }
 
 /**
- * 返回结果工程
+ * 返回结果工厂
  * @param result 返回对象
  * @returns 返回一个工厂对象
  */

src/core/router.ts

@@ -65,19 +65,23 @@ export function addRoute(path: string, handler: BriskControllerRouterHandler, op
     routers.set(realPath, methodMap);
   }
 
-  let typeMap = methodMap.get(option?.method || BRISK_CONTROLLER_METHOD_E.GET);
-  if (!typeMap) {
-    typeMap = new Map();
-    methodMap.set(option?.method || BRISK_CONTROLLER_METHOD_E.GET, typeMap);
-  }
+  const methods = Array.isArray(option?.method) ? option!.method : [option?.method || BRISK_CONTROLLER_METHOD_E.GET];
 
-  let handlers = typeMap.get(option?.type || BRISK_CONTROLLER_ROUTER_TYPE_E.REQUEST);
-  if (!handlers) {
-    handlers = [];
-    typeMap.set(option?.type || BRISK_CONTROLLER_ROUTER_TYPE_E.REQUEST, handlers);
-  }
+  methods.forEach((method) => {
+    let typeMap = methodMap!.get(method);
+    if (!typeMap) {
+      typeMap = new Map();
+      methodMap!.set(method, typeMap);
+    }
+
+    let handlers = typeMap.get(option?.type || BRISK_CONTROLLER_ROUTER_TYPE_E.REQUEST);
+    if (!handlers) {
+      handlers = [];
+      typeMap.set(option?.type || BRISK_CONTROLLER_ROUTER_TYPE_E.REQUEST, handlers);
+    }
 
-  handlers.push(handler);
+    handlers.push(handler);
+  });
 }
 
 const jsonTypes = [

src/core/swagger.ts

@@ -217,49 +217,53 @@ export function addSwaggerRoute(routePath: string, option?: BriskControllerReque
   if (!swaggerConfig.paths[transRoutePath]) {
     swaggerConfig.paths[transRoutePath] = {};
   }
-  swaggerConfig.paths[transRoutePath][option?.method || BRISK_CONTROLLER_METHOD_E.GET] = {
-    operationId: option?.name,
-    tags: [option?.tag?.name || defaultTag.name],
-    summary: option?.title,
-    description: option?.description,
-    parameters: option?.params
-      ?.filter((item) => [
-        BRISK_CONTROLLER_PARAMETER_IS_E.PATH,
-        BRISK_CONTROLLER_PARAMETER_IS_E.QUERY,
-        BRISK_CONTROLLER_PARAMETER_IS_E.HEADER,
-        BRISK_CONTROLLER_PARAMETER_IS_E.COOKIE,
-      ].includes(item.is))
-      .map((item) => ({
-        in: item.is,
-        name: item.name,
-        required: Boolean(item.required),
-        schema: item.type ? transforSwaggerSchema(item.type) : undefined,
-        description: item.is === BRISK_CONTROLLER_PARAMETER_IS_E.COOKIE ? `${item?.description || ''}\n<b>本页面无法发送cookie</b>` : item?.description,
-      })),
-    requestBody: transforSwaggerReqBody(option?.params),
-    responses: option?.redirect
-      ? {
-        [`${option.redirect.status || 301}`]: {
-          description: 'redirect',
-          headers: {
-            Location: {
-              description: `${JSON.stringify(option.redirect.urls)}`,
-              schema: { type: BRISK_CONTROLLER_PARAMTYPE_E.String },
+
+  const methods = Array.isArray(option?.method) ? option!.method : [option?.method || BRISK_CONTROLLER_METHOD_E.GET];
+  methods.forEach((method) => {
+    swaggerConfig.paths[transRoutePath][method] = {
+      operationId: option?.name,
+      tags: [option?.tag?.name || defaultTag.name],
+      summary: option?.title,
+      description: option?.description,
+      parameters: option?.params
+        ?.filter((item) => [
+          BRISK_CONTROLLER_PARAMETER_IS_E.PATH,
+          BRISK_CONTROLLER_PARAMETER_IS_E.QUERY,
+          BRISK_CONTROLLER_PARAMETER_IS_E.HEADER,
+          BRISK_CONTROLLER_PARAMETER_IS_E.COOKIE,
+        ].includes(item.is))
+        .map((item) => ({
+          in: item.is,
+          name: item.name,
+          required: Boolean(item.required),
+          schema: item.type ? transforSwaggerSchema(item.type) : undefined,
+          description: item.is === BRISK_CONTROLLER_PARAMETER_IS_E.COOKIE ? `${item?.description || ''}\n<b>本页面无法发送cookie</b>` : item?.description,
+        })),
+      requestBody: transforSwaggerReqBody(option?.params),
+      responses: option?.redirect
+        ? {
+          [`${option.redirect.status || 301}`]: {
+            description: 'redirect',
+            headers: {
+              Location: {
+                description: `${JSON.stringify(option.redirect.urls)}`,
+                schema: { type: BRISK_CONTROLLER_PARAMTYPE_E.String },
+              },
             },
           },
-        },
-      }
-      : {
-        '200': {
-          description: 'OK',
-          content: {
-            'application/json': {
-              schema: option?.successResponseType ? transforSwaggerSchema(option.successResponseType) : {},
+        }
+        : {
+          '200': {
+            description: 'OK',
+            content: {
+              'application/json': {
+                schema: option?.successResponseType ? transforSwaggerSchema(option.successResponseType) : {},
+              },
             },
           },
         },
-      },
-  };
+    };
+  });
 }
 
 const packageInfo = require(path.join(process.cwd(), 'package.json'));

src/types/base.ts

@@ -24,7 +24,7 @@ export interface BriskControllerRouterOption {
   // 默认是request
   type?: BRISK_CONTROLLER_ROUTER_TYPE_E;
   // 默认是get
-  method?: BRISK_CONTROLLER_METHOD_E;
+  method?: BRISK_CONTROLLER_METHOD_E | BRISK_CONTROLLER_METHOD_E[];
 }
 
 export interface BriskControllerHeaders {
@@ -88,7 +88,7 @@ export interface BriskControllerParameter {
 
 export interface BriskControllerInterceptorOption {
   // 默认为GET
-  method?: BRISK_CONTROLLER_METHOD_E;
+  method?: BRISK_CONTROLLER_METHOD_E | BRISK_CONTROLLER_METHOD_E[];
   // 基础地址，默认相对于globalBaseUrl的根路径
   baseUrl?: string;
 }

src/types/decorator.ts

@@ -14,14 +14,14 @@ export interface BriskControllerDecoratorRequest {
   // 描述，用于swagger显示
   description?: string;
   // 默认为get
-  method?: BRISK_CONTROLLER_METHOD_E;
+  method?: BRISK_CONTROLLER_METHOD_E | BRISK_CONTROLLER_METHOD_E[];
   // 跳转信息，仅当返回redrect方法时
   redirect?: BriskControllerRedirectInfo;
 }
 
 export interface BriskControllerDecoratorInterceptor {
   // 默认为get
-  method?: BRISK_CONTROLLER_METHOD_E;
+  method?: BRISK_CONTROLLER_METHOD_E | BRISK_CONTROLLER_METHOD_E[];
 }
 
 export interface BriskControllerDecoratorParam {