feat(0.0.6): 添加xml支持

ruixiaozi · ruixiaozi · commit cd85164f4fcd · 2023-09-08T12:40:10.000+08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,7 +3,14 @@
 > 次版本：每季度发布一次，向下兼容的功能性新增  
 > 修订版本：每周发布一次(紧急版本随时发布)，向下兼容的问题修正
 
-## 0.0.5 [Current] 
+## 0.0.6 [Current] 
+###### 发布日期：2023-09-08
+###### 兼容性：0.x.x
+
++ 增加xml支持
++ 修改日志输出
+
+## 0.0.5 
 ###### 发布日期：2023-06-27
 ###### 兼容性：0.x.x
 
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "brisk-controller",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "fast light brisk controller in nodejs(koa)",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -35,26 +35,28 @@
   },
   "homepage": "https://github.com/ruixiaozi/brisk-controller#readme",
   "dependencies": {
-    "brisk-ioc": "0.0.5",
-    "brisk-log": "0.0.5",
-    "brisk-ts-extends": "0.0.5",
-    "co-body": "^6.1.0",
+    "brisk-ioc": "0.0.6",
+    "brisk-log": "0.0.6",
+    "brisk-ts-extends": "0.0.6",
+    "co-body": "6.1.0",
     "koa": "2.14.1",
     "koa-cors": "0.0.16",
     "koa-static": "5.0.0",
     "koa2-swagger-ui": "5.6.0",
-    "path-to-regexp": "^6.2.1",
-    "portfinder": "^1.0.32"
+    "path-to-regexp": "6.2.1",
+    "portfinder": "1.0.32",
+    "xml2js": "0.6.2"
   },
   "devDependencies": {
     "@commitlint/cli": "16.2.1",
     "@commitlint/config-conventional": "16.2.1",
-    "@types/co-body": "^6.1.0",
+    "@types/co-body": "6.1.0",
     "@types/jest": "29.2.5",
     "@types/koa": "2.13.5",
     "@types/koa-cors": "0.0.2",
     "@types/koa-static": "4.0.2",
     "@types/supertest": "2.0.12",
+    "@types/xml2js": "0.4.11",
     "@typescript-eslint/eslint-plugin": "5.36.1",
     "@typescript-eslint/parser": "5.36.1",
     "copyfiles": "2.4.1",
diff --git a/src/core/core.ts b/src/core/core.ts
@@ -24,7 +24,7 @@ import { isLike, TypeKind } from 'brisk-ts-extends';
 import { get, getParentTypeKind, getSubTypeKind } from 'brisk-ts-extends/runtime';
 import { addSwaggerRoute, addSwaggerTag, getSwaggerHandler, initSwaggerConfig } from './swagger';
 import { isValid, parseBoolean } from './utils';
-import { addRoute, BriskControllerError, initRouter, isFormData, isJson, router, setBaseUrl } from './router';
+import { addRoute, BriskControllerError, initRouter, isFormData, isJson, isXml, router, setBaseUrl } from './router';
 
 
 const defaultRegion = Symbol('briskController');
@@ -117,24 +117,27 @@ export function resultFactory<T>(result: T): BriskControllerResultFactory<T> {
 // 参数校验、参数类型转换
 function validateAndTransParameter(param: BriskControllerParameter, value: any): any {
   if (!isValid(value) && param.required) {
+    logger.error(`validateAndTransParameter param '${param.name}' required`);
     throwError(400, `param '${param.name}' required`);
   }
 
-  if (!param.type) {
+  if (!param.type || param.type === 'any') {
     return value;
   }
 
   if (param.type === 'Date') {
     const timestamp = Date.parse(value);
     // 无法转换成日期
     if (Number.isNaN(timestamp)) {
+      logger.error(`validateAndTransParameter param '${param.name}' 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`);
       throwError(400, `param '${param.name}' type error`);
     }
     return value.map((item: any) => validateAndTransParameter({ ...param, type: getSubTypeKind(param.type) as TypeKind }, item));
@@ -146,18 +149,21 @@ function validateAndTransParameter(param: BriskControllerParameter, value: any):
     }
 
     if (typeof value !== 'string') {
+      logger.error(`validateAndTransParameter param '${param.name}' 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`);
           throwError(400, `param '${param.name}' type error`);
         }
         return Number(value);
       case 'boolean':
         if (parseBoolean(value) === undefined) {
+          logger.error(`validateAndTransParameter param '${param.name}' type error`);
           throwError(400, `param '${param.name}' type error`);
         }
         return parseBoolean(value);
@@ -167,6 +173,7 @@ function validateAndTransParameter(param: BriskControllerParameter, value: any):
   }
 
   if (!isLike<any>(value, param.type)) {
+    logger.error(`validateAndTransParameter param '${param.name}' type error`);
     throwError(400, `param '${param.name}' type error`);
   }
 
@@ -191,6 +198,7 @@ function validateParameter(param: BriskControllerParameter, value: any) {
   const error = param.validator?.(val);
 
   if (error && typeof error === 'object') {
+    logger.error(Object.values(error)?.[0]?.defaultTip || '');
     throwError(400, Object.values(error)?.[0]?.defaultTip);
   }
 
@@ -208,13 +216,13 @@ function getParameters(ctx: Context, params?: BriskControllerParameter[]) {
     let value: any;
     switch (item.is) {
       case BRISK_CONTROLLER_PARAMETER_IS_E.IN_BODY:
-        value = isJson(ctx) ? data[item.name] : undefined;
+        value = isJson(ctx) || isXml(ctx) ? data[item.name] : undefined;
         break;
       case BRISK_CONTROLLER_PARAMETER_IS_E.FORM_DATA:
         value = isFormData(ctx) ? data[item.name] : undefined;
         break;
       case BRISK_CONTROLLER_PARAMETER_IS_E.BODY:
-        value = isJson(ctx) ? data : undefined;
+        value = isJson(ctx) || isXml(ctx) ? data : undefined;
         break;
       case BRISK_CONTROLLER_PARAMETER_IS_E.QUERY:
         value = ctx.request.query[item.name];
@@ -290,30 +298,33 @@ export function addRequest(requestPath: string, handler: BriskControllerRequestH
         query: ctx.request.query,
       });
       const res = await Promise.resolve(handler(...getParameters(ctx, option?.params)));
-      if (res._extra) {
-        const extra = res._extra;
-        delete res._extra;
-        extra.cookies?.forEach?.((item: any) => {
-          ctx.cookies.set(item.key, item.value, item.option);
-        });
-        extra.headers?.forEach?.((item: any) => {
-          ctx.response.set(item.key, item.value);
-        });
-      }
+      if (typeof res === 'object') {
+        if (res._extra) {
+          const extra = res._extra;
+          delete res._extra;
+          extra.cookies?.forEach?.((item: any) => {
+            ctx.cookies.set(item.key, item.value, item.option);
+          });
+          extra.headers?.forEach?.((item: any) => {
+            ctx.response.set(item.key, item.value);
+          });
+        }
 
-      if (res._briskControllerRedirect) {
-        ctx.response.status = res._briskControllerRedirect.status;
-        ctx.redirect(res._briskControllerRedirect.targetPath);
-        return false;
-      }
+        if (res._briskControllerRedirect) {
+          ctx.response.status = res._briskControllerRedirect.status;
+          ctx.redirect(res._briskControllerRedirect.targetPath);
+          return false;
+        }
 
-      if (res._briskControllerForward) {
-        ctx.request.method = res._briskControllerForward.method.toUpperCase();
-        ctx.request.path = res._briskControllerForward.targetPath;
-        await router(ctx, () => Promise.resolve(null));
-      } else {
-        ctx.response.body = res;
+        if (res._briskControllerForward) {
+          ctx.request.method = res._briskControllerForward.method.toUpperCase();
+          ctx.request.path = res._briskControllerForward.targetPath;
+          await router(ctx, () => Promise.resolve(null));
+          return true;
+        }
       }
+      ctx.response.body = res;
+
       logger.info(`response ${ctx.request.url}`, {
         status: ctx.response.status,
         body: ctx.response.body,
diff --git a/src/core/router.ts b/src/core/router.ts
@@ -13,6 +13,7 @@ import { match } from 'path-to-regexp';
 import parse from 'co-body';
 import { getLogger, LOGGER_LEVEL_E } from 'brisk-log';
 import nodePath from 'path';
+import { parseStringPromise } from 'xml2js';
 
 let baseUrl = '/';
 
@@ -91,6 +92,7 @@ const jsonTypes = [
 ];
 const formTypes = [BRISK_CONTROLLER_MIME_TYPE_E.APPLICATION_X_WWW_FORM_URLENCODED];
 const textTypes = [BRISK_CONTROLLER_MIME_TYPE_E.TEXT_PLAIN];
+const xmlTypes = [BRISK_CONTROLLER_MIME_TYPE_E.TEXT_XML];
 
 export function isJson(ctx: Context) {
   return ctx.request.is(jsonTypes);
@@ -104,6 +106,10 @@ export function isText(ctx: Context) {
   return ctx.request.is(textTypes);
 }
 
+export function isXml(ctx: Context) {
+  return ctx.request.is(xmlTypes);
+}
+
 function parseBody(ctx: Context) {
   if (isJson(ctx)) {
     return parse.json(ctx, {
@@ -128,6 +134,19 @@ function parseBody(ctx: Context) {
     }).then((res) => res || '');
   }
 
+  if (isXml(ctx)) {
+    return parse.text(ctx, {
+      returnRawBody: true,
+      encoding: 'utf-8',
+    }).then((res) => {
+      logger.debug('xml: ', res);
+      return parseStringPromise(res.parsed || '').then((xml) => ({
+        parsed: xml,
+        raw: res.raw,
+      }));
+    });
+  }
+
   return Promise.resolve({});
 }
 
@@ -184,6 +203,7 @@ export const router: Middleware = async(ctx: Context, next: Next) => {
       }
     } catch (parseError) {
       logger.error('parseBody failed!');
+      logger.debug('parseBody failed error: ', parseError);
       ctx.response.status = 400;
       ctx.response.body = 'request body is format error';
       return;
