create-dp-koa 1.1.2 → 1.1.3

package/template/src/framework/utils/router.ts

@@ -1,417 +0,0 @@
-import koaRouter from 'koa-router'
-import path from "path"
-import { IParamTypeEnum } from "@src/framework/decorator/controller"
-import { getRandoNumer, isPromise } from "@src/framework/utils/function"
-const _router = new koaRouter()
-import { Provider } from "dp-ioc2"
-import { validate } from "class-validator"
-import { Context } from "koa"
-import { logger } from '@src/framework/utils/logger'
-import { createCache, CacheType } from "@src/framework/utils/cache";
-
-// 导入新的路由系统
-import { callControllerWithProcessors } from '@src/framework/utils/NewRouter';
-
-// 配置开关：是否使用新的注解处理器系统
-// 动态检查环境变量，而不是在模块加载时固定
-function isNewAnnotationSystemEnabled(): boolean {
-    return process.env.USE_NEW_ANNOTATION_SYSTEM === '1';
-}
-
-// 使用统一的缓存管理创建控制器结果缓存
-const controllerResultCacheStore = createCache('controller-result', CacheType.CONTROLLER, {
-   stdTTL: 20, // 20秒过期
-   maxKeys: 2000 // 控制器缓存可以更多
-});
-
-const responseValidate = async function (controller: any, methods: string, res: any) {
-   if (controller.$_ResponseValidateIf && controller.$_ResponseValidateIf.get(methods)) {
-      const { fn, clas } = controller.$_ResponseValidateIf.get(methods);
-      let _callResult = fn(res);
-      if (isPromise(_callResult)) {
-         _callResult = await _callResult;
-      }
-      if (_callResult && (_callResult instanceof Object)) {
-         const _dto = new clas;
-         let dataObject = _callResult;
-         // for (let i in dataObject) {
-         //    _dto[i] = dataObject[i]
-         // }
-         Object.assign(_dto, dataObject);
-         return await validate(_dto, {
-            skipMissingProperties: false,
-            forbidNonWhitelisted: true,
-            whitelist: true,
-         });
-         // return await validate(_dto);
-      }
-   } else if (controller.$_ResponseValidator && controller.$_ResponseValidator.get(methods)) {
-      const { clas, objectKey } = controller.$_ResponseValidator.get(methods);
-      if (res instanceof Object) {
-         const _dto = new clas;
-         let dataObject = res;
-         if (objectKey && res[objectKey] && (res[objectKey] instanceof Object)) {
-            dataObject = res[objectKey];
-         }
-         // 严格验证所有字段
-         Object.assign(_dto, dataObject);
-         return await validate(_dto, {
-            skipMissingProperties: false,
-            forbidNonWhitelisted: true,
-            whitelist: true,
-         });
-      }
-   }
-   return []
-}
-
-
-async function callController(ctx: Context, controller: any, methods: string) {
-   if (isNewAnnotationSystemEnabled()) {
-      // 使用新的注解处理器系统
-      return await callControllerWithProcessors(ctx, controller, methods);
-   } else {
-      // 使用原有的逻辑
-      return await callControllerLegacy(ctx, controller, methods);
-   }
-}
-
-async function callControllerLegacy(ctx: Context, controller: any, methods: string) {
-   const callParam: any[] = [];
-   if (controller.$_MethdosParamInfo) {
-      const paramsInfo: undefined | { type: IParamTypeEnum, validate: any }[] = controller.$_MethdosParamInfo.get(methods);
-      if (paramsInfo && paramsInfo.length > 0) {
-         //  console.log(paramsInfo,"参数信息")
-         for (let paramInfo of paramsInfo) {
-
-            let data = undefined;
-            if (paramInfo.type == IParamTypeEnum.Body) {
-               data = ctx.request.body;
-            }
-
-            switch (paramInfo.type) {
-               case IParamTypeEnum.Body:
-                  data = ctx.request.body;
-                  break;
-               case IParamTypeEnum.Query:
-                  data = ctx.query;
-                  break;
-               case IParamTypeEnum.Params:
-                  data = ctx.params;
-                  break;
-               case IParamTypeEnum.Headers:
-                  data = ctx.request.headers;
-                  break;
-               case IParamTypeEnum.State:
-                  data = ctx.state;
-                  break;
-            }
-            //这里可以统一做参数校验（仅当 validate 为 DTO 类构造函数时）
-            if (paramInfo.validate && typeof paramInfo.validate === 'function') {
-               const waitToValidateObject = new paramInfo.validate();
-
-               for (let i in data) {
-                  if (waitToValidateObject.$_Transform && waitToValidateObject.$_Transform.get(i)) {
-                     const func = waitToValidateObject.$_Transform.get(i);
-                     const result = func(data[i]);
-                     if (isPromise(result)) {
-                        waitToValidateObject[i] = await result;
-                     } else {
-                        waitToValidateObject[i] = result;
-                     }
-                  } else {
-                     waitToValidateObject[i] = data[i]
-                  }
-               }
-
-               const validateErrors = await validate(waitToValidateObject);
-
-               if (validateErrors.length > 0) {
-                  ctx.status = 400;
-                  return ctx.body = validateErrors;
-               }
-            }
-            callParam.push(data);
-         }
-      }
-   }
-   // 调用controller
-   try {
-
-      let controllerCacheInfo: any = null;
-      if (controller.$_ControllerCache && controller.$_ControllerCache.get(methods)) {
-         const { cacheyFn, options } = controller.$_ControllerCache.get(methods);
-         if (options && (options.enable === undefined || options.enable)) {
-            const cacheKey = cacheyFn(...callParam);
-            if (cacheKey) {
-               const cacheResult = controllerResultCacheStore.get(cacheKey);
-               if (cacheResult) {
-                  return ctx.body = cacheResult;
-               }
-
-               controllerCacheInfo = {
-                  cacheyFn, options, cacheKey,
-               }
-            }
-         }
-
-
-
-
-      }
-
-      const callResult = controller[methods].apply(controller, callParam);
-      if (controller.$_ResponseCode) {
-         const code = controller.$_ResponseCode.get(methods) ?? 200;
-         ctx.status = code;
-      }
-      if (controller.$_ResponseHeader) {
-         const responseHeaders = controller.$_ResponseHeader.get(methods);
-         if (responseHeaders) {
-            responseHeaders.keys().forEach((key: string) => {
-               const value = responseHeaders.get(key);
-               if (value) {
-                  ctx.set(key, value);
-               }
-            });
-         }
-      }
-
-
-
-      if (isPromise(callResult)) {
-         const res = await callResult;
-         const resValidateResult = await responseValidate(controller, methods, res);
-         if (resValidateResult.length > 0) {
-            ctx.status = 400;
-            logger.error(resValidateResult.join(', '))
-            return ctx.body = `接口${methods}返回数据参数校验异常`;
-         }
-         ctx.body = res;
-      } else {
-         const resValidateResult = await responseValidate(controller, methods, callResult);
-         if (resValidateResult.length > 0) {
-            ctx.status = 400;
-            return ctx.body = resValidateResult;
-         }
-         ctx.body = callResult;
-      }
-
-      // 可以在这里 加入 控制器方法缓存的数据
-      if (controllerCacheInfo) {
-         // 创建缓存
-         const { options, cacheKey, } = controllerCacheInfo;
-         if (options && (options.enable === undefined || options.enable)) {
-            let ttl = 20;
-            if (options && options.ttl) {
-               if (options.ttl instanceof Object) {
-                  ttl = getRandoNumer(options.ttl.min, options.ttl.max)
-               }
-            }
-            controllerResultCacheStore.set(cacheKey, ctx.body, ttl)
-         }
-
-      }
-
-   } catch (err) {
-      throw err;
-      // 这里要抛出异常，并且以更详细的信息抛出来
-   }
-}
-/**
- * 绑定路由
- * @param path 路由路径
- * @param controller 控制器
- */
-export const bindRouter = (...args: any[]) => {
-   if (args.length < 2) {
-      throw new Error("路由绑定至少2个参数");
-   }
-   const _path: string = args[0];
-   const Controller: any = args[args.length - 1];
-
-   const middlewares: any = [];
-   //表示有中间件
-   if (args.length > 2) {
-      for (let i in args) {
-         let index = Number(i);
-         if (index != 0 && index != args.length - 1) {
-            middlewares.push(args[i]);
-         }
-      }
-   }
-
-   const controller = Provider<any>(Controller);
-   // 绑定post方法
-   if (controller.$_PostMethods) {
-      const postMethods: Array<{ methodName: string, url: string }> = Array.from(controller.$_PostMethods);
-      postMethods.forEach(_methods => {
-         const { methodName, url } = _methods;
-         const methods = methodName;
-         if (controller[methods]) {
-            const _url = path.join(_path, url).replace(/\\/g, "/");
-
-            const cb = async (ctx: any) => {
-               // 读取该方法的参数注解信息
-               await callController(ctx, controller, methods);
-            }
-            if (middlewares.length > 0) {
-               for (const middleware of middlewares) {
-                  _router.use(_url, middleware);
-               }
-            }
-            _router.post(_url, cb)
-            
-            // 如果URL以斜杠结尾，同时注册无斜杠版本
-            if (_url.endsWith('/') && _url !== '/') {
-               const urlWithoutSlash = _url.slice(0, -1);
-               if (middlewares.length > 0) {
-                  for (const middleware of middlewares) {
-                     _router.use(urlWithoutSlash, middleware);
-                  }
-               }
-               _router.post(urlWithoutSlash, cb)
-            }
-         }
-      })
-   }
-
-   // 绑定 get方法
-   if (controller.$_GetMethods) {
-      const postMethods: Array<{ methodName: string, url: string }> = Array.from(controller.$_GetMethods);
-      postMethods.forEach(_methods => {
-         const { methodName, url } = _methods;
-         const methods = methodName;
-         if (controller[methods]) {
-            const _url = path.join(_path, url).replace(/\\/g, "/");
-            const cb = async (ctx: any) => {
-               // 读取该方法的参数注解信息
-               await callController(ctx, controller, methods);
-            }
-            if (middlewares.length > 0) {
-               for (const middleware of middlewares) {
-                  _router.use(_url, middleware);
-               }
-            }
-            _router.get(_url, cb)
-            
-            // 如果URL以斜杠结尾，同时注册无斜杠版本
-            if (_url.endsWith('/') && _url !== '/') {
-               const urlWithoutSlash = _url.slice(0, -1);
-               if (middlewares.length > 0) {
-                  for (const middleware of middlewares) {
-                     _router.use(urlWithoutSlash, middleware);
-                  }
-               }
-               _router.get(urlWithoutSlash, cb)
-            }
-
-         }
-      })
-   }
-
-   // 绑定 put 方法
-   if (controller.$_PutMethods) {
-      const postMethods: Array<{ methodName: string, url: string }> = Array.from(controller.$_PutMethods);
-      postMethods.forEach(_methods => {
-         const { methodName, url } = _methods;
-         const methods = methodName;
-         if (controller[methods]) {
-            const _url = path.join(_path, url).replace(/\\/g, "/");
-
-            const cb = async (ctx: any) => {
-               // 读取该方法的参数注解信息
-               await callController(ctx, controller, methods);
-            }
-            if (middlewares.length > 0) {
-               for (const middleware of middlewares) {
-                  _router.use(_url, middleware);
-               }
-            }
-            _router.put(_url, cb)
-            
-            // 如果URL以斜杠结尾，同时注册无斜杠版本
-            if (_url.endsWith('/') && _url !== '/') {
-               const urlWithoutSlash = _url.slice(0, -1);
-               if (middlewares.length > 0) {
-                  for (const middleware of middlewares) {
-                     _router.use(urlWithoutSlash, middleware);
-                  }
-               }
-               _router.put(urlWithoutSlash, cb)
-            }
-         }
-      })
-   }
-
-   // 绑定 del 方法
-   if (controller.$_DelMethods) {
-      const postMethods: Array<{ methodName: string, url: string }> = Array.from(controller.$_DelMethods);
-      postMethods.forEach(_methods => {
-         const { methodName, url } = _methods;
-         const methods = methodName;
-         if (controller[methods]) {
-            const _url = path.join(_path, url).replace(/\\/g, "/");
-            const cb = async (ctx: any) => {
-               // 读取该方法的参数注解信息
-               await callController(ctx, controller, methods);
-            }
-            if (middlewares.length > 0) {
-               for (const middleware of middlewares) {
-                  _router.use(_url, middleware);
-               }
-            }
-            _router.del(_url, cb)
-            
-            // 如果URL以斜杠结尾，同时注册无斜杠版本
-            if (_url.endsWith('/') && _url !== '/') {
-               const urlWithoutSlash = _url.slice(0, -1);
-               if (middlewares.length > 0) {
-                  for (const middleware of middlewares) {
-                     _router.use(urlWithoutSlash, middleware);
-                  }
-               }
-               _router.del(urlWithoutSlash, cb)
-            }
-         }
-      })
-   }
-
-
-   // 绑定 all 方法
-   if (controller.$_AllMethods) {
-      const postMethods: Array<{ methodName: string, url: string }> = Array.from(controller.$_AllMethods);
-      postMethods.forEach(_methods => {
-         const { methodName, url } = _methods;
-         const methods = methodName;
-         if (controller[methods]) {
-            const _url = path.join(_path, url).replace(/\\/g, "/");
-            const cb = async (ctx: any) => {
-               // 读取该方法的参数注解信息
-               await callController(ctx, controller, methods);
-            }
-            if (middlewares.length > 0) {
-               for (const middleware of middlewares) {
-                  _router.use(_url, middleware);
-               }
-            }
-            _router.all(_url, cb)
-            
-            // 如果URL以斜杠结尾，同时注册无斜杠版本
-            if (_url.endsWith('/') && _url !== '/') {
-               const urlWithoutSlash = _url.slice(0, -1);
-               if (middlewares.length > 0) {
-                  for (const middleware of middlewares) {
-                     _router.use(urlWithoutSlash, middleware);
-                  }
-               }
-               _router.all(urlWithoutSlash, cb)
-            }
-         }
-      })
-   }
-
-}
-
-// 导出路由对象
-export const router = _router;

package/template/src/framework/utils/swagger.ts

@@ -1,184 +0,0 @@
-import swaggerJsdoc from 'swagger-jsdoc';
-import { logger } from './logger';
-
-/**
- * Swagger配置
- */
-const swaggerOptions: swaggerJsdoc.Options = {
-  definition: {
-    openapi: '3.0.0',
-    info: {
-      title: 'DP Koa Framework API',
-      version: '1.0.0',
-      description: '基于Koa的企业级框架API文档',
-      contact: {
-        name: 'API Support',
-        email: 'support@example.com',
-      },
-      license: {
-        name: 'MIT',
-        url: 'https://opensource.org/licenses/MIT',
-      },
-    },
-    servers: [
-      {
-        url: process.env.API_BASE_URL || 'http://localhost:3000',
-        description: '开发环境',
-      },
-    ],
-    components: {
-      securitySchemes: {
-        bearerAuth: {
-          type: 'http',
-          scheme: 'bearer',
-          bearerFormat: 'JWT',
-          description: 'JWT授权',
-        },
-      },
-    },
-    tags: [
-      {
-        name: '示例',
-        description: '示例API接口',
-      },
-      {
-        name: '用户',
-        description: '用户相关接口',
-      },
-      {
-        name: '健康检查',
-        description: '系统健康检查接口',
-      },
-    ],
-  },
-  apis: [
-    './src/controllers/**/*.ts',
-    './src/dto/**/*.ts',
-  ],
-};
-
-/**
- * 生成Swagger规范
- */
-export function getSwaggerSpec(): any {
-  const spec = swaggerJsdoc(swaggerOptions);
-  return spec;
-}
-
-/**
- * 从Controller中提取Swagger信息
- */
-export function extractSwaggerFromController(controller: any, methodName: string, routePath: string, httpMethod: string) {
-  try {
-    // 获取方法的Swagger元数据
-    const metadata: any = {
-      operationId: `${methodName}`,
-      tags: [],
-      summary: '',
-      description: '',
-      parameters: [],
-      requestBody: null,
-      responses: {},
-    };
-
-    // 获取类级别的标签
-    if (controller.constructor.$_SwaggerTags) {
-      metadata.tags = controller.constructor.$_SwaggerTags;
-    }
-
-    // 获取方法级别的元数据
-    if (controller.$_SwaggerMethods && controller.$_SwaggerMethods.has(methodName)) {
-      const methodMeta = controller.$_SwaggerMethods.get(methodName);
-      metadata.summary = methodMeta.summary || methodName;
-      metadata.description = methodMeta.description || '';
-      metadata.operationId = methodMeta.operationId || methodName;
-      if (methodMeta.tags && methodMeta.tags.length > 0) {
-        metadata.tags = methodMeta.tags;
-      }
-    }
-
-    // 获取参数信息
-    if (controller.$_SwaggerParams && controller.$_SwaggerParams.has(methodName)) {
-      const params = controller.$_SwaggerParams.get(methodName);
-      metadata.parameters = params.map((param: any) => ({
-        name: param.name,
-        in: param.in,
-        description: param.description,
-        required: param.required || false,
-        schema: param.schema || { type: 'string' },
-        example: param.example,
-      }));
-    }
-
-    // 获取请求体信息
-    if (controller.$_SwaggerBodies && controller.$_SwaggerBodies.has(methodName)) {
-      const body = controller.$_SwaggerBodies.get(methodName);
-      metadata.requestBody = {
-        description: body.description || '',
-        required: body.required || false,
-        content: {
-          'application/json': {
-            schema: body.schema,
-            examples: body.examples,
-          },
-        },
-      };
-    }
-
-    // 获取响应信息
-    if (controller.$_SwaggerResponses && controller.$_SwaggerResponses.has(methodName)) {
-      const responses = controller.$_SwaggerResponses.get(methodName);
-      responses.forEach((response: any) => {
-        metadata.responses[response.status] = {
-          description: response.description,
-          content: response.schema ? {
-            'application/json': {
-              schema: response.schema,
-              examples: response.examples,
-            },
-          } : undefined,
-        };
-      });
-    } else {
-      // 默认成功响应
-      metadata.responses['200'] = {
-        description: '成功响应',
-        content: {
-          'application/json': {
-            schema: {
-              type: 'object',
-              properties: {
-                code: { type: 'number' },
-                data: { type: 'object' },
-                message: { type: 'string' },
-              },
-            },
-          },
-        },
-      };
-    }
-
-    return metadata;
-  } catch (error) {
-      logger.error('提取Swagger信息失败:', error as Error);
-      return null;
-  }
-}
-
-/**
- * 根据路径参数生成Swagger路径定义
- */
-export function generateSwaggerPath(path: string, httpMethod: string, swaggerData: any): string {
-  // 将路径参数转换为Swagger格式
-  let swaggerPath = path;
-  const params = swaggerData?.parameters || [];
-  
-  params.forEach((param: any) => {
-    if (param.in === 'path') {
-      swaggerPath = swaggerPath.replace(`/${param.name}`, `/{${param.name}}`);
-    }
-  });
-
-  return swaggerPath;
-}
-

package/template/src/framework/utils/testDb.ts

@@ -1,19 +0,0 @@
-import { DataSource } from "typeorm"
-import "reflect-metadata"
-
-export const createTestDataSource = async (entities: any[]) => {
-  return new DataSource({
-    type: "sqlite",
-    database: ":memory:",
-    dropSchema: true,
-    synchronize: true,
-    logging: false,
-    entities: entities
-  }).initialize()
-}
-
-export const closeTestDataSource = async (dataSource: DataSource) => {
-  if (dataSource.isInitialized) {
-    await dataSource.destroy()
-  }
-}

package/template/src/framework/utils/token.ts

@@ -1,23 +0,0 @@
-import { Context } from "koa";
-
-export function getTokenFromHeader(ctx: Context): string | null {
-    // 1. 从Authorization头获取token
-    const authHeader = ctx.headers.authorization || ctx.headers.Authorization;
-    if (!authHeader) {
-        return null;
-    }
-
-    // 2. 检查Bearer token格式
-    if (typeof authHeader === 'string') {
-        const parts = authHeader.split(' ');
-        if (parts.length === 2 && parts[0] === 'Bearer') {
-            return parts[1];
-        }
-    }
-
-    return null;
-}
-
-export function setTokenToHeader(ctx: Context, token: string): void {
-    ctx.set('Authorization', `Bearer ${token}`);
-}

package/template/src/framework/utils/transform.ts

@@ -1,17 +0,0 @@
-/**
- * 转为数字类型
- * @param val
- * @returns 
- */
-export function ToNumber(val: any) {
-    return Number(val);
-}
-
-/**
- * 去除多余的空格
- * @param val 
- * @returns 
- */
-export function Trim(val: string) {
-    return String(val).trim();
-}

package/template/src/libs/aokEmailSender.ts

@@ -1,42 +0,0 @@
-
-type EmailParams = {
-    to: string;
-    templateId: string;
-    templateData?: Record<string, string>;
-};
-
-export class AokEmailSender{
-    private apiKey: string;
-    private apiUrl: string;
-
-    constructor(apiKey: string, apiUrl = 'https://www.aoksend.com/index/api/send_email') {
-        this.apiKey = apiKey;
-        this.apiUrl = apiUrl;
-    }
-
-    async sendEmail(params: EmailParams): Promise<any> {
-        try {
-            const formData = new URLSearchParams();
-            formData.append('app_key', this.apiKey);
-            formData.append('to', params.to);
-            formData.append('template_id', params.templateId || '');
-            formData.append('data', JSON.stringify(params.templateData || {}));
-
-            const response = await fetch(this.apiUrl, {
-                method: 'POST',
-                headers: {
-                    'Content-Type': 'application/x-www-form-urlencoded'
-                },
-                body: formData.toString()
-            });
-``
-            if (!response.ok) {
-                const errorData = await response.json();
-                throw new Error(errorData.message || 'Failed to send email');
-            }
-            return await response.json();
-        } catch (error) {
-            throw new Error(error instanceof Error ? error.message : 'Failed to send email');
-        }
-    }
-}