project-workflow-analysis-blueprint-generator

项目工作流文档生成器

配置变量

${PROJECT_TYPE="自动检测|.NET|Java|Spring|Node.js|Python|React|Angular|微服务|其他"}
<!-- 主要技术栈 -->

${ENTRY_POINT="API|GraphQL|前端|CLI|消息消费者|定时任务|自定义"}
<!-- 流程的起点 -->

${PERSISTENCE_TYPE="自动检测|SQL数据库|NoSQL数据库|文件系统|外部API|消息队列|缓存|无"}
<!-- 数据存储类型 -->

${ARCHITECTURE_PATTERN="自动检测|分层架构|整洁架构|CQRS|微服务|MVC|MVVM|无服务器|事件驱动|其他"}
<!-- 主要架构模式 -->

${WORKFLOW_COUNT=1-5}
<!-- 要记录的工作流数量 -->

${DETAIL_LEVEL="标准|实现就绪"}
<!-- 包含的实现细节级别 -->

${INCLUDE_SEQUENCE_DIAGRAM=true|false}
<!-- 生成序列图 -->

${INCLUDE_TEST_PATTERNS=true|false}
<!-- 包含测试方法 -->

生成的提示

"分析代码库并记录${WORKFLOW_COUNT}个代表性的端到端工作流，
这些工作流可作为类似功能的实现模板。使用以下方法：

初始检测阶段

${PROJECT_TYPE == "自动检测" ? 
  "首先检查代码库结构以识别技术：
   - 检查.NET解决方案/项目、Spring配置、Node.js/Express文件等
   - 识别使用的主要编程语言和框架
   - 根据文件夹结构和关键组件确定架构模式" 
  : "专注于${PROJECT_TYPE}模式和约定"}

${ENTRY_POINT == "自动检测" ? 
  "通过查找以下内容识别典型入口点：
   - API控制器或路由定义
   - GraphQL解析器
   - 发起网络请求的UI组件
   - 消息处理器或事件订阅者
   - 定时任务定义" 
  : "专注于${ENTRY_POINT}入口点"}

${PERSISTENCE_TYPE == "自动检测" ? 
  "通过检查以下内容确定持久化机制：
   - 数据库上下文/连接配置
   - 仓库实现
   - ORM映射
   - 外部API客户端
   - 文件系统交互" 
  : "专注于${PERSISTENCE_TYPE}交互"}

工作流文档说明

对于系统中最具代表性的${WORKFLOW_COUNT}个工作流中的每一个：

1. 工作流概述

• 提供工作流的名称和简要描述
• 解释其业务目的
• 识别触发动作或事件
• 列出完整工作流中涉及的所有文件/类

2. 入口点实现

API入口点：

${ENTRY_POINT == "API" || ENTRY_POINT == "自动检测" ? 
  "- 记录接收请求的API控制器类和方法
   - 显示完整的方法签名，包括属性/注解
   - 包含完整的请求DTO/模型类定义
   - 记录验证属性和自定义验证器
   - 显示认证/授权属性和检查" : ""}

GraphQL入口点：

${ENTRY_POINT == "GraphQL" || ENTRY_POINT == "自动检测" ? 
  "- 记录GraphQL解析器类和方法
   - 显示查询/变更的完整模式定义
   - 包含输入类型定义
   - 显示解析器方法实现及参数处理" : ""}

前端入口点：

${ENTRY_POINT == "前端" || ENTRY_POINT == "自动检测" ? 
  "- 记录发起API调用的组件
   - 显示触发请求的事件处理器
   - 包含API客户端服务方法
   - 显示与请求相关的状态管理代码" : ""}

消息消费者入口点：

${ENTRY_POINT == "消息消费者" || ENTRY_POINT == "自动检测" ? 
  "- 记录消息处理器类和方法
   - 显示消息订阅配置
   - 包含完整的消息模型定义
   - 显示反序列化和验证逻辑" : ""}

3. 服务层实现

• 记录每个涉及的服务类及其依赖
• 显示完整的方法签名，包括参数和返回类型
• 包含实际的方法实现及关键业务逻辑
• 记录接口定义（如适用）
• 显示依赖注入注册模式

CQRS模式：

${ARCHITECTURE_PATTERN == "CQRS" || ARCHITECTURE_PATTERN == "自动检测" ? 
  "- 包含完整的命令/查询处理器实现" : ""}

整洁架构模式：

${ARCHITECTURE_PATTERN == "整洁架构" || ARCHITECTURE_PATTERN == "自动检测" ? 
  "- 显示用例/交互器实现" : ""}

4. 数据映射模式

• 记录DTO到领域模型的映射代码
• 显示对象映射器配置或手动映射方法
• 包含映射过程中的验证逻辑
• 记录映射过程中创建的领域事件

5. 数据访问实现

• 记录仓库接口及其实现
• 显示完整的方法签名，包括参数和返回类型
• 包含实际的查询实现
• 记录实体/模型类定义及所有属性
• 显示事务处理模式

SQL数据库模式：

${PERSISTENCE_TYPE == "SQL数据库" || PERSISTENCE_TYPE == "自动检测" ? 
  "- 包含ORM配置、注解或Fluent API用法
   - 显示实际的SQL查询或ORM语句" : ""}

NoSQL数据库模式：

${PERSISTENCE_TYPE == "NoSQL数据库" || PERSISTENCE_TYPE == "自动检测" ? 
  "- 显示文档结构定义
   - 包含文档查询/更新操作" : ""}

6. 响应构建

• 记录响应DTO/模型类定义
• 显示从领域/实体模型到响应模型的映射
• 包含状态码选择逻辑
• 记录错误响应结构和生成

7. 错误处理模式

• 记录工作流中使用的异常类型
• 显示每一层的try/catch模式
• 包含全局异常处理器配置
• 记录错误日志实现
• 显示重试策略或断路器模式
• 包含失败场景的补偿操作

8. 异步处理模式

• 记录后台任务调度代码
• 显示事件发布实现
• 包含消息队列发送模式
• 记录回调或Webhook实现
• 显示异步操作的跟踪和监控方式

测试方法（可选）：

${INCLUDE_TEST_PATTERNS ? 
  "9. **测试方法**
     - 记录每一层的单元测试实现
     - 显示模拟模式和测试夹具设置
     - 包含集成测试实现
     - 记录测试数据生成方法
     - 显示API/控制器测试实现" : ""}

序列图（可选）：

${INCLUDE_SEQUENCE_DIAGRAM ? 
  "10. **序列图**
      - 生成详细的序列图，显示所有组件
      - 包含带参数类型的方法调用
      - 显示组件之间的返回值
      - 记录条件流程和错误路径" : ""}

11. 命名约定

记录一致的命名模式：

• 控制器命名（例如：EntityNameController）
• 服务命名（例如：EntityNameService）
• 仓库命名（例如：IEntityNameRepository）
• DTO命名（例如：EntityNameRequest、EntityNameResponse）
• CRUD操作的方法命名模式
• 变量命名约定
• 文件组织模式

12. 实现模板

提供可重用的代码模板：

• 按照模式创建新的API端点
• 实现新的服务方法
• 添加新的仓库方法
• 创建新的领域模型类
• 实现正确的错误处理

特定技术实现模式

.NET实现模式（如果检测到）：

${PROJECT_TYPE == ".NET" || PROJECT_TYPE == "自动检测" ? 
  "- 完整的控制器类，包含属性、过滤器和依赖注入
   - Startup.cs或Program.cs中的服务注册
   - Entity Framework DbContext配置
   - 使用EF Core或Dapper的仓库实现
   - AutoMapper配置文件
   - 横切关注点的中间件实现
   - 扩展方法模式
   - 配置的选项模式实现
   - 使用ILogger的日志实现
   - 认证/授权过滤器或策略实现" : ""}

Spring实现模式（如果检测到）：

${PROJECT_TYPE == "Java" || PROJECT_TYPE == "Spring" || PROJECT_TYPE == "自动检测" ? 
  "- 完整的控制器类，包含注解和依赖注入
   - 带事务边界的服务实现
   - 仓库接口和实现
   - 带关系的JPA实体定义
   - DTO类实现
   - Bean配置和组件扫描
   - 异常处理器实现
   - 自定义验证器实现" : ""}

React实现模式（如果检测到）：

${PROJECT_TYPE == "React" || PROJECT_TYPE == "自动检测" ? 
  "- 带属性和状态的组件结构
   - Hook实现模式（useState、useEffect、自定义Hook）
   - API服务实现
   - 状态管理模式（Context、Redux）
   - 表单处理实现
   - 路由配置" : ""}

实现指南

基于记录的工作流，提供实现新功能的具体指导：

1. 分步实现过程

• 添加类似功能时从哪里开始
• 实现顺序（例如：模型 → 仓库 → 服务 → 控制器）
• 如何与现有的横切关注点集成

2. 常见陷阱避免

• 识别当前实现中容易出错的区域
• 注意性能考虑
• 列出常见的错误或问题

3. 扩展机制

• 记录如何接入现有的扩展点
• 显示如何在不修改现有代码的情况下添加新行为
• 解释配置驱动的功能模式

结论：
总结实现新功能时应遵循的最重要模式，以保持与代码库的一致性。"