create-dp-koa 1.0.0

package/template/src/framework/decorator/controller.ts

@@ -0,0 +1,311 @@
+
+export function Post(url?: string): MethodDecorator {
+    return (target: any,
+        methodName: any,
+        propertyDescriptor: PropertyDescriptor) => {
+        if (!target.$_PostMethods) {
+            target.$_PostMethods = new Set();
+        }
+        target.$_PostMethods.add({
+            methodName,
+            url: url ?? methodName
+        })
+    }
+}
+
+export function Get(url?: string): MethodDecorator {
+    return (target: any,
+        methodName: any,
+        propertyDescriptor: PropertyDescriptor) => {
+        if (!target.$_GetMethods) {
+            target.$_GetMethods = new Set();
+        }
+        target.$_GetMethods.add({
+            methodName,
+            url: url ?? methodName
+        })
+    }
+}
+
+export function Put(url?: string): MethodDecorator {
+    return (target: any,
+        methodName: any,
+        propertyDescriptor: PropertyDescriptor) => {
+        if (!target.$_PutMethods) {
+            target.$_PutMethods = new Set();
+        }
+        target.$_PutMethods.add({
+            methodName,
+            url: url ?? methodName
+        })
+    }
+}
+
+export function Del(url?: string): MethodDecorator {
+    return (target: any,
+        methodName: any,
+        propertyDescriptor: PropertyDescriptor) => {
+        if (!target.$_DelMethods) {
+            target.$_DelMethods = new Set();
+        }
+        target.$_DelMethods.add({
+            methodName,
+            url: url ?? methodName
+        })
+    }
+}
+
+export function All(url?: string): MethodDecorator {
+    return (target: any,
+        methodName: any,
+        propertyDescriptor: PropertyDescriptor) => {
+        if (!target.$_AllMethods) {
+            target.$_AllMethods = new Set();
+        }
+        target.$_AllMethods.add({
+            methodName,
+            url: url ?? methodName
+        })
+    }
+}
+
+export function ResponseCode(code = 200): MethodDecorator {
+    return (target: any,
+        methodName: any,
+        propertyDescriptor: PropertyDescriptor) => {
+        if (!target.$_ResponseCode) {
+            target.$_ResponseCode = new Map<string, number>();
+        }
+        target.$_ResponseCode.set(methodName, code);
+    }
+}
+
+export function ResponseHeader(type: string, value: any): MethodDecorator {
+    return (target: any,
+        methodName: any,
+        propertyDescriptor: PropertyDescriptor) => {
+        if (!target.$_ResponseHeader) {
+            target.$_ResponseHeader = new Map<string, Map<string, any>>();
+        }
+        let headerMap = target.$_ResponseHeader.get(methodName);
+        if (!headerMap) {
+            headerMap = new Map<string, any>()
+        }
+        headerMap.set(type, value)
+        target.$_ResponseHeader.set(methodName, headerMap);
+    }
+}
+
+/**
+ * 
+ * @param clas 
+ * @param objectKey 验证的数据对象所处的key 
+ * @returns 
+ */
+export function ResponseValidator(clas: any, objectKey: string = ""): MethodDecorator {
+    return (target: any,
+        methodName: any,
+        propertyDescriptor: PropertyDescriptor) => {
+        if (!target.$_ResponseValidator) {
+            target.$_ResponseValidator = new Map<string, any>();
+        }
+        target.$_ResponseValidator.set(methodName, {
+            clas,
+            objectKey
+        });
+    }
+}
+
+
+/**
+ * 
+ * @param fn 只有这里的函数有返回数据才会进入校验环节
+ * @returns 
+ */
+export function ResponseValidateIf(clas: any, fn: (data: any) => any,): MethodDecorator {
+    return (target: any,
+        methodName: any,
+        propertyDescriptor: PropertyDescriptor) => {
+        if (!target.$_ResponseValidateIf) {
+            target.$_ResponseValidateIf = new Map<string, any>();
+        }
+        target.$_ResponseValidateIf.set(methodName, {
+            clas,
+            fn,
+        });
+    }
+}
+
+/**
+ * 控制器的缓存
+ * @param cacheyFn 
+ * @param options 
+ * @returns 
+ */
+export function ControllerCache(cacheyFn: (...params: any[]) => any, options: {
+    ttl: number | { max: number, min: number },
+    enable?: boolean, // true 表示立即启用，默认是true
+} = { ttl: 20, enable: true }): MethodDecorator {
+    return (target: any,
+        methodName: any,
+        propertyDescriptor: PropertyDescriptor) => {
+        if (!target.$_ControllerCache) {
+            target.$_ControllerCache = new Map<string, any>();
+        }
+        target.$_ControllerCache.set(methodName, {
+            cacheyFn,
+            options,
+        });
+    }
+
+}
+
+
+export enum IParamTypeEnum {
+    Body = "Body",
+    Query = "Query",
+    Params = "Params",
+    Headers = "Headers",
+    State = "State",
+}
+
+/**
+ * body 参数注解
+ * @param validate 
+ * @returns 
+ */
+export function Body(validate?: any) {
+
+    return (target: any, methodName: string, index: number) => {
+
+        if (!target.$_MethdosParamInfo) {
+            target.$_MethdosParamInfo = new Map<string, { type: IParamTypeEnum, validate: any }[]>();
+        }
+        let paramsInfo = target.$_MethdosParamInfo.get(methodName);
+        paramsInfo = paramsInfo ?? [];
+        paramsInfo[index] = {
+            type: IParamTypeEnum.Body,
+            validate,
+        }
+        target.$_MethdosParamInfo.set(methodName, paramsInfo);
+
+    }
+
+}
+
+/**
+ * query 参数
+ * @param validate 
+ * @returns 
+ */
+export function Query(validate?: any) {
+
+    return (target: any, methodName: string, index: number) => {
+
+        if (!target.$_MethdosParamInfo) {
+            target.$_MethdosParamInfo = new Map<string, { type: IParamTypeEnum, validate: any }[]>();
+            // console.log("query MethodsParamInfo set ",index)
+        }
+        let paramsInfo = target.$_MethdosParamInfo.get(methodName);
+        paramsInfo = paramsInfo ?? [];
+        paramsInfo[index] = {
+            type: IParamTypeEnum.Query,
+            validate,
+        }
+        target.$_MethdosParamInfo.set(methodName, paramsInfo)
+    }
+
+}
+
+/**
+ * @param validate 
+ * @returns 
+ */
+export function Params(validate?: any) {
+
+    return (target: any, methodName: string, index: number) => {
+
+        if (!target.$_MethdosParamInfo) {
+            target.$_MethdosParamInfo = new Map<string, { type: IParamTypeEnum, validate: any }[]>();
+            // console.log("Params MethodsParamInfo set ",index)
+        }
+        let paramsInfo = target.$_MethdosParamInfo.get(methodName);
+        paramsInfo = paramsInfo ?? [];
+        paramsInfo[index] = {
+            type: IParamTypeEnum.Params,
+            validate,
+        }
+        target.$_MethdosParamInfo.set(methodName, paramsInfo)
+    }
+
+}
+
+/**
+ * @param validate 
+ * @returns 
+ */
+export function Headers(validate?: any) {
+
+    return (target: any, methodName: string, index: number) => {
+
+        if (!target.$_MethdosParamInfo) {
+            target.$_MethdosParamInfo = new Map<string, { type: IParamTypeEnum, validate: any }[]>();
+            // console.log("Params MethodsParamInfo set ",index)
+        }
+        let paramsInfo = target.$_MethdosParamInfo.get(methodName);
+        paramsInfo = paramsInfo ?? [];
+        paramsInfo[index] = {
+            type: IParamTypeEnum.Headers,
+            validate,
+        }
+        target.$_MethdosParamInfo.set(methodName, paramsInfo)
+    }
+
+}
+
+/**
+ * 读取ctx.state上的用户信息
+ * @param validate 
+ * @returns 
+ */
+export function State(validate?: any) {
+
+    return (target: any, methodName: string, index: number) => {
+
+        if (!target.$_MethdosParamInfo) {
+            target.$_MethdosParamInfo = new Map<string, { type: IParamTypeEnum, validate: any }[]>();
+            // console.log("Params MethodsParamInfo set ",index)
+        }
+        let paramsInfo = target.$_MethdosParamInfo.get(methodName);
+        paramsInfo = paramsInfo ?? [];
+        paramsInfo[index] = {
+            type: IParamTypeEnum.State,
+            validate,
+        }
+        target.$_MethdosParamInfo.set(methodName, paramsInfo)
+    }
+
+}
+
+
+
+
+/**
+ * 此注解实现 class-validator的 数据预处理，可以直接传一个自定义的处理函数即可
+ * @param func
+ */
+export function Transform(func: (data: any) => any) {
+    return (target: any, propertyKey: string) => {
+
+        if (!target.$_Transform) {
+            target.$_Transform = new Map();
+        }
+        target.$_Transform.set(propertyKey, func);
+        // Object.defineProperty(target, propertyKey, {
+        //     get: () => target[propertyKey],
+        //     set: (newValue) => {
+        //         target[propertyKey] = newValue;
+        //     },
+        // });
+    }
+}

package/template/src/framework/decorator/processor/AnnotationDecorators.ts

@@ -0,0 +1,100 @@
+/**
+ * 注解数据存储接口
+ */
+export interface AnnotationData {
+    processorName: string;
+    data: any;
+}
+
+/**
+ * 注解注册器
+ * 用于注册注解数据到控制器
+ */
+export class AnnotationRegistry {
+    /**
+     * 注册注解数据
+     */
+    static register(
+        target: any,
+        methodName: string,
+        processorName: string,
+        data: any
+    ): void {
+        if (!target.$_Annotations) {
+            target.$_Annotations = new Map<string, Map<string, any>>();
+        }
+
+        if (!target.$_Annotations.has(methodName)) {
+            target.$_Annotations.set(methodName, new Map<string, any>());
+        }
+
+        target.$_Annotations.get(methodName).set(processorName, data);
+    }
+
+    /**
+     * 获取注解数据
+     */
+    static get(
+        target: any,
+        methodName: string,
+        processorName: string
+    ): any {
+        if (!target.$_Annotations) {
+            return null;
+        }
+
+        const methodAnnotations = target.$_Annotations.get(methodName);
+        if (!methodAnnotations) {
+            return null;
+        }
+
+        const result = methodAnnotations.get(processorName);
+        return result;
+    }
+
+    /**
+     * 获取方法的所有注解
+     */
+    static getAll(target: any, methodName: string): Map<string, any> {
+        if (!target.$_Annotations) {
+            return new Map();
+        }
+
+        return target.$_Annotations.get(methodName) || new Map();
+    }
+}
+
+/**
+ * 通用注解装饰器工厂
+ */
+export function createAnnotationDecorator(processorName: string) {
+    return function(data?: any) {
+        return function(target: any, methodName: string, descriptor: PropertyDescriptor) {
+            AnnotationRegistry.register(target, methodName, processorName, data);
+            return descriptor;
+        };
+    };
+}
+
+/**
+ * 参数注解装饰器工厂
+ */
+export function createParameterDecorator(processorName: string) {
+    return function(data?: any) {
+        return function(target: any, methodName: string, index: number) {
+            AnnotationRegistry.register(target, methodName, processorName, {
+                ...data,
+                parameterIndex: index
+            });
+        };
+    };
+}
+
+// 导出一些常用的注解装饰器
+export const Logging = createAnnotationDecorator('Logging');
+export const Permission = createAnnotationDecorator('Permission');
+export const RateLimit = createAnnotationDecorator('RateLimit');
+
+// 参数注解装饰器
+export const LoggedParam = createParameterDecorator('Logging');
+export const ValidatedParam = createParameterDecorator('ParameterValidation');

package/template/src/framework/decorator/processor/AnnotationProcessor.ts

@@ -0,0 +1,156 @@
+import { Context } from 'koa';
+import { annotationRegistry } from '@src/framework/decorator/processor/AnnotationRegistry';
+
+/**
+ * 注解处理器接口
+ * 所有注解处理器都需要实现这个接口
+ */
+export interface AnnotationProcessor {
+    /**
+     * 处理器名称
+     */
+    readonly name: string;
+
+    /**
+     * 处理器优先级，数字越小优先级越高
+     */
+    readonly priority: number;
+
+    /**
+     * 处理注解逻辑（前置处理）
+     * @param ctx Koa上下文
+     * @param controller 控制器实例
+     * @param methodName 方法名
+     * @param annotationData 注解数据
+     * @param callParams 当前调用参数
+     * @returns 处理结果，如果返回false则中断后续处理
+     */
+    process(
+        ctx: Context,
+        controller: any,
+        methodName: string,
+        annotationData: any,
+        callParams: any[]
+    ): Promise<boolean | any>;
+
+    /**
+     * 后置处理方法（可选）
+     * 在控制器方法执行完成后调用
+     * @param ctx Koa上下文
+     * @param controller 控制器实例
+     * @param methodName 方法名
+     * @param response 控制器方法返回的响应
+     */
+    postProcess?(
+        ctx: Context,
+        controller: any,
+        methodName: string,
+        response: any
+    ): Promise<void>;
+
+    /**
+     * 响应验证方法（可选）
+     * 验证控制器方法返回的响应数据
+     * @param controller 控制器实例
+     * @param methodName 方法名
+     * @param response 控制器方法返回的响应
+     * @returns 验证错误数组，空数组表示验证通过
+     */
+    validateResponse?(
+        controller: any,
+        methodName: string,
+        response: any
+    ): Promise<string[]>;
+
+    /**
+     * 日志记录方法（可选）
+     * 记录控制器方法的执行日志
+     * @param ctx Koa上下文
+     * @param controller 控制器实例
+     * @param methodName 方法名
+     * @param response 控制器方法返回的响应
+     */
+    logResponse?(
+        ctx: Context,
+        controller: any,
+        methodName: string,
+        response: any
+    ): Promise<void>;
+}
+
+/**
+ * 注解处理器执行器
+ */
+export class AnnotationExecutor {
+    /**
+     * 执行所有相关的注解处理器
+     */
+    static async execute(
+        ctx: Context,
+        controller: any,
+        methodName: string,
+        callParams: any[]
+    ): Promise<boolean> {
+        const processors = annotationRegistry.getAllProcessors();
+        
+        for (const processor of processors) {
+            // 检查控制器是否有该注解的数据
+            const annotationData = this.getAnnotationData(controller, methodName, processor.name);
+            if (annotationData !== null) {
+                try {
+                    const result = await processor.process(
+                        ctx,
+                        controller,
+                        methodName,
+                        annotationData,
+                        callParams
+                    );
+                    
+                    // 如果处理器返回false，中断后续处理
+                    if (result === false) {
+                        return false;
+                    }
+                } catch (error) {
+                    console.error(`注解处理器 ${processor.name} 执行失败:`, error);
+                    // 可以选择是否继续执行其他处理器
+                    // 这里选择继续执行
+                }
+            }
+        }
+        
+        return true;
+    }
+
+    /**
+     * 获取注解数据
+     * 支持新的注解系统和旧的注解系统
+     */
+    private static getAnnotationData(controller: any, methodName: string, processorName: string): any {
+        // 首先检查新的注解系统
+        if (controller.$_Annotations) {
+            const methodAnnotations = controller.$_Annotations.get(methodName);
+            if (methodAnnotations) {
+                const annotationData = methodAnnotations.get(processorName);
+                if (methodAnnotations.has(processorName)) {
+                    return annotationData;
+                }
+            }
+        }
+
+        // 兼容旧的注解系统
+        const legacyMappings: { [key: string]: string } = {
+            'ParameterValidation': '$_MethdosParamInfo',
+            'ResponseValidation': '$_ResponseValidator',
+            'Cache': '$_ControllerCache',
+            'ResponseCode': '$_ResponseCode',
+            'ResponseHeader': '$_ResponseHeader'
+        };
+
+        const legacyMapName = legacyMappings[processorName];
+        if (legacyMapName && controller[legacyMapName]) {
+            return controller[legacyMapName].get(methodName);
+        }
+
+        return null;
+    }
+}

package/template/src/framework/decorator/processor/AnnotationProcessorConfig.ts

@@ -0,0 +1,45 @@
+/**
+ * 注解处理器注册配置
+ * 用于在应用启动时注册所有注解处理器
+ * 这种方式对 webpack 打包友好
+ */
+
+// 框架层注解处理器
+import { 
+    LoggingProcessor,
+    PermissionProcessor,
+    RateLimitProcessor
+} from './processors/CustomProcessors';
+
+// 业务层注解处理器
+import { PerformanceMonitorProcessor } from '@src/annotations/processors/PerformanceMonitorProcessor';
+
+/**
+ * 获取所有框架层注解处理器
+ */
+export function getFrameworkAnnotationProcessors() {
+    return [
+        new LoggingProcessor(),
+        new PermissionProcessor(),
+        new RateLimitProcessor()
+    ];
+}
+
+/**
+ * 获取所有业务层注解处理器
+ */
+export function getBusinessAnnotationProcessors() {
+    return [
+        new PerformanceMonitorProcessor()
+    ];
+}
+
+/**
+ * 获取所有注解处理器（框架层 + 业务层）
+ */
+export function getAllAnnotationProcessors() {
+    return [
+        ...getFrameworkAnnotationProcessors(),
+        ...getBusinessAnnotationProcessors()
+    ];
+}