architecture-blueprint-generator

全面的项目架构蓝图生成器

配置变量

${PROJECT_TYPE="自动检测|.NET|Java|React|Angular|Python|Node.js|Flutter|其他"} <!-- 主要技术 -->
${ARCHITECTURE_PATTERN="自动检测|整洁架构|微服务|分层架构|MVVM|MVC|六边形架构|事件驱动|无服务器|单体架构|其他"} <!-- 主要架构模式 -->
${DIAGRAM_TYPE="C4|UML|流程图|组件图|无"} <!-- 架构图类型 -->
${DETAIL_LEVEL="高层级|详细|全面|可实施"} <!-- 包含的详细程度 -->
${INCLUDES_CODE_EXAMPLES=true|false} <!-- 包含示例代码以说明模式 -->
${INCLUDES_IMPLEMENTATION_PATTERNS=true|false} <!-- 包含详细的实现模式 -->
${INCLUDES_DECISION_RECORDS=true|false} <!-- 包含架构决策记录 -->
${FOCUS_ON_EXTENSIBILITY=true|false} <!-- 强调扩展点和模式 -->

生成的提示

"创建一个全面的'Project_Architecture_Blueprint.md'文档，深入分析代码库中的架构模式，作为维护架构一致性的权威参考。使用以下方法：

1. 架构检测与分析

• ${PROJECT_TYPE == "自动检测" ? "分析项目结构，识别所有使用的技术栈和框架，通过检查：\n - 项目和配置文件\n - 包依赖和导入语句\n - 框架特定的模式和约定\n - 构建和部署配置" : "专注于${PROJECT_TYPE}特定的模式和实践"}

• ${ARCHITECTURE_PATTERN == "自动检测" ? "通过分析确定架构模式：\n - 文件夹组织和命名空间\n - 依赖流向和组件边界\n - 接口隔离和抽象模式\n - 组件间的通信机制" : "记录${ARCHITECTURE_PATTERN}架构是如何实现的"}

2. 架构概述

• 清晰简洁地解释整体架构方法
• 记录架构选择中体现的指导原则
• 识别架构边界及其强制方式
• 注意任何混合架构模式或标准模式的调整

3. 架构可视化

${DIAGRAM_TYPE != "无" ? 创建${DIAGRAM_TYPE}图，涵盖多个抽象层级：\n- 高层级架构概览，展示主要子系统\n- 组件交互图，展示关系和依赖\n- 数据流图，展示信息在系统中的流动\n- 确保图表准确反映实际实现，而非理论模式 : "基于实际代码依赖描述组件关系，提供清晰的文本解释：\n- 子系统组织和边界\n- 依赖方向和组件交互\n- 数据流和流程顺序"}

4. 核心架构组件

对于代码库中发现的每个架构组件：

• 目的与职责：

  • 在架构中的主要功能
  • 处理的业务领域或技术关注点
  • 边界和范围限制

• 内部结构：

  • 组件内类/模块的组织
  • 关键抽象及其实现
  • 使用的设计模式

• 交互模式：

  • 组件如何与其他组件通信
  • 暴露和消费的接口
  • 依赖注入模式
  • 事件发布/订阅机制

• 演进模式：

  • 组件如何扩展
  • 变化点和插件机制
  • 配置和定制方法

5. 架构层与依赖

• 映射代码库中实现的层结构
• 记录层之间的依赖规则
• 识别实现层分离的抽象机制
• 注意任何循环依赖或层违规
• 记录用于保持分离的依赖注入模式

6. 数据架构

• 记录领域模型结构和组织
• 映射实体关系和聚合模式
• 识别数据访问模式（仓库、数据映射器等）
• 记录数据转换和映射方法
• 注意缓存策略和实现
• 记录数据验证模式

7. 横切关注点实现

记录横切关注点的实现模式：

• 认证与授权：

  • 安全模型实现
  • 权限强制模式
  • 身份管理方法
  • 安全边界模式

• 错误处理与弹性：

  • 异常处理模式
  • 重试和断路器实现
  • 回退和优雅降级策略
  • 错误报告和监控方法

• 日志与监控：

  • 仪表化模式
  • 可观测性实现
  • 诊断信息流
  • 性能监控方法

• 验证：

  • 输入验证策略
  • 业务规则验证实现
  • 验证职责分配
  • 错误报告模式

• 配置管理：

  • 配置源模式
  • 环境特定配置策略
  • 密钥管理方法
  • 功能标志实现

8. 服务通信模式

• 记录服务边界定义
• 识别通信协议和格式
• 映射同步与异步通信模式
• 记录API版本控制策略
• 识别服务发现机制
• 注意服务通信中的弹性模式

9. 技术特定架构模式

${PROJECT_TYPE == "自动检测" ? "对于每个检测到的技术栈，记录特定的架构模式：" : Document ${PROJECT_TYPE}-specific architectural patterns:}

${(PROJECT_TYPE == ".NET" || PROJECT_TYPE == "自动检测") ?
"#### .NET架构模式（如果检测到）\n- 主机和应用模型实现\n- 中间件管道组织\n- 框架服务集成模式\n- ORM和数据访问方法\n- API实现模式（控制器、最小API等）\n- 依赖注入容器配置" : ""}

${(PROJECT_TYPE == "Java" || PROJECT_TYPE == "自动检测") ?
"#### Java架构模式（如果检测到）\n- 应用容器和启动过程\n- 依赖注入框架使用（Spring、CDI等）\n- AOP实现模式\n- 事务边界管理\n- ORM配置和使用模式\n- 服务实现模式" : ""}

${(PROJECT_TYPE == "React" || PROJECT_TYPE == "自动检测") ?
"#### React架构模式（如果检测到）\n- 组件组合和复用策略\n- 状态管理架构\n- 副作用处理模式\n- 路由和导航方法\n- 数据获取和缓存模式\n- 渲染优化策略" : ""}

${(PROJECT_TYPE == "Angular" || PROJECT_TYPE == "自动检测") ?
"#### Angular架构模式（如果检测到）\n- 模块组织策略\n- 组件层次设计\n- 服务和依赖注入模式\n- 状态管理方法\n- 响应式编程模式\n- 路由守卫实现" : ""}

${(PROJECT_TYPE == "Python" || PROJECT_TYPE == "自动检测") ?
"#### Python架构模式（如果检测到）\n- 模块组织方法\n- 依赖管理策略\n- OOP与函数式实现模式\n- 框架集成模式\n- 异步编程方法" : ""}

10. 实现模式

${INCLUDES_IMPLEMENTATION_PATTERNS ?
"记录关键架构组件的具体实现模式：\n\n- 接口设计模式：\n - 接口隔离方法\n - 抽象层级决策\n - 通用与特定接口模式\n - 默认实现模式\n\n- 服务实现模式：\n - 服务生命周期管理\n - 服务组合模式\n - 操作实现模板\n - 服务内错误处理\n\n- 仓库实现模式：\n - 查询模式实现\n - 事务管理\n - 并发处理\n - 批量操作模式\n\n- 控制器/API实现模式：\n - 请求处理模式\n - 响应格式化方法\n - 参数验证\n - API版本控制实现\n\n- 领域模型实现：\n - 实体实现模式\n - 值对象模式\n - 领域事件实现\n - 业务规则强制" : "提及详细的实现模式在代码库中有所不同。"}

11. 测试架构

• 记录与架构对齐的测试策略
• 识别测试边界模式（单元、集成、系统）
• 映射测试替身和模拟方法
• 记录测试数据策略
• 注意测试工具和框架集成

12. 部署架构

• 记录从配置派生的部署拓扑
• 识别环境特定的架构调整
• 映射运行时依赖解析模式
• 记录跨环境的配置管理
• 识别容器化和编排方法
• 注意云服务集成模式

13. 扩展与演进模式

${FOCUS_ON_EXTENSIBILITY ?
"提供扩展架构的详细指南：\n\n- 功能添加模式：\n - 如何在保持架构完整性的同时添加新功能\n - 按类型放置新组件的位置\n - 依赖引入指南\n - 配置扩展模式\n\n- 修改模式：\n - 如何安全修改现有组件\n - 保持向后兼容性的策略\n - 弃用模式\n - 迁移方法\n\n- 集成模式：\n - 如何集成新的外部系统\n - 适配器实现模式\n - 防腐层模式\n - 服务外观实现" : "记录架构中的关键扩展点。"}

${INCLUDES_CODE_EXAMPLES ?
"### 14. 架构模式示例\n提取代表性代码示例，说明关键架构模式：\n\n- 层分离示例：\n - 接口定义与实现分离\n - 跨层通信模式\n - 依赖注入示例\n\n- 组件通信示例：\n - 服务调用模式\n - 事件发布与处理\n - 消息传递实现\n\n- 扩展点示例：\n - 插件注册与发现\n - 扩展接口实现\n - 配置驱动扩展模式\n\n每个示例包含足够的上下文以清晰展示模式，但保持简洁并聚焦于架构概念。" : ""}

${INCLUDES_DECISION_RECORDS ?
"### 15. 架构决策记录\n记录代码库中体现的关键架构决策：\n\n- 架构风格决策：\n - 为何选择当前架构模式\n - 考虑的替代方案（基于代码演进）\n - 影响决策的约束\n\n- 技术选型决策：\n - 关键技术选择及其架构影响\n - 框架选择理由\n - 自定义与现成组件决策\n\n- 实现方法决策：\n - 选择的特定实现模式\n - 标准模式调整\n - 性能与可维护性权衡\n\n对于每个决策，记录：\n- 使决策必要的上下文\n- 决策时考虑的因素\n- 产生的后果（正面和负面）\n- 引入的未来灵活性或限制" : ""}

${INCLUDES_DECISION_RECORDS ? "16" : INCLUDES_CODE_EXAMPLES ? "15" : "14"}. 架构治理

• 记录如何维护架构一致性
• 识别架构合规性的自动化检查
• 注意代码库中体现的架构审查流程
• 记录架构文档实践

${INCLUDES_DECISION_RECORDS ? "17" : INCLUDES_CODE_EXAMPLES ? "16" : "15"}. 新开发蓝图

创建清晰的架构指南，用于实现新功能：

• 开发工作流：

  • 不同功能类型的起点
  • 组件创建顺序
  • 与现有架构的集成步骤
  • 按架构层的测试方法

• 实现模板：

  • 关键架构组件的基类/接口模板
  • 新组件的标准文件组织
  • 依赖声明模式
  • 文档要求

• 常见陷阱：

  • 应避免的架构违规
  • 常见架构错误
  • 性能考虑
  • 测试盲点

包含此蓝图生成的时间信息以及随架构演进保持更新的建议。"