create-dp-koa 1.0.0 → 1.0.2

package/template/src/controllers/cacheManagement.controller.ts

@@ -1,131 +0,0 @@
-import { Get, Post } from '@src/framework/decorator/controller';
-import { Body } from '@src/framework/decorator/controller';
-import { BaseController } from '@src/controllers/base.controller';
-import { getCache, deleteCache, getCacheStats, getCacheMemoryUsage, clearAllCaches } from '@src/framework/utils/cache';
-import { logger } from '@src/framework/utils/logger';
-
-export class CacheManagementController extends BaseController {
-
-    /**
-     * 获取所有缓存统计信息
-     */
-    @Get('/cache/stats')
-    async getCacheStats() {
-        const stats = getCacheStats();
-        const memory = getCacheMemoryUsage();
-        
-        return this.success({
-            stats,
-            memory,
-            timestamp: new Date().toISOString()
-        });
-    }
-
-    /**
-     * 清理指定缓存
-     */
-    @Post('/cache/clear')
-    async clearCache(@Body() body: { cacheName: string }) {
-        const { cacheName } = body;
-        
-        if (!cacheName) {
-            return this.fail(400, '缓存名称不能为空');
-        }
-
-        try {
-            const cache = getCache(cacheName);
-            if (!cache) {
-                return this.fail(404, `缓存 ${cacheName} 不存在`);
-            }
-
-            // 清空缓存内容
-            cache.flushAll();
-            logger.info(`手动清理缓存: ${cacheName}`);
-            
-            return this.success({
-                message: `缓存 ${cacheName} 已清理`,
-                cacheName,
-                timestamp: new Date().toISOString()
-            });
-        } catch (error) {
-            logger.error(`清理缓存 ${cacheName} 失败:`, error as Error);
-            return this.fail(500, `清理缓存失败: ${error instanceof Error ? error.message : '未知错误'}`);
-        }
-    }
-
-    /**
-     * 删除指定缓存实例
-     */
-    @Post('/cache/delete')
-    async deleteCache(@Body() body: { cacheName: string }) {
-        const { cacheName } = body;
-        
-        if (!cacheName) {
-            return this.fail(400, '缓存名称不能为空');
-        }
-
-        try {
-            deleteCache(cacheName);
-            logger.info(`删除缓存实例: ${cacheName}`);
-            
-            return this.success({
-                message: `缓存实例 ${cacheName} 已删除`,
-                cacheName,
-                timestamp: new Date().toISOString()
-            });
-        } catch (error) {
-            logger.error(`删除缓存实例 ${cacheName} 失败:`, error as Error);
-            return this.fail(500, `删除缓存实例失败: ${error instanceof Error ? error.message : '未知错误'}`);
-        }
-    }
-
-    /**
-     * 清理所有缓存
-     */
-    @Post('/cache/clear-all')
-    async clearAllCache() {
-        try {
-            clearAllCaches();
-            logger.info('手动清理所有缓存');
-            
-            return this.success({
-                message: '所有缓存已清理',
-                timestamp: new Date().toISOString()
-            });
-        } catch (error) {
-            logger.error('清理所有缓存失败:', error as Error);
-            return this.fail(500, `清理所有缓存失败: ${error instanceof Error ? error.message : '未知错误'}`);
-        }
-    }
-
-    /**
-     * 获取特定缓存的详细信息
-     */
-    @Get('/cache/info')
-    async getCacheInfo(@Body() body: { cacheName: string }) {
-        const { cacheName } = body;
-        
-        if (!cacheName) {
-            return this.fail(400, '缓存名称不能为空');
-        }
-
-        const cache = getCache(cacheName);
-        if (!cache) {
-            return this.fail(404, `缓存 ${cacheName} 不存在`);
-        }
-
-        const keys = cache.keys();
-        const stats = getCacheStats();
-        const memory = getCacheMemoryUsage();
-
-        return this.success({
-            cacheName,
-            keys: keys.slice(0, 10), // 只显示前10个键
-            totalKeys: keys.length,
-            stats: stats[cacheName] || null,
-            memory: memory[cacheName] || null,
-            config: cache.options,
-            timestamp: new Date().toISOString()
-        });
-    }
-}

package/template/src/controllers/captcha.controller.ts

@@ -1,57 +0,0 @@
-
-import { Get, Post } from '@src/framework/decorator/controller';
-import { Body } from '@src/framework/decorator/controller';
-import { CaptchaGenerator } from '@src/libs/captcha';
-import { Inject } from 'dp-ioc2';
-import { createCache, CacheType } from '@src/framework/utils/cache';
-
-// 创建验证码缓存实例
-const captchaCache = createCache('captcha-controller', CacheType.CAPTCHA, {
-    stdTTL: 300, // 5分钟过期
-    maxKeys: 100 // 最多100个验证码
-});
-
-export class CaptchaController {
-
-  // @Inject(CaptchaGenerator)
-  // captchaGenerator: CaptchaGenerator;
-
-  @Get('/captcha')
-  async getCaptcha() {
-    const { image, token } = CaptchaGenerator.generate();
-    return {
-      image,
-      token,
-      contentType: 'image/svg+xml'
-    };
-  }
-  
-  @Post('/captcha/verify')
-  async verifyCaptcha(
-    @Body() body: { captcha: string, token: string }
-  ) {
-    const { captcha, token } = body;
-    if (!token) {
-      return {
-        status: 400,
-        body: { success: false, message: 'Missing captcha token' }
-      };
-    }
-
-    // 检查是否已经验证过（防止重复验证）
-    const verifyKey = `verify_${token}`;
-    if (captchaCache.get(verifyKey)) {
-      return { success: false, message: '验证码已使用' };
-    }
-
-    const isValid = CaptchaGenerator.verify(token, captcha);
-    
-    if (isValid) {
-      // 验证成功后标记为已使用，防止重复验证
-      captchaCache.set(verifyKey, true, 300); // 5分钟内不能重复验证
-    }
-    
-    return { success: isValid };
-  }
-
-}

package/template/src/controllers/example/NewAnnotationExampleController.ts

@@ -1,159 +0,0 @@
-import { Get, Post, Query, Body, State, ResponseCode, ResponseHeader } from '@src/framework/decorator/controller';
-import { BaseController, ControllerResponse } from '@src/controllers/base.controller';
-import { Inject } from 'dp-ioc2';
-import { YtUserService } from '@src/service/ytUser.service';
-import { Logging, Permission, RateLimit } from '@src/framework/decorator/processor/AnnotationDecorators';
-import { ExampleBodyDto, ExampleQueryDto } from '@src/dto/controller/example/NewAnnotationExampleController.dto';
-
-/**
- * 新注解系统使用示例控制器
- * 展示如何在实际项目中使用新的注解处理器系统
- */
-export class NewAnnotationExampleController extends BaseController {
-    @Inject(YtUserService)
-    private ytUserService: YtUserService;
-
-    /**
-     * 示例1：基础的新注解使用
-     * 使用 Logging 注解记录请求日志
-     */
-    @Get('/basic-example')
-    @Logging()
-    @ResponseCode(200)
-    async basicExample(@Query() query: ExampleQueryDto): Promise<ControllerResponse<string>> {
-        console.log('执行基础示例方法');
-        return this.success('基础示例执行成功');
-    }
-
-    /**
-     * 示例2：权限控制
-     * 使用 Permission 注解进行权限检查
-     */
-    @Get('/protected-data')
-    @Logging()
-    @Permission({ requiredPermission: 'read:sensitive-data' })
-    @ResponseCode(200)
-    async getProtectedData(@State('user') user: any): Promise<ControllerResponse<any>> {
-        console.log('获取受保护的数据');
-        return this.success({
-            message: '这是受保护的数据',
-            user: user,
-            timestamp: new Date().toISOString()
-        });
-    }
-
-    /**
-     * 示例3：请求限流
-     * 使用 RateLimit 注解限制请求频率
-     */
-    @Post('/rate-limited-endpoint')
-    @Logging()
-    @RateLimit({ maxRequests: 5, windowMs: 60000 }) // 每分钟最多5次请求
-    @ResponseCode(201)
-    async rateLimitedEndpoint(@Body() body: ExampleBodyDto): Promise<ControllerResponse<any>> {
-        console.log('处理限流端点请求');
-        return this.success({
-            message: '请求处理成功',
-            data: body,
-            timestamp: new Date().toISOString()
-        });
-    }
-
-    /**
-     * 示例4：复合注解使用
-     * 同时使用多个新注解
-     */
-    @Get('/complex-example')
-    @Logging()
-    @Permission({ requiredPermission: 'read:complex-data' })
-    @RateLimit({ maxRequests: 10, windowMs: 300000 }) // 5分钟内最多10次请求
-    @ResponseCode(200)
-    @ResponseHeader('X-Custom-Header', 'ComplexExample')
-    async complexExample(
-        @Query() query: ExampleQueryDto,
-        @State('user') user: any
-    ): Promise<ControllerResponse<any>> {
-        console.log('执行复杂示例方法');
-        
-        // 模拟业务逻辑
-        const usersResult = await this.ytUserService.getUsers({ page: 1, pageSize: 10 });
-        
-        return this.success({
-            message: '复杂示例执行成功',
-            query: query,
-            user: user,
-            usersCount: usersResult.data ? usersResult.data[1] : 0,
-            timestamp: new Date().toISOString()
-        });
-    }
-
-    /**
-     * 示例5：新旧注解混合使用
-     * 展示新旧注解系统的兼容性
-     */
-    @Post('/mixed-annotations')
-    @Logging() // 新注解
-    @ResponseCode(201) // 旧注解
-    @ResponseHeader('X-Mixed-Example', 'true') // 旧注解
-    async mixedAnnotations(@Body() body: ExampleBodyDto): Promise<ControllerResponse<any>> {
-        console.log('执行混合注解示例');
-        return this.success({
-            message: '混合注解示例执行成功',
-            data: body,
-            note: '这个端点同时使用了新旧注解系统'
-        });
-    }
-
-    /**
-     * 示例6：错误处理
-     * 展示注解处理器如何处理错误情况
-     */
-    @Get('/error-example')
-    @Logging()
-    @Permission({ requiredPermission: 'admin:access' })
-    async errorExample(): Promise<ControllerResponse<any>> {
-        console.log('执行错误示例');
-        
-        // 模拟权限不足的情况
-        throw new Error('模拟权限不足错误');
-    }
-
-    /**
-     * 示例7：异步处理
-     * 展示注解处理器如何处理异步方法
-     */
-    @Get('/async-example')
-    @Logging()
-    @RateLimit({ maxRequests: 3, windowMs: 60000 })
-    async asyncExample(): Promise<ControllerResponse<any>> {
-        console.log('开始异步处理');
-        
-        // 模拟异步操作
-        await new Promise(resolve => setTimeout(resolve, 1000));
-        
-        console.log('异步处理完成');
-        return this.success({
-            message: '异步处理完成',
-            timestamp: new Date().toISOString()
-        });
-    }
-
-    /**
-     * 示例8：数据验证
-     * 展示参数验证和响应验证
-     */
-    @Post('/validation-example')
-    @Logging()
-    async validationExample(@Body() body: ExampleBodyDto): Promise<ControllerResponse<any>> {
-        console.log('执行验证示例');
-        
-        // 这里会进行参数验证（通过 @Body 注解）
-        // 响应也会进行验证（通过 ControllerResponse 类型）
-        
-        return this.success({
-            message: '验证通过',
-            receivedData: body,
-            validationTimestamp: new Date().toISOString()
-        });
-    }
-}

package/template/src/controllers/example/SwaggerExampleController.ts

@@ -1,205 +0,0 @@
-import { Get, Post, Put, Del, Body, Query, Params } from '@src/framework/decorator/controller';
-import { BaseController } from '@src/controllers/base.controller';
-import { Api, ApiTags, ApiResponse, ApiBody, ApiParam } from '@src/framework/decorator/swagger';
-import { logger } from '@src/framework/utils/logger';
-
-/**
- * Swagger示例控制器 - 展示完整的Swagger注解用法
- */
-@ApiTags('Swagger示例', 'API文档完整示例')
-export class SwaggerExampleController extends BaseController {
-    
-    /**
-     * GET请求 - 带查询参数
-     */
-    @Get('/user/list')
-    @Api({
-        tags: ['用户管理'],
-        summary: '获取用户列表',
-        description: '根据查询参数获取用户列表',
-        operationId: 'getUserList',
-    })
-    @ApiResponse({
-        status: 200,
-        description: '成功返回用户列表',
-        schema: {
-            type: 'object',
-            properties: {
-                code: { type: 'number', example: 0 },
-                data: {
-                    type: 'array',
-                    items: {
-                        type: 'object',
-                        properties: {
-                            id: { type: 'number' },
-                            name: { type: 'string' },
-                            email: { type: 'string' },
-                        },
-                    },
-                },
-                message: { type: 'string' },
-            },
-        },
-    })
-    async getUserList(@Query() query: { page: number; pageSize: number; keyword?: string }) {
-        return this.success({
-            users: [
-                { id: 1, name: '张三', email: 'zhang@example.com' },
-                { id: 2, name: '李四', email: 'li@example.com' },
-            ],
-            total: 2,
-            page: query.page || 1,
-            pageSize: query.pageSize || 10,
-        }, '获取用户列表成功');
-    }
-    
-    /**
-     * GET请求 - 带路径参数
-     */
-    @Get('/user/:id')
-    @Api({
-        tags: ['用户管理'],
-        summary: '获取用户详情',
-        description: '根据用户ID获取用户详细信息',
-    })
-    @ApiResponse({
-        status: 200,
-        description: '成功返回用户详情',
-    })
-    @ApiResponse({
-        status: 404,
-        description: '用户不存在',
-    })
-    async getUserById(@Params() params: { id: number }) {
-        return this.success({
-            id: params.id,
-            name: '张三',
-            email: 'zhang@example.com',
-            avatar: 'https://example.com/avatar.jpg',
-        }, '获取用户详情成功');
-    }
-    
-    /**
-     * POST请求 - 带请求体
-     */
-    @Post('/user')
-    @Api({
-        tags: ['用户管理'],
-        summary: '创建新用户',
-        description: '创建新用户并返回用户信息',
-    })
-    @ApiBody({
-        description: '用户信息',
-        required: true,
-        schema: {
-            type: 'object',
-            required: ['name', 'email'],
-            properties: {
-                name: { type: 'string', description: '用户名', example: '张三' },
-                email: { type: 'string', format: 'email', description: '邮箱', example: 'zhang@example.com' },
-                age: { type: 'number', description: '年龄', example: 25 },
-            },
-        },
-        examples: {
-            example1: {
-                summary: '示例数据1',
-                value: {
-                    name: '张三',
-                    email: 'zhang@example.com',
-                    age: 25,
-                },
-            },
-        },
-    })
-    @ApiResponse({
-        status: 200,
-        description: '成功创建用户',
-        schema: {
-            type: 'object',
-            properties: {
-                code: { type: 'number' },
-                data: {
-                    type: 'object',
-                    properties: {
-                        id: { type: 'number' },
-                        name: { type: 'string' },
-                        email: { type: 'string' },
-                    },
-                },
-                message: { type: 'string' },
-            },
-        },
-    })
-    @ApiResponse({
-        status: 400,
-        description: '参数验证失败',
-    })
-    async createUser(@Body() body: { name: string; email: string; age?: number }) {
-        return this.success({
-            id: Math.floor(Math.random() * 1000),
-            name: body.name,
-            email: body.email,
-            age: body.age,
-        }, '创建用户成功');
-    }
-    
-    /**
-     * PUT请求 - 更新资源
-     */
-    @Put('/user/:id')
-    @Api({
-        tags: ['用户管理'],
-        summary: '更新用户信息',
-        description: '根据用户ID更新用户信息',
-    })
-    @ApiBody({
-        description: '更新的用户信息',
-        required: true,
-        schema: {
-            type: 'object',
-            properties: {
-                name: { type: 'string', description: '用户名' },
-                email: { type: 'string', format: 'email', description: '邮箱' },
-                age: { type: 'number', description: '年龄' },
-            },
-        },
-    })
-    @ApiResponse({
-        status: 200,
-        description: '成功更新用户信息',
-    })
-    @ApiResponse({
-        status: 404,
-        description: '用户不存在',
-    })
-    async updateUser(@Params() params: { id: number }, @Body() body: { name?: string; email?: string; age?: number }) {
-        return this.success({
-            id: params.id,
-            ...body,
-        }, '更新用户成功');
-    }
-    
-    /**
-     * DELETE请求 - 删除资源
-     */
-    @Del('/user/:id')
-    @Api({
-        tags: ['用户管理'],
-        summary: '删除用户',
-        description: '根据用户ID删除用户',
-    })
-    @ApiResponse({
-        status: 200,
-        description: '成功删除用户',
-    })
-    @ApiResponse({
-        status: 404,
-        description: '用户不存在',
-    })
-    async deleteUser(@Params() params: { id: number }) {
-        logger.debug('🔍 deleteUser 方法被调用');
-        logger.debug('📋 参数:', params);
-        return this.success(null, '删除用户成功');
-    }
-}
-