forked from datawhale/whale-town-end
feat: 重构业务模块架构
- 新增auth模块处理认证逻辑 - 新增security模块处理安全相关功能 - 新增user-mgmt模块管理用户相关操作 - 新增shared模块存放共享组件 - 重构admin模块,添加DTO和Guards - 为admin模块添加测试文件结构
This commit is contained in:
89
src/business/security/decorators/throttle.decorator.ts
Normal file
89
src/business/security/decorators/throttle.decorator.ts
Normal file
@@ -0,0 +1,89 @@
|
||||
/**
|
||||
* 频率限制装饰器
|
||||
*
|
||||
* 功能描述:
|
||||
* - 提供API接口的频率限制功能
|
||||
* - 防止恶意请求和系统滥用
|
||||
* - 支持基于IP和用户的限制策略
|
||||
*
|
||||
* 使用场景:
|
||||
* - 登录接口防暴力破解
|
||||
* - 注册接口防批量注册
|
||||
* - 验证码接口防频繁发送
|
||||
* - 敏感操作接口保护
|
||||
*
|
||||
* @author kiro-ai
|
||||
* @version 1.0.0
|
||||
* @since 2025-12-24
|
||||
*/
|
||||
|
||||
import { SetMetadata, applyDecorators, UseGuards } from '@nestjs/common';
|
||||
import { ThrottleGuard } from '../guards/throttle.guard';
|
||||
|
||||
/**
|
||||
* 频率限制元数据键
|
||||
*/
|
||||
export const THROTTLE_KEY = 'throttle';
|
||||
|
||||
/**
|
||||
* 频率限制配置接口
|
||||
*/
|
||||
export interface ThrottleConfig {
|
||||
/** 时间窗口内允许的最大请求次数 */
|
||||
limit: number;
|
||||
/** 时间窗口长度(秒) */
|
||||
ttl: number;
|
||||
/** 限制类型:ip(基于IP)或 user(基于用户) */
|
||||
type?: 'ip' | 'user';
|
||||
/** 自定义错误消息 */
|
||||
message?: string;
|
||||
}
|
||||
|
||||
/**
|
||||
* 频率限制装饰器
|
||||
*
|
||||
* @param config 频率限制配置
|
||||
* @returns 装饰器函数
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* // 每分钟最多5次登录尝试
|
||||
* @Throttle({ limit: 5, ttl: 60, message: '登录尝试过于频繁,请稍后再试' })
|
||||
* @Post('login')
|
||||
* async login() { ... }
|
||||
*
|
||||
* // 每5分钟最多3次注册
|
||||
* @Throttle({ limit: 3, ttl: 300, type: 'ip' })
|
||||
* @Post('register')
|
||||
* async register() { ... }
|
||||
* ```
|
||||
*/
|
||||
export function Throttle(config: ThrottleConfig) {
|
||||
return applyDecorators(
|
||||
SetMetadata(THROTTLE_KEY, config),
|
||||
UseGuards(ThrottleGuard)
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* 预定义的频率限制配置
|
||||
*/
|
||||
export const ThrottlePresets = {
|
||||
/** 登录接口:每分钟5次 */
|
||||
LOGIN: { limit: 5, ttl: 60, message: '登录尝试过于频繁,请1分钟后再试' },
|
||||
|
||||
/** 注册接口:每5分钟3次 */
|
||||
REGISTER: { limit: 3, ttl: 300, message: '注册请求过于频繁,请5分钟后再试' },
|
||||
|
||||
/** 发送验证码:每分钟1次 */
|
||||
SEND_CODE: { limit: 1, ttl: 60, message: '验证码发送过于频繁,请1分钟后再试' },
|
||||
|
||||
/** 密码重置:每小时3次 */
|
||||
RESET_PASSWORD: { limit: 3, ttl: 3600, message: '密码重置请求过于频繁,请1小时后再试' },
|
||||
|
||||
/** 管理员操作:每分钟10次 */
|
||||
ADMIN_OPERATION: { limit: 10, ttl: 60, message: '管理员操作过于频繁,请稍后再试' },
|
||||
|
||||
/** 一般API:每分钟30次 */
|
||||
GENERAL_API: { limit: 30, ttl: 60, message: 'API调用过于频繁,请稍后再试' }
|
||||
} as const;
|
||||
119
src/business/security/decorators/timeout.decorator.ts
Normal file
119
src/business/security/decorators/timeout.decorator.ts
Normal file
@@ -0,0 +1,119 @@
|
||||
/**
|
||||
* 超时处理装饰器
|
||||
*
|
||||
* 功能描述:
|
||||
* - 为API接口添加超时控制
|
||||
* - 防止长时间运行的请求阻塞系统
|
||||
* - 提供友好的超时错误提示
|
||||
*
|
||||
* 使用场景:
|
||||
* - 数据库查询超时控制
|
||||
* - 外部API调用超时
|
||||
* - 文件上传下载超时
|
||||
* - 复杂计算任务超时
|
||||
*
|
||||
* @author kiro-ai
|
||||
* @version 1.0.0
|
||||
* @since 2025-12-24
|
||||
*/
|
||||
|
||||
import { SetMetadata, applyDecorators } from '@nestjs/common';
|
||||
import { ApiResponse } from '@nestjs/swagger';
|
||||
|
||||
/**
|
||||
* 超时配置元数据键
|
||||
*/
|
||||
export const TIMEOUT_KEY = 'timeout';
|
||||
|
||||
/**
|
||||
* 超时配置接口
|
||||
*/
|
||||
export interface TimeoutConfig {
|
||||
/** 超时时间(毫秒) */
|
||||
timeout: number;
|
||||
/** 自定义超时错误消息 */
|
||||
message?: string;
|
||||
/** 是否记录超时日志 */
|
||||
logTimeout?: boolean;
|
||||
}
|
||||
|
||||
/**
|
||||
* 超时装饰器
|
||||
*
|
||||
* @param config 超时配置或超时时间(毫秒)
|
||||
* @returns 装饰器函数
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* // 设置30秒超时
|
||||
* @Timeout(30000)
|
||||
* @Get('slow-operation')
|
||||
* async slowOperation() { ... }
|
||||
*
|
||||
* // 自定义超时配置
|
||||
* @Timeout({
|
||||
* timeout: 60000,
|
||||
* message: '数据查询超时,请稍后重试',
|
||||
* logTimeout: true
|
||||
* })
|
||||
* @Post('complex-query')
|
||||
* async complexQuery() { ... }
|
||||
* ```
|
||||
*/
|
||||
export function Timeout(config: number | TimeoutConfig) {
|
||||
const timeoutConfig: TimeoutConfig = typeof config === 'number'
|
||||
? { timeout: config }
|
||||
: config;
|
||||
|
||||
return applyDecorators(
|
||||
SetMetadata(TIMEOUT_KEY, timeoutConfig),
|
||||
ApiResponse({
|
||||
status: 408,
|
||||
description: timeoutConfig.message || '请求超时',
|
||||
schema: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
success: { type: 'boolean', example: false },
|
||||
message: { type: 'string', example: timeoutConfig.message || '请求超时,请稍后重试' },
|
||||
error_code: { type: 'string', example: 'REQUEST_TIMEOUT' },
|
||||
timeout_info: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
timeout_ms: { type: 'number', example: timeoutConfig.timeout },
|
||||
timestamp: { type: 'string', example: '2025-12-24T10:00:00.000Z' }
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
})
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* 预定义的超时配置
|
||||
*/
|
||||
export const TimeoutPresets = {
|
||||
/** 快速操作:5秒 */
|
||||
FAST: { timeout: 5000, message: '操作超时,请检查网络连接' },
|
||||
|
||||
/** 一般操作:30秒 */
|
||||
NORMAL: { timeout: 30000, message: '请求超时,请稍后重试' },
|
||||
|
||||
/** 慢操作:60秒 */
|
||||
SLOW: { timeout: 60000, message: '操作超时,请稍后重试' },
|
||||
|
||||
/** 文件操作:2分钟 */
|
||||
FILE_OPERATION: { timeout: 120000, message: '文件操作超时,请检查文件大小和网络状况' },
|
||||
|
||||
/** 数据库查询:45秒 */
|
||||
DATABASE_QUERY: { timeout: 45000, message: '数据查询超时,请简化查询条件或稍后重试' },
|
||||
|
||||
/** 外部API调用:15秒 */
|
||||
EXTERNAL_API: { timeout: 15000, message: '外部服务调用超时,请稍后重试' },
|
||||
|
||||
/** 邮件发送:30秒 */
|
||||
EMAIL_SEND: { timeout: 30000, message: '邮件发送超时,请检查邮件服务配置' },
|
||||
|
||||
/** 长时间任务:5分钟 */
|
||||
LONG_TASK: { timeout: 300000, message: '任务执行超时,请稍后重试' }
|
||||
} as const;
|
||||
Reference in New Issue
Block a user