🌍 Language Version | 语言版本: English Version | 返回主页
重构工作流是一个基于GitHub Copilot的系统化重构解决方案，专为AI辅助模块级代码重构设计。它提供了结构化的重构方法，确保模块级重构过程的可控性和高质量交付。
这是我们首个支持Mermaid图表的工作流，参考了《MermaidFlow: Redefining Agentic Workflow Generation via Safety-Constrained Evolutionary Programming》的思路，通过可视化图表增强工作流的理解和执行效率。
- 主模板:
refactor_system/refactor_workflow_template.md - 支持文件:
refactor_system/目录下的所有模板和工具
- 双层循环控制: 阶段级外循环 + 修改点级内循环
- 三层级计划: 总体计划 → 阶段计划 → 实施计划
- 优先级驱动: P0/P1/P2/P3 优先级阶段管理
- Copilot集成: 专为GitHub Copilot Agent模式优化
- 智能检查点: 自动验证和质量保证
- 增量式修改: 降低风险，提高成功率
- Mermaid图表: 支持流程图、架构图和依赖关系可视化
- 进度跟踪: 图形化展示重构进度和状态
- 架构演进: 可视化展示模块重构前后的架构变化
我需要对 [模块名] 进行重构，请启动重构工作流。- 需求分析: 确定重构范围和目标
- 计划制定: 创建三层级重构计划
- 分阶段执行: 按优先级逐步实施
- 质量保证: 每个修改点的验证和测试
- 文档维护: 同步更新相关文档
目标: 定义整体重构策略和优先级框架
- 内容: 重构愿景、P0-P3优先级划分、风险评估
- 输出:
level1_overall.md
目标: 将总体计划分解为可执行的阶段任务
- 内容: 具体修改点清单、检查点设置、实施顺序
- 输出:
level2_phase_P0.md,level2_phase_P1.md...
目标: 函数级别的具体实施方案
- 内容: 代码修改方案、测试用例、质量标准
- 输出:
level3_impl_P0.1.md,level3_impl_P0.2.md...
graph TD
L1[Level 1: 总体计划] --> L2A[Level 2: P0阶段计划]
L1 --> L2B[Level 2: P1阶段计划]
L1 --> L2C[Level 2: P2阶段计划]
L1 --> L2D[Level 2: P3阶段计划]
L2A --> L3A1[Level 3: P0.1实施计划]
L2A --> L3A2[Level 3: P0.2实施计划]
L2A --> L3A3[Level 3: P0.3实施计划]
L2B --> L3B1[Level 3: P1.1实施计划]
L2B --> L3B2[Level 3: P1.2实施计划]
graph LR
A[P0阶段] --> B{P0完成?}
B -->|是| C[P1阶段]
B -->|否| D[继续P0]
D --> A
C --> E{P1完成?}
E -->|是| F[P2阶段]
E -->|否| G[继续P1]
G --> C
特点:
- 优先级驱动: P0 → P1 → P2 → P3 按序执行
- 阶段完整性: 每个阶段必须100%完成才能进入下一阶段
- 用户参与决策: 每个阶段结束需要用户确认
graph LR
A[选择修改点] --> B[制定实施计划]
B --> C[执行修改]
C --> D[运行测试]
D --> E{测试通过?}
E -->|是| F[记录完成]
E -->|否| G[问题分析]
G --> H[调整方案]
H --> C
F --> I{阶段内还有修改点?}
I -->|是| A
I -->|否| J[阶段完成]
特点:
- 增量修改: 每次只处理一个修改点
- 即时验证: 每个修改点完成后立即测试
- 失败恢复: 失败后分析问题并调整方案
-
小批量渐进
- 每次只处理少量修改点
- 完成一个修改点再进行下一个
- 避免大范围同时修改
-
即时验证
- 每个修改点完成后立即测试
- 运行相关单元测试和集成测试
- 确保功能正确性和性能指标
-
文档同步更新
- 实时更新实施记录和进度
- 记录遇到的问题和解决方案
- 维护计划变更的版本历史
refactor_system/
├── refactor_workflow_template.md # 主工作流模板
├── README.md # 详细说明(中文)
├── README_en.md # 详细说明(英文)
├── docs/ # 文档目录
│ ├── architecture/ # 架构设计文档
│ ├── best-practices/ # 最佳实践指南
│ └── examples/ # 使用示例
├── templates/ # 模板文件
│ ├── level1-overall.md # Level 1 总体计划模板
│ ├── level2-phase.md # Level 2 阶段计划模板
│ ├── level3-implementation.md # Level 3 实施计划模板
│ ├── progress-tracking.md # 进度跟踪模板
│ ├── quality-checklist.md # 质量检查清单
│ └── mermaid-diagrams.md # Mermaid图表模板
├── tools/ # 工具脚本
│ ├── refactor-validator.py # 重构验证工具
│ ├── progress-tracker.py # 进度跟踪工具
│ ├── mermaid-generator.py # Mermaid图表生成器
│ └── test-runner.ps1 # 测试运行脚本
└── case-studies/ # 案例研究
├── successful-refactors/ # 成功重构案例
└── lessons-learned/ # 经验教训总结
- Mermaid图表支持: 首个集成Mermaid可视化的工作流系统
- 三层级计划: 从战略到战术的完整计划体系
- 双循环执行: 外循环控制阶段，内循环处理修改点
- 智能模板: 基于最佳实践设计的模板系统
- GitHub Copilot: Agent模式支持
- IDE: VS Code 推荐，支持Mermaid预览
- Git: 版本控制和分支管理
- 测试框架: 根据项目语言选择
- Mermaid CLI: 用于生成图表图片
- 静态分析工具: 代码质量检查
- 文档生成器: 自动生成文档
使用 refactor_workflow_template.md 作为重构会话的起点：
- 复制模板到工作目录
- 根据具体项目调整配置
- 启动重构会话
根据计划层级选择相应模板：
- Level 1:
templates/level1-overall.md - Level 2:
templates/level2-phase.md - Level 3:
templates/level3-implementation.md
使用 templates/mermaid-diagrams.md 创建可视化图表：
- 流程图模板
- 架构图模板
- 时序图模板
- 状态图模板
- 代码备份: 创建专用分支
- 测试基线: 确保现有测试通过
- 依赖分析: 理解模块间依赖关系
- 风险评估: 识别高风险修改点
- 小步快跑: 每次修改范围最小化
- 频繁测试: 每个修改点完成后立即验证
- 文档同步: 实时更新设计文档
- 进度跟踪: 使用可视化工具监控进度
- 代码审查: 每个修改点的人工审查
- 自动化测试: 单元测试和集成测试
- 性能基准: 确保性能不降级
- 向后兼容: 保持API兼容性
A: 重构工作流提供了完善的错误处理机制：
- 每个修改点都有回滚方案
- 问题发生时暂停执行，分析原因
- 调整实施计划后继续执行
- 记录问题和解决方案供后续参考
- 当前版本: 2.4.0
- 更新日期: 2025年7月29日
- 兼容性: GitHub Copilot Agent模式
维护团队: GitHub Copilot 工作流项目组 许可证: MIT License