Skip to content

示例:代码重构

本示例展示如何利用 Plan 模式安全执行跨多文件的重构,在任何代码变更之前完整审阅每个步骤。

场景

Service 层内将重复校验逻辑分散在多个文件中。你希望将其抽取为共享辅助函数,更新所有调用方,并确保行为完全不变。

第一步:用 Plan 模式提高可见性

切换到 Plan 模式,让 Agent 先生成执行计划再动文件:

text
/plan
重构 service 层,消除重复校验逻辑。
将所有共享校验逻辑抽取到单一辅助函数中。
保持行为不变,确保现有测试仍通过。

Agent 会输出类似这样的计划:

执行计划:
1. 读取所有 service 文件,识别重复校验模式
2. 确定共享辅助函数的最佳位置(如 internal/validation/)
3. 创建包含抽取逻辑的辅助函数
4. 更新每个调用方使用新辅助函数
5. 运行测试套件验证行为不变

第二步:审阅计划

逐条确认每个步骤。可要求 Agent 深入说明或调整:

text
第三步之前,检查各调用方的校验逻辑是否存在边界情况差异。

第三步:确认并执行

确认满意后告知 Agent 开始:

text
没问题,请继续。

Agent 将逐步执行,高风险写入操作时弹出审批确认。

第四步:查看变更摘要

所有写入完成后,让 Agent 总结:

text
总结哪些文件发生了变更,以及新校验辅助函数的功能。

第五步:运行测试

text
运行完整测试套件。

审批 Shell 命令后确认。如果测试失败,用 Bug 排查方法定位问题。

一次性提示词写法

对于范围小、已明确的重构:

text
重构 service 层,消除重复校验逻辑,将共享逻辑抽取为辅助函数。
更新所有调用方,运行测试验证行为不变。

期望产出

  • 所有 service 文件中重复逻辑被消除
  • 责任清晰的新共享辅助函数
  • 对外 API 合约不变
  • 现有测试全部通过

技巧

保持 PR 范围小尔自有边界

明确告知 Agent:“遇到无关问题请记录但不要修复。”这样能保持 PR 易于 Review。

相关页面

Released under the MIT License.