create-dp-koa 1.0.1 → 1.1.0

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

@@ -1,410 +0,0 @@
-import { Provider } from "dp-ioc2";
-import { SwaggerExampleController } from "@src/controllers/example/SwaggerExampleController";
-import { logger } from "@src/framework/utils/logger";
-import { swaggerProcessor } from "@src/annotations/processors/SwaggerProcessor";
-import * as fs from 'fs';
-import * as path from 'path';
-
-/**
- * 动态检测 bindRouter 路径前缀
- * 通过分析路由注册信息来确定实际的前缀路径
- */
-function getBindRouterPrefix(): string {
-    // 方法1: 从环境变量读取（推荐用于生产环境）
-    if (process.env.SWAGGER_ROUTE_PREFIX) {
-        const prefix = process.env.SWAGGER_ROUTE_PREFIX;
-        logger.info(`使用环境变量中的 Swagger 路径前缀: ${prefix}`);
-        return prefix.startsWith('/') ? prefix : `/${prefix}`;
-    }
-    
-    // 方法2: 从路由文件中动态检测（开发环境和调试模式）
-    try {
-        const detectedPrefix = detectPrefixFromRouterFile();
-        if (detectedPrefix) {
-            logger.info(`从路由文件检测到 Swagger 路径前缀: ${detectedPrefix}`);
-            return detectedPrefix;
-        }
-        
-        // 方法3: 使用默认值
-        const defaultPrefix = '/swagger/b';
-        logger.info(`使用默认 Swagger 路径前缀: ${defaultPrefix}`);
-        return defaultPrefix;
-    } catch (error) {
-        logger.warn('无法动态检测路由前缀，使用默认值');
-        return '/swagger/b';
-    }
-}
-
-/**
- * 从路由文件中检测 SwaggerExampleController 的路径前缀
- */
-function detectPrefixFromRouterFile(): string | null {
-    try {
-        // 获取路由文件路径
-        const routerFilePath = path.join(process.cwd(), 'src/routers/index.ts');
-        
-        if (!fs.existsSync(routerFilePath)) {
-            logger.warn('路由文件不存在');
-            return null;
-        }
-        
-        // 读取路由文件内容
-        const content = fs.readFileSync(routerFilePath, 'utf8');
-        
-        // 查找 SwaggerExampleController 的 bindRouter 调用
-        const regex = /bindRouter\s*\(\s*["']([^"']+)["']\s*,\s*SwaggerExampleController\s*\)/;
-        const match = content.match(regex);
-        
-        if (match && match[1]) {
-            const detectedPrefix = match[1];
-            logger.info(`从路由文件检测到前缀: ${detectedPrefix}`);
-            return detectedPrefix;
-        } else {
-            logger.warn('未找到 SwaggerExampleController 的 bindRouter 调用');
-            return null;
-        }
-    } catch (error) {
-        logger.error('检测路由文件失败:', error as Error);
-        return null;
-    }
-}
-
-/**
- * 动态生成 Swagger 规范
- * 使用新的Swagger处理器来生成更完整的API文档
- */
-export function generateDynamicSwaggerSpec() {
-    try {
-        logger.info('开始使用Swagger处理器生成API规范...');
-        
-        // 获取 SwaggerExampleController 实例
-        const controller = Provider<any>(SwaggerExampleController);
-        
-        // 使用Swagger处理器生成OpenAPI规范
-        const openAPISpec = swaggerProcessor.generateOpenAPISpec([controller]);
-        
-        // 动态检测 bindRouter 路径前缀
-        const bindRouterPrefix = getBindRouterPrefix();
-        
-        // 更新服务器URL
-        openAPISpec.servers = [
-            {
-                url: 'http://localhost:3000',
-                description: '开发环境',
-            },
-        ];
-        
-        // 收集所有路由信息并更新路径
-        const routes: Array<{method: string, path: string, methodName: string}> = [];
-        
-        // 收集 GET 方法
-        if (controller.$_GetMethods) {
-            const getMethods = Array.from(controller.$_GetMethods) as Array<{methodName: string, url: string}>;
-            getMethods.forEach(({ methodName, url }) => {
-                routes.push({ method: 'get', path: `${bindRouterPrefix}${url}`, methodName });
-            });
-        }
-        
-        // 收集 POST 方法
-        if (controller.$_PostMethods) {
-            const postMethods = Array.from(controller.$_PostMethods) as Array<{methodName: string, url: string}>;
-            postMethods.forEach(({ methodName, url }) => {
-                routes.push({ method: 'post', path: `${bindRouterPrefix}${url}`, methodName });
-            });
-        }
-        
-        // 收集 PUT 方法
-        if (controller.$_PutMethods) {
-            const putMethods = Array.from(controller.$_PutMethods) as Array<{methodName: string, url: string}>;
-            putMethods.forEach(({ methodName, url }) => {
-                routes.push({ method: 'put', path: `${bindRouterPrefix}${url}`, methodName });
-            });
-        }
-        
-        // 收集 DELETE 方法
-        if (controller.$_DelMethods) {
-            const delMethods = Array.from(controller.$_DelMethods) as Array<{methodName: string, url: string}>;
-            delMethods.forEach(({ methodName, url }) => {
-                routes.push({ method: 'delete', path: `${bindRouterPrefix}${url}`, methodName });
-            });
-        }
-
-        // 更新OpenAPI规范中的路径
-        routes.forEach(({ method, path, methodName }) => {
-            const swaggerPath = path.replace(/:(\w+)/g, '{$1}');
-            
-            if (!openAPISpec.paths[swaggerPath]) {
-                openAPISpec.paths[swaggerPath] = {};
-            }
-            
-            // 获取方法的Swagger元数据
-            const methodMetadata = swaggerProcessor.processMethod(controller, methodName);
-            
-            openAPISpec.paths[swaggerPath][method] = {
-                operationId: methodMetadata.operationId,
-                summary: methodMetadata.summary,
-                description: methodMetadata.description,
-                tags: methodMetadata.tags,
-                parameters: methodMetadata.parameters,
-                responses: methodMetadata.responses.reduce((acc, response) => {
-                    acc[response.status.toString()] = {
-                        description: response.description,
-                        content: response.content
-                    };
-                    return acc;
-                }, {} as Record<string, any>)
-            };
-            
-            // 添加请求体
-            if (methodMetadata.requestBody) {
-                openAPISpec.paths[swaggerPath][method].requestBody = methodMetadata.requestBody;
-            }
-        });
-
-        logger.info(`使用Swagger处理器生成API规范成功，包含 ${routes.length} 个路由`);
-        return openAPISpec;
-        
-    } catch (error) {
-        logger.error('使用Swagger处理器生成API规范失败:', error as Error);
-        return getFallbackSwaggerSpec();
-    }
-}
-
-/**
- * 获取方法的 Swagger 元数据
- */
-function getMethodSwaggerMetadata(controller: any, methodName: string) {
-    try {
-        // 尝试从控制器的元数据中获取 Swagger 注解信息
-        const metadata = Reflect.getMetadata('swagger:metadata', controller, methodName);
-        
-        if (metadata) {
-            logger.info(`找到方法 ${methodName} 的 Swagger 元数据`);
-            return metadata;
-        }
-        
-        // 如果没有找到元数据，返回默认值
-        return getDefaultMethodMetadata(methodName);
-    } catch (error) {
-        logger.warn(`获取方法 ${methodName} 的 Swagger 元数据失败:`, error as Error);
-        return getDefaultMethodMetadata(methodName);
-    }
-}
-
-/**
- * 获取默认的方法元数据
- */
-function getDefaultMethodMetadata(methodName: string) {
-    const baseMetadata = {
-        responses: {
-            '200': {
-                description: '成功',
-                content: {
-                    'application/json': {
-                        schema: {
-                            type: 'object',
-                            properties: {
-                                code: { type: 'number', example: 0 },
-                                data: { type: 'object' },
-                                message: { type: 'string', example: '操作成功' }
-                            }
-                        }
-                    }
-                }
-            }
-        }
-    };
-
-    // 根据方法名添加特定的参数
-    if (methodName.includes('List') || methodName.includes('list')) {
-        return {
-            ...baseMetadata,
-            parameters: [
-                {
-                    name: 'page',
-                    in: 'query',
-                    schema: { type: 'number', default: 1 },
-                    description: '页码'
-                },
-                {
-                    name: 'pageSize',
-                    in: 'query',
-                    schema: { type: 'number', default: 10 },
-                    description: '每页数量'
-                },
-                {
-                    name: 'keyword',
-                    in: 'query',
-                    schema: { type: 'string' },
-                    description: '搜索关键词'
-                }
-            ]
-        };
-    }
-
-    if (methodName.includes('ById') || methodName.includes('ById')) {
-        return {
-            ...baseMetadata,
-            parameters: [
-                {
-                    name: 'id',
-                    in: 'path',
-                    required: true,
-                    schema: { type: 'number' },
-                    description: 'ID'
-                }
-            ]
-        };
-    }
-
-    // DELETE 方法添加路径参数
-    if (methodName.includes('delete') || methodName.includes('Delete')) {
-        return {
-            ...baseMetadata,
-            parameters: [
-                {
-                    name: 'id',
-                    in: 'path',
-                    required: true,
-                    schema: { type: 'number' },
-                    description: 'ID'
-                }
-            ]
-        };
-    }
-
-    // POST 方法添加请求体
-    if (methodName.includes('create') || methodName.includes('Create')) {
-        return {
-            ...baseMetadata,
-            requestBody: {
-                required: true,
-                content: {
-                    'application/json': {
-                        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
-                                }
-                            }
-                        }
-                    }
-                }
-            }
-        };
-    }
-
-    // PUT 方法添加路径参数和请求体
-    if (methodName.includes('update') || methodName.includes('Update')) {
-        return {
-            ...baseMetadata,
-            parameters: [
-                {
-                    name: 'id',
-                    in: 'path',
-                    required: true,
-                    schema: { type: 'number' },
-                    description: 'ID'
-                }
-            ],
-            requestBody: {
-                required: true,
-                content: {
-                    'application/json': {
-                        schema: {
-                            type: 'object',
-                            properties: {
-                                name: { type: 'string', description: '用户名' },
-                                email: { type: 'string', format: 'email', description: '邮箱' },
-                                age: { type: 'number', description: '年龄' }
-                            }
-                        }
-                    }
-                }
-            }
-        };
-    }
-
-    return baseMetadata;
-}
-
-/**
- * 获取默认摘要
- */
-function getDefaultSummary(method: string, path: string) {
-    const methodMap: {[key: string]: string} = {
-        'get': '获取',
-        'post': '创建',
-        'put': '更新',
-        'delete': '删除'
-    };
-    
-    const action = methodMap[method] || '操作';
-    const resource = path.includes('list') ? '列表' : 
-                    path.includes('{id}') ? '详情' : '资源';
-    
-    return `${action}${resource}`;
-}
-
-/**
- * 获取默认描述
- */
-function getDefaultDescription(method: string, path: string) {
-    const descriptions: {[key: string]: string} = {
-        'get': path.includes('list') ? '获取列表数据' : '获取详细信息',
-        'post': '创建新资源',
-        'put': '更新资源信息',
-        'delete': '删除资源'
-    };
-    
-    return descriptions[method] || 'API 操作';
-}
-
-/**
- * 备用 Swagger 规范
- */
-function getFallbackSwaggerSpec() {
-    return {
-        openapi: '3.0.0',
-        info: {
-            title: 'DP Koa Framework API',
-            version: '1.0.0',
-            description: '基于Koa的企业级框架API文档',
-        },
-        servers: [
-            {
-                url: 'http://localhost:3000',
-                description: '开发环境',
-            },
-        ],
-        paths: {
-            '/swagger/user/list': {
-                get: {
-                    tags: ['用户管理'],
-                    summary: '获取用户列表',
-                    description: '获取用户列表数据',
-                    responses: {
-                        '200': {
-                            description: '成功返回用户列表',
-                        },
-                    },
-                },
-            },
-        },
-    };
-}

package/template/src/repository/UserRepository.ts

@@ -1,122 +0,0 @@
-import { Repository } from 'typeorm';
-import { YtUserEntity } from '@src/entity/ytUser.entity';
-import { BaseRepository } from '@src/repository/base/BaseRepository';
-import { IBaseRepository } from '@src/repository/interfaces/IBaseRepository';
-
-/**
- * 用户Repository接口
- * 定义用户相关的数据访问操作
- */
-export interface IUserRepository extends IBaseRepository<YtUserEntity> {
-    findByEmail(email: string): Promise<YtUserEntity | null>;
-    findByTelNumber(telNumber: string): Promise<YtUserEntity | null>;
-    findByUserType(userType: string): Promise<YtUserEntity[]>;
-    findByStatus(status: string): Promise<YtUserEntity[]>;
-    findActiveUsers(): Promise<YtUserEntity[]>;
-    updateLastLoginTime(id: number): Promise<void>;
-    updatePassword(id: number, hashedPassword: string): Promise<void>;
-    deactivateUser(id: number): Promise<void>;
-    activateUser(id: number): Promise<void>;
-}
-
-/**
- * 用户Repository实现
- */
-export class UserRepository extends BaseRepository<YtUserEntity> implements IUserRepository {
-    constructor(repository: Repository<YtUserEntity>) {
-        super(YtUserEntity, repository);
-    }
-
-    async findByEmail(email: string): Promise<YtUserEntity | null> {
-        try {
-            return await this.repository.findOne({
-                where: { email }
-            });
-        } catch (error) {
-            throw error;
-        }
-    }
-
-    async findByTelNumber(telNumber: string): Promise<YtUserEntity | null> {
-        try {
-            return await this.repository.findOne({
-                where: { telnumber: telNumber }
-            });
-        } catch (error) {
-            throw error;
-        }
-    }
-
-    async findByUserType(userType: string): Promise<YtUserEntity[]> {
-        try {
-            return await this.repository.find({
-                where: { userType: userType as any }
-            });
-        } catch (error) {
-            throw error;
-        }
-    }
-
-    async findByStatus(status: string): Promise<YtUserEntity[]> {
-        try {
-            return await this.repository.find({
-                where: { status: status as any }
-            });
-        } catch (error) {
-            throw error;
-        }
-    }
-
-    async findActiveUsers(): Promise<YtUserEntity[]> {
-        try {
-            return await this.repository.find({
-                where: { status: 'normal' as any }
-            });
-        } catch (error) {
-            throw error;
-        }
-    }
-
-    async updateLastLoginTime(id: number): Promise<void> {
-        try {
-            await this.repository.update(id, {
-                updateDate: new Date()
-            } as any);
-        } catch (error) {
-            throw error;
-        }
-    }
-
-    async updatePassword(id: number, hashedPassword: string): Promise<void> {
-        try {
-            await this.repository.update(id, {
-                password: hashedPassword,
-                updateDate: new Date()
-            } as any);
-        } catch (error) {
-            throw error;
-        }
-    }
-
-    async deactivateUser(id: number): Promise<void> {
-        try {
-            await this.repository.update(id, {
-                status: 'forbidden' as any,
-                updateDate: new Date()
-            } as any);
-        } catch (error) {
-            throw error;
-        }
-    }
-
-    async activateUser(id: number): Promise<void> {
-        try {
-            await this.repository.update(id, {
-                status: 'normal' as any,
-                updateDate: new Date()
-            } as any);
-        } catch (error) {
-            throw error;
-        }
-    }
-}

package/template/src/service/paramValidateTest.service.ts

@@ -1,139 +0,0 @@
-/**
- * 参数校验测试 Service
- * 用于测试 dp-ioc2 的 @ParamValidate 装饰器功能
- */
-
-import { Injectable, ParamValidate, IOCValidationError } from "dp-ioc2";
-import { IsString, IsEmail, MinLength, IsNumber, Min, Max } from "class-validator";
-import { BaseService } from "@src/service/base.service";
-import { CommonServiceResult } from "@src/framework/types/ServiceResult";
-import { logger } from "@src/framework/utils/logger";
-import Joi from "joi";
-
-/**
- * 测试 DTO - 创建用户
- */
-export class CreateTestUserDto {
-    @IsString({ message: '用户名必须是字符串' })
-    @MinLength(3, { message: '用户名长度不能少于3个字符' })
-    name!: string;
-
-    @IsEmail({}, { message: '邮箱格式不正确' })
-    email!: string;
-
-    @IsNumber({}, { message: '年龄必须是数字' })
-    @Min(18, { message: '年龄不能小于18岁' })
-    @Max(100, { message: '年龄不能大于100岁' })
-    age!: number;
-}
-
-/**
- * 测试 DTO - 更新用户
- */
-export class UpdateTestUserDto {
-    @IsString({ message: '用户名必须是字符串' })
-    @MinLength(3, { message: '用户名长度不能少于3个字符' })
-    name?: string;
-
-    @IsEmail({}, { message: '邮箱格式不正确' })
-    email?: string;
-}
-
-/**
- * 参数校验测试 Service
- */
-@Injectable()
-export class ParamValidateTestService extends BaseService {
-    
-    /**
-     * 测试1：对象参数校验（使用 class-validator）
-     */
-    async createUser(@ParamValidate(CreateTestUserDto) dto: CreateTestUserDto): Promise<CommonServiceResult<{ id: number; name: string; email: string; age: number }>> {
-        try {
-            // 业务逻辑（校验已在方法调用前自动完成）
-            const user = {
-                id: Math.floor(Math.random() * 1000),
-                name: dto.name,
-                email: dto.email,
-                age: dto.age
-            };
-            
-            logger.info(`创建用户成功: ${user.name}`);
-            return CommonServiceResult.success(user, "用户创建成功");
-        } catch (error) {
-            if (error instanceof IOCValidationError) {
-                return CommonServiceResult.validationError<{ id: number; name: string; email: string; age: number }>(
-                    error.message || "参数校验失败",
-                    null
-                );
-            }
-            logger.error("创建用户失败:", error as Error);
-            return CommonServiceResult.error("创建用户失败");
-        }
-    }
-
-    /**
-     * 测试2：基本类型参数校验（使用 Joi）
-     */
-    async getUserById(@ParamValidate(undefined, Joi.number().integer().positive().required()) userId: number): Promise<CommonServiceResult<{ id: number; name: string }>> {
-        try {
-            // 业务逻辑
-            const user = {
-                id: userId,
-                name: `用户${userId}`
-            };
-            
-            return CommonServiceResult.success(user, "获取用户成功");
-        } catch (error) {
-            if (error instanceof IOCValidationError) {
-                return CommonServiceResult.validationError<{ id: number; name: string }>(
-                    error.message || "参数校验失败",
-                    null
-                );
-            }
-            logger.error("获取用户失败:", error as Error);
-            return CommonServiceResult.error("获取用户失败");
-        }
-    }
-
-    /**
-     * 测试3：混合参数校验（基本类型 + 对象）
-     */
-    async updateUser(
-        @ParamValidate(undefined, Joi.number().integer().positive().required()) userId: number,
-        @ParamValidate(UpdateTestUserDto) dto: UpdateTestUserDto
-    ): Promise<CommonServiceResult<{ id: number; name?: string; email?: string }>> {
-        try {
-            // 业务逻辑
-            const user = {
-                id: userId,
-                ...dto
-            };
-            
-            return CommonServiceResult.success(user, "更新用户成功");
-        } catch (error) {
-            if (error instanceof IOCValidationError) {
-                return CommonServiceResult.validationError<{ id: number; name?: string; email?: string }>(
-                    error.message || "参数校验失败",
-                    null
-                );
-            }
-            logger.error("更新用户失败:", error as Error);
-            return CommonServiceResult.error("更新用户失败");
-        }
-    }
-
-    /**
-     * 测试4：无校验参数（用于对比）
-     */
-    async getUserWithoutValidation(userId: number): Promise<CommonServiceResult<{ id: number; name: string }>> {
-        // 这个方法没有使用 @ParamValidate，用于对比测试
-        const user = {
-            id: userId,
-            name: `用户${userId}`
-        };
-        
-        return CommonServiceResult.success(user, "获取用户成功");
-    }
-}
-