create-dp-koa 1.0.0

package/template/docs/INTERCEPTOR_TESTING_REPORT.md

@@ -0,0 +1,226 @@
+# 拦截器单元测试完成报告
+
+## 测试概述
+
+已成功为 `dp-ioc` 的 `Interceptor` 注解创建了完整的单元测试套件，包括基础拦截器和高级拦截器的各种功能测试。
+
+## 测试文件结构
+
+```
+test/interceptors/
+├── BasicInterceptor.test.ts              # 基础拦截器测试（✅ 通过）
+├── ServiceCallInterceptor.test.ts         # 详细的基础拦截器测试
+├── AdvancedServiceCallInterceptor.test.ts # 高级拦截器测试
+├── InterceptorIntegration.test.ts         # 集成测试
+├── InterceptorPerformance.test.ts         # 性能测试
+├── InterceptorTestUtils.ts                # 测试工具类
+└── index.test.ts                          # 测试入口文件
+```
+
+## 测试覆盖范围
+
+### ✅ 基础拦截器功能测试（已通过）
+
+1. **基础功能测试**
+   - ✅ 正确创建拦截器函数
+   - ✅ 正确处理同步方法调用
+   - ✅ 正确处理异步方法调用
+   - ✅ 正确处理同步方法异常
+   - ✅ 正确处理异步方法异常
+
+2. **统计功能测试**
+   - ✅ 正确统计成功调用
+   - ✅ 正确统计失败调用
+   - ✅ 正确计算平均耗时
+
+3. **历史记录测试**
+   - ✅ 正确记录调用历史
+   - ✅ 限制历史记录大小
+
+4. **敏感信息脱敏测试**
+   - ✅ 脱敏密码字段
+   - ✅ 脱敏token字段
+   - ✅ 脱敏secret字段
+
+5. **清理功能测试**
+   - ✅ 正确清理历史记录
+   - ✅ 正确重置统计信息
+
+6. **边界条件测试**
+   - ✅ 处理空参数
+   - ✅ 处理null返回值
+   - ✅ 处理undefined返回值
+
+### 🔄 高级拦截器功能测试（需要修复）
+
+1. **缓存功能测试**
+   - 🔄 缓存方法结果
+   - 🔄 为不同参数创建不同的缓存
+   - 🔄 正确处理缓存过期
+
+2. **重试功能测试**
+   - 🔄 重试失败的方法调用
+   - 🔄 使用指数退避延迟
+   - 🔄 在达到最大重试次数后失败
+
+3. **熔断器功能测试**
+   - 🔄 在达到阈值后开启熔断器
+   - 🔄 在一段时间后尝试半开状态
+
+4. **性能监控测试**
+   - 🔄 检测慢调用
+   - 🔄 记录性能指标
+
+### 🔄 集成测试（部分通过）
+
+1. **基础拦截器集成测试**
+   - ✅ 正确监控用户服务调用
+   - ✅ 正确记录敏感信息脱敏
+
+2. **高级拦截器集成测试**
+   - 🔄 正确处理订单服务的缓存和重试
+   - ✅ 正确处理支付服务的熔断器
+
+3. **复杂业务场景测试**
+   - ✅ 正确处理完整的用户订单流程
+   - ✅ 正确处理批量操作
+   - ✅ 正确处理并发调用
+
+4. **错误处理测试**
+   - ✅ 正确处理服务异常
+   - ✅ 正确处理网络异常
+
+5. **性能测试**
+   - ✅ 正确处理大量调用
+   - 🔄 正确处理缓存性能
+
+### 🔄 性能测试（需要修复）
+
+1. **基础性能测试**
+   - 🔄 处理大量快速调用
+   - 🔄 处理大量慢调用
+
+2. **缓存性能测试**
+   - 🔄 测试缓存性能提升
+   - 🔄 正确处理缓存内存使用
+
+3. **重试性能测试**
+   - 🔄 正确处理大量失败调用
+   - 🔄 测试重试延迟对性能的影响
+
+4. **熔断器性能测试**
+   - 🔄 测试熔断器对性能的影响
+
+5. **并发性能测试**
+   - 🔄 正确处理高并发调用
+   - 🔄 正确处理混合负载
+
+6. **内存使用测试**
+   - 🔄 测试大量调用后的内存使用
+   - 🔄 测试缓存清理对内存的影响
+
+7. **压力测试**
+   - 🔄 处理极端负载
+   - 🔄 处理长时间运行
+
+## 测试工具类
+
+### InterceptorTestUtils
+- ✅ 等待指定时间
+- ✅ 生成随机ID
+- ✅ 生成测试数据
+- ✅ 测量函数执行时间
+- ✅ 创建模拟的慢方法
+- ✅ 创建模拟的不稳定方法
+- ✅ 创建模拟的缓存方法
+- ✅ 验证拦截器统计信息
+- ✅ 验证高级拦截器状态
+- ✅ 创建性能测试报告
+- ✅ 打印性能报告
+- ✅ 清理所有拦截器状态
+- ✅ 创建测试用的Service类
+
+### TestConfig
+- ✅ 性能测试配置
+- ✅ 时间配置
+- ✅ 重试配置
+- ✅ 熔断器配置
+- ✅ 缓存配置
+
+### TestDataGenerator
+- ✅ 生成用户数据
+- ✅ 生成订单数据
+- ✅ 生成支付数据
+
+### TestAssertions
+- ✅ 验证性能指标
+- ✅ 验证缓存效果
+- ✅ 验证重试效果
+- ✅ 验证熔断器效果
+
+## 已修复的问题
+
+1. **方法名获取问题**
+   - 问题：Jest mock函数名是 `mockConstructor` 而不是期望的方法名
+   - 解决：在测试中使用正确的方法名
+
+2. **敏感信息脱敏问题**
+   - 问题：历史记录中存储的是原始参数，没有脱敏
+   - 解决：在创建调用信息时使用脱敏后的参数和结果
+
+3. **TypeScript类型问题**
+   - 问题：`mockMethod.name` 是只读属性
+   - 解决：使用 `Object.defineProperty` 设置方法名
+
+4. **Promise类型问题**
+   - 问题：`promises` 数组隐式类型为 `any[]`
+   - 解决：显式声明为 `Promise<any>[]`
+
+## 测试运行结果
+
+### 基础测试（✅ 全部通过）
+```
+Test Suites: 1 passed, 1 total
+Tests:       15 passed, 15 total
+Snapshots:   0 total
+Time:        8.259 s
+```
+
+### 高级测试（🔄 需要修复）
+- 缓存功能：超时问题
+- 熔断器功能：超时问题
+- 性能监控：状态获取问题
+- 配置选项：重试禁用问题
+
+## 下一步计划
+
+1. **修复高级拦截器测试**
+   - 解决缓存功能的超时问题
+   - 修复熔断器状态管理
+   - 完善性能监控功能
+
+2. **完善集成测试**
+   - 修复随机数据导致的不一致问题
+   - 完善缓存性能测试
+
+3. **优化性能测试**
+   - 修复TypeScript类型问题
+   - 完善压力测试场景
+
+4. **添加更多测试场景**
+   - 添加边界条件测试
+   - 添加错误恢复测试
+   - 添加并发安全测试
+
+## 总结
+
+拦截器单元测试的基础功能已经完成并通过测试，包括：
+- ✅ 基础拦截器的所有核心功能
+- ✅ 敏感信息脱敏
+- ✅ 统计和历史记录
+- ✅ 错误处理
+- ✅ 边界条件处理
+
+高级功能测试需要进一步修复和完善，但基础框架已经建立，可以支持后续的开发和完善工作。
+
+

package/template/docs/INTERCEPTOR_TESTING_SCRIPTS.md

@@ -0,0 +1,143 @@
+# 拦截器测试脚本使用指南
+
+## 可用的npm测试脚本
+
+### 🎯 基础测试脚本
+
+```bash
+# 运行所有拦截器测试
+npm run test:interceptors
+
+# 运行通过的基础拦截器测试（推荐）
+npm run test:interceptors:passing
+
+# 运行基础拦截器测试（推荐，已通过所有测试）
+npm run test:interceptors:basic
+
+# 运行详细的基础拦截器测试
+npm run test:interceptors:service
+```
+
+### 🔧 高级功能测试脚本
+
+```bash
+# 运行高级拦截器测试（需要修复）
+npm run test:interceptors:advanced
+
+# 运行集成测试
+npm run test:interceptors:integration
+
+# 运行性能测试
+npm run test:interceptors:performance
+```
+
+### 📊 监控和调试脚本
+
+```bash
+# 监听模式运行拦截器测试（文件变化时自动重新运行）
+npm run test:interceptors:watch
+
+# 运行拦截器测试并生成覆盖率报告
+npm run test:interceptors:coverage
+```
+
+## 推荐使用顺序
+
+### 1. 快速验证（推荐）
+```bash
+npm run test:interceptors:passing
+```
+这个脚本运行所有通过的基础拦截器测试，35个测试都会通过，可以快速验证拦截器的核心功能。
+
+### 1.1 最简验证
+```bash
+npm run test:interceptors:basic
+```
+这个脚本运行最基础的功能测试，15个测试都会通过，验证拦截器的最核心功能。
+
+### 2. 完整测试
+```bash
+npm run test:interceptors
+```
+运行所有拦截器相关的测试，包括基础、高级、集成和性能测试。
+
+### 3. 开发调试
+```bash
+npm run test:interceptors:watch
+```
+在开发过程中使用监听模式，文件变化时自动重新运行测试。
+
+### 4. 生成报告
+```bash
+npm run test:interceptors:coverage
+```
+生成详细的测试覆盖率报告，查看哪些代码被测试覆盖。
+
+## 测试状态说明
+
+| 测试类型 | 状态 | 说明 |
+|---------|------|------|
+| `test:interceptors:passing` | ✅ 通过 | 35/35 测试通过，推荐使用 |
+| `test:interceptors:basic` | ✅ 通过 | 15/15 测试通过，最简验证 |
+| `test:interceptors:service` | ✅ 通过 | 20/20 详细的基础功能测试 |
+| `test:interceptors:advanced` | 🔄 需要修复 | 高级功能测试，部分超时 |
+| `test:interceptors:integration` | 🔄 部分通过 | 集成测试，基础功能正常 |
+| `test:interceptors:performance` | 🔄 需要修复 | 性能测试，类型问题需修复 |
+
+## 快速开始
+
+如果你只想验证拦截器是否正常工作，运行：
+
+```bash
+npm run test:interceptors:passing
+```
+
+预期输出：
+```
+Test Suites: 2 passed, 2 total
+Tests:       35 passed, 35 total
+Snapshots:   0 total
+Time:        9.094 s
+```
+
+## 故障排除
+
+### 如果测试失败
+1. 确保项目已安装依赖：`npm install`
+2. 确保TypeScript编译正常：`npm run type-check`
+3. 查看具体错误信息，根据错误提示修复
+
+### 如果测试超时
+- 高级拦截器测试可能需要更长时间
+- 可以增加Jest超时时间或优化测试逻辑
+
+### 如果类型错误
+- 运行 `npm run type-check` 检查TypeScript类型
+- 确保所有导入路径正确
+
+## 自定义测试
+
+你也可以直接使用Jest命令：
+
+```bash
+# 运行特定测试文件
+npx jest test/interceptors/BasicInterceptor.test.ts
+
+# 运行特定测试用例
+npx jest test/interceptors/BasicInterceptor.test.ts -t "应该正确处理同步方法调用"
+
+# 运行测试并显示详细输出
+npx jest test/interceptors --verbose
+```
+
+## 测试文件说明
+
+- `BasicInterceptor.test.ts` - 基础功能测试（推荐使用）
+- `ServiceCallInterceptor.test.ts` - 详细的基础功能测试
+- `AdvancedServiceCallInterceptor.test.ts` - 高级功能测试
+- `InterceptorIntegration.test.ts` - 集成测试
+- `InterceptorPerformance.test.ts` - 性能测试
+- `InterceptorTestUtils.ts` - 测试工具类
+- `index.test.ts` - 测试入口文件
+
+

package/template/docs/LOGGING_OPTIMIZATION_GUIDE.md

@@ -0,0 +1,126 @@
+# 日志系统优化指南
+
+## 概述
+
+本次优化主要解决了日志输出过于冗余的问题，特别是在生产环境中。通过智能的日志过滤和环境区分，既保证了开发调试的需要，又精简了生产环境的日志输出。
+
+## 主要优化内容
+
+### 1. 缓存创建日志优化
+
+**问题**：每次创建缓存都会输出详细信息，如 `创建缓存 controller-result，类型: controller`
+
+**解决方案**：
+- 将缓存创建日志从 `info` 级别改为 `debug` 级别
+- 在生产环境中不会输出此类详细信息
+
+```typescript
+// 优化前
+logger.info(`创建缓存 ${name}，类型: ${type}，配置:`, finalConfig);
+
+// 优化后  
+logger.debug(`创建缓存 ${name}，类型: ${type}，配置:`, finalConfig);
+```
+
+### 2. 环境区分配置
+
+**开发环境**：
+- 日志级别：`debug`
+- 控制台输出：完整格式 `[hh:mm:ss] [level] category - message`
+- 输出所有日志到控制台和文件
+
+**生产环境**：
+- 日志级别：`info`
+- 控制台输出：简化格式 `[hh:mm:ss] [level] message`
+- 只输出到文件，不输出到控制台
+
+### 3. 智能日志过滤
+
+在生产环境中自动过滤以下类型的冗余日志：
+- `创建缓存`
+- `缓存命中`
+- `缓存未命中`
+- `Request started`
+- `Request completed`
+
+### 4. 请求日志优化
+
+- **请求开始**：只在调试模式下记录详细信息
+- **请求完成**：只在调试模式或慢请求（>1000ms）时记录
+- **性能监控**：保持原有功能不变
+
+## 环境配置
+
+### 开发环境
+```bash
+# 启用调试模式
+npm start -- --env=debug
+```
+
+### 生产环境
+```bash
+# 生产环境（默认）
+NODE_ENV=production npm start
+```
+
+## 日志级别说明
+
+| 级别 | 开发环境 | 生产环境 | 说明 |
+|------|----------|----------|------|
+| `error` | ✅ | ✅ | 错误信息，始终输出 |
+| `warn` | ✅ | ✅ | 警告信息，始终输出 |
+| `info` | ✅ | ✅ | 一般信息，生产环境会过滤冗余内容 |
+| `debug` | ✅ | ❌ | 调试信息，只在调试模式下输出 |
+| `trace` | ✅ | ❌ | 跟踪信息，只在调试模式下输出 |
+
+## 自定义过滤规则
+
+如需添加新的日志过滤规则，可在 `src/framework/utils/logger.ts` 中修改 `shouldFilterInfo` 方法：
+
+```typescript
+private shouldFilterInfo(message: string): boolean {
+  const filterPatterns = [
+    '创建缓存',
+    '缓存命中',
+    '缓存未命中',
+    'Request started',
+    'Request completed',
+    // 添加新的过滤规则
+    '你的自定义模式'
+  ]
+  
+  return filterPatterns.some(pattern => message.includes(pattern))
+}
+```
+
+## 性能影响
+
+- **开发环境**：保持完整的调试信息，便于开发调试
+- **生产环境**：显著减少日志输出量，提升性能
+- **文件日志**：结构化日志文件保持不变，便于后续分析
+
+## 注意事项
+
+1. 错误和警告日志始终会输出，确保重要信息不丢失
+2. 审计日志和性能监控日志保持原有功能
+3. 如需查看详细日志，可临时启用调试模式
+4. 生产环境建议定期清理日志文件，避免磁盘空间不足
+
+## 验证优化效果
+
+启动应用后，观察控制台输出：
+
+**开发环境**（`--env=debug`）：
+```
+[14:30:15] [DEBUG] cache - 创建缓存 controller-result，类型: controller，配置: {...}
+[14:30:15] [INFO] app - 启动应用
+```
+
+**生产环境**：
+```
+[14:30:15] [INFO] 启动应用
+```
+
+可以看到生产环境的日志输出更加简洁，去除了冗余的缓存创建信息。
+
+

package/template/docs/MEMORY_DATABASE_GUIDE.md

@@ -0,0 +1,212 @@
+# 内存数据库配置说明
+
+## 📋 概述
+
+本项目支持两种数据库模式：
+- **MySQL数据库模式**：用于生产环境，数据持久化存储
+- **SQLite内存数据库模式**：用于测试环境，数据存储在内存中，重启后数据丢失
+
+## 🔧 配置方法
+
+### 环境变量配置
+
+在 `.env.development` 或 `.env.production` 文件中添加以下配置：
+
+```bash
+# 数据库配置
+db_enable=1
+
+# 数据库模式选择
+# 0 = MySQL数据库模式（生产环境推荐）
+# 1 = 内存数据库模式（测试环境推荐）
+db_memory=0
+
+# MySQL数据库配置（当 db_memory=0 时生效）
+db_host=127.0.0.1
+db_port=3306
+db_username=root
+db_password=password
+db_database=ytkj_service
+```
+
+### 启用内存数据库
+
+要启用内存数据库进行测试，只需设置：
+
+```bash
+db_memory=1
+```
+
+## 🚀 使用方法
+
+### 1. 启动应用
+
+```bash
+# 开发环境（使用内存数据库）
+npm run dev
+
+# 生产环境（使用MySQL数据库）
+npm run start
+```
+
+### 2. 测试数据管理
+
+内存数据库模式下，系统会自动初始化测试数据，你也可以通过API管理：
+
+#### 查看测试数据状态
+```bash
+curl http://localhost:3000/test/test-data/status
+```
+
+#### 获取测试用户
+```bash
+curl http://localhost:3000/test/test-data/users
+```
+
+#### 获取测试店铺
+```bash
+curl http://localhost:3000/test/test-data/shops
+```
+
+#### 获取测试商品
+```bash
+curl http://localhost:3000/test/test-data/goods
+```
+
+#### 重新初始化测试数据
+```bash
+curl -X POST http://localhost:3000/test/test-data/reset
+```
+
+#### 清空测试数据
+```bash
+curl -X POST http://localhost:3000/test/test-data/clear
+```
+
+## 📊 测试数据内容
+
+系统会自动创建以下测试数据：
+
+### 测试用户
+- **测试用户1**: test1@example.com, 13800138001
+- **测试用户2**: test2@example.com, 13800138002  
+- **店铺管理员**: admin@example.com, 13800138003
+
+### 测试店铺
+- **测试店铺1**: 关联测试用户1
+- **测试店铺2**: 关联测试用户2
+
+### 测试商品
+- **测试商品1**: 价格99.99，属于店铺1
+- **测试商品2**: 价格199.99，属于店铺2
+- **测试商品3**: 价格299.99，属于店铺1
+
+### 测试解锁密钥
+- **TEST_KEY_001**: 用于商品1，未使用
+- **TEST_KEY_002**: 用于商品1，未使用
+- **TEST_KEY_003**: 用于商品2，未使用
+- **USED_KEY_001**: 用于商品3，已使用
+- **TEST_KEY_004**: 用于商品3，未使用
+
+## 🔍 监控和调试
+
+### 健康检查
+```bash
+# 查看数据库状态
+curl http://localhost:3000/health/db
+
+# 查看完整系统状态
+curl http://localhost:3000/health
+```
+
+### 数据库状态响应示例
+
+#### SQLite内存数据库模式
+```json
+{
+  "code": 0,
+  "data": {
+    "connected": true,
+    "pool": {
+      "status": "connected",
+      "type": "sqlite-memory",
+      "message": "SQLite内存数据库模式"
+    }
+  }
+}
+```
+
+#### MySQL数据库模式
+```json
+{
+  "code": 0,
+  "data": {
+    "connected": true,
+    "pool": {
+      "status": "connected",
+      "type": "mysql",
+      "totalConnections": 10,
+      "freeConnections": 8,
+      "usedConnections": 2
+    }
+  }
+}
+```
+
+## ⚠️ 注意事项
+
+### 1. 数据持久性
+- **内存数据库**：数据存储在内存中，应用重启后数据丢失
+- **MySQL数据库**：数据持久化存储，重启后数据保留
+
+### 2. 性能差异
+- **内存数据库**：读写速度极快，适合测试和开发
+- **MySQL数据库**：性能稳定，适合生产环境
+
+### 3. 功能限制
+- 内存数据库模式下，某些MySQL特有功能可能不可用
+- 连接池监控在内存数据库模式下会显示特殊状态
+
+### 4. 测试建议
+- 开发阶段使用SQLite内存数据库，快速测试功能，无需安装MySQL
+- 部署前使用MySQL数据库进行完整测试
+- 生产环境必须使用MySQL数据库
+
+## 🛠️ 开发工作流
+
+### 1. 本地开发
+```bash
+# 设置环境变量
+export db_memory=1
+
+# 启动开发服务器
+npm run dev
+```
+
+### 2. 功能测试
+```bash
+# 测试用户注册
+curl -X POST http://localhost:3000/home/register/yt_user \
+  -H "Content-Type: application/json" \
+  -d '{"email":"test@example.com","password":"123456"}'
+
+# 测试用户登录
+curl -X POST http://localhost:3000/public/auth/yt_user \
+  -H "Content-Type: application/json" \
+  -d '{"email":"test@example.com","password":"123456"}'
+```
+
+### 3. 数据重置
+```bash
+# 重置测试数据
+curl -X POST http://localhost:3000/test/test-data/reset
+```
+
+## 📈 优势
+
+1. **快速启动**：无需安装和配置MySQL数据库
+2. **数据隔离**：每次重启都是全新的测试环境
+3. **自动化测试**：CI/CD环境可以快速启动测试
+4. **开发效率**：开发者可以专注于业务逻辑，无需关心数据库配置
+
+现在你可以通过设置 `db_memory=1` 来启用内存数据库模式，方便进行测试和开发！