# 代码重构 ## 什么时候使用这个技能 * **代码审查**：发现复杂或重复的代码 * **添加新功能之前**：清理现有代码 * **错误修复后**：消除根本原因 * **解决技术债务**：定期重构 ## 说明 ### 步骤1：提取方法 **之前（长函数）**：函数 processOrder(订单：订单) { // 验证 if (!order.items || order.items.length === 0) { throw new Error('订单必须有商品'); } if (!order.customerId) { throw new Error('订单必须有客户'); } // 价格计算让总计 = 0； for (order.items 的 const item) { 总计 += 商品.价格 * 商品.数量; } 常务税 = 总计 * 0.1；常量运费 = 总计 > 100 ？ 0：10； const FinalTotal = 总计 + 税费 + 运费； // 库存检查 for (order.items 的 const item) { const Product = wait db.product.findUnique({ 其中：{ id: item.productId } }); if (产品.库存 < 商品.数量) { throw new Error(`${product.name} 库存不足`); } } // 创建订单 const newOrder = 等待 db.order.create({ 数据：{ 客户ID：订单.客户ID，项目：订单.项目，总计：最终总计，状态：“待定” } }); 返回新订单； } **（方法提取）之后**：异步函数 processOrder(order: Order) { 验证订单（订单）； const 总计 = 计算总计（订单）；等待检查库存（订单）；返回等待createOrder（订单，总计）； } 函数 validateOrder(订单：订单) { if (!order.items || order.items.length === 0) { throw new Error('订单必须有商品'); } if (!order.customerId) { throw new Error('订单必须有客户'); } } 函数calculateTotal(order: Order): number { const subtotal = order.items.reduce((sum, item) => sum + item.price * item.quantity, 0); 常量税 = 小计 * 0.1；常量运费 = 小计 > 100 ？ 0：10；退货小计+税+运费； } 异步函数 checkInventory(order: Order) { for (order.items 的 const item) { const Product = wait db.product.findUnique({ 其中：{ id: item.productId } }); if (产品.库存 < 商品.数量) { throw new Error(`${product.name} 库存不足`); } } } 异步函数 createOrder(订单：订单，总计：数量) { 返回等待 db.order.create({ 数据：{ 客户ID：订单.客户ID，项目：订单.项目，总计，状态：“待定” } }); } ### 步骤 2：删除重复项 **之前（重复）**：异步函数 getActiveUsers() { 返回等待 db.user.findMany({ 其中：{ status：'active'，deletedAt：null }，选择：{ id：true，名称：true，电子邮件：true } }); } 异步函数 getActivePremiumUsers() { 返回等待 db.user.findMany({ 其中：{ status：'active'，deletedAt：null，plan：'premium'}，选择：{ id：true，名称：true，电子邮件：true } }); } **之后（提取通用逻辑）**：类型用户过滤器 = { 计划？：字符串； }; 异步函数 getActiveUsers(filter: UserFilter = {}) { 返回等待 db.user.findMany({ 其中：{ 状态：'活动'，已删除：空， ...过滤器 }, 选择：{ id：true，名称：true，电子邮件：true } }); } // 用法 const allActiveUsers = 等待 getActiveUsers(); const premiumUsers =等待 getActiveUsers({ plan: 'premium' }); ### 步骤 3：用多态性替换条件式 **之前（长if-else）**：类支付处理器{ 流程（付款：付款）{ if ( payment.method === 'credit_card') { // 信用卡处理 const cardToken = this.tokenizeCard( payment.card); const charge = this.chargeCreditCard(cardToken, payment.amount); 退货费用； } else if ( payment.method === 'paypal') { // 贝宝处理 const paypalOrder = this.createPayPalOrder( payment. amount ); const 批准 = this.getPayPalApproval(paypalOrder); 返回批准； } else if ( payment.method === 'bank_transfer') { // 银行转账处理 const 转账 = this.initiateBankTransfer( payment.account, payment.amount); 回程接送； } } } **之后（多态性）**：接口支付方式{ 流程（付款：付款）：Promise； } CreditCardPayment 类实现 PaymentMethod { 异步流程（付款：付款）： Promise { const cardToken = wait this.tokenizeCard( payment.card); 返回等待 this.chargeCreditCard(cardToken, payment.amount); } } 类 PayPalPayment 实现 PaymentMethod { 异步流程（付款：付款）： Promise { const order = wait this.createPayPalOrder( payment.amount ); 返回等待 this.getPayPalApproval(order); } } 类 BankTransferPayment 实现 PaymentMethod { 异步流程（付款：付款）： Promise { 返回等待this.initiateBankTransfer（付款.帐户，付款.金额）； } } 类支付处理器{ 私有方法： Map = new Map([ ['credit_card', new CreditCardPayment()], ['paypal', new PayPalPayment()], ['bank_transfer', new BankTransferPayment()] ]); 异步流程（付款：付款）： Promise { const method = this.methods.get( payment.method ); 如果（！方法）{ throw new Error(`未知的付款方式：${ payment.method}`); } 返回等待方法.process(付款); } } ### 步骤4：引入参数对象 **之前（许多参数）**：函数创建用户（名称：字符串，电子邮件：字符串，密码：字符串，年龄：数字，国家/地区：字符串，城市：字符串，邮政编码：字符串，电话号码：字符串）{ // ... } **之后（分组为对象）**：接口用户配置文件{ 名称：字符串；电子邮件：字符串；密码：字符串；年龄：数字； } 接口地址{ 国家：字符串；城市：字符串；邮政编码：字符串； } 接口创建用户参数{ 个人资料：用户个人资料；地址：地址；电话号码：字符串； } 函数createUser（参数：CreateUserParams）{ const { 个人资料、地址、电话号码 } = params; // ... } // 用法创建用户（{ 个人资料：{ 姓名：'约翰'，电子邮件：'john@example.com'，密码：'xxx'，年龄：30 }，地址: { 国家: '美国', 城市: '纽约', 邮政编码: '10001' }, 电话号码: '+1234567890' }); ### 步骤 5：应用坚实的原则 **单一责任**： // ❌ 坏例子：多重责任类用户{ 构造函数（公共名称：字符串，公共电子邮件：字符串）{} 保存（）{ // 保存到数据库 } 发送电子邮件（主题：字符串，正文：字符串）{ // 发送电子邮件 } 生成报告（）{ // 生成报告 } } // ✅ 好例子：职责分离类用户{ 构造函数（公共名称：字符串，公共电子邮件：字符串）{} } 类 UserRepository { 保存（用户：用户）{ // 保存到数据库 } } 类电子邮件服务{ 发送（收件人：字符串，主题：字符串，正文：字符串）{ // 发送电子邮件 } } 类 UserReportGenerator { 生成（用户：用户）{ // 生成报告 } } ## 输出格式 ### 重构清单 - [ ] 函数只做一件事（SRP） - [ ] 函数名称清楚地描述了它的作用 - [ ] 函数不超过 20 行（指导） - [ ] 3 个或更少的参数 - [ ] 无重复代码 (DRY) - [ ] 如果嵌套层数为 2 层或更少 - [ ] 无幻数（提取为常量） - [ ] 无需注释即可理解（自我记录） ## 约束条件 ### 强制性规则（必须） 1. **先测试**：在重构之前编写测试 2. **小步骤**：一次改变一件事 3. **行为保留**：无功能变化 ### 禁止（不得） 1. **同时进行多个任务** : 无需同时进行重构+功能添加 2. **未经测试的重构**：回归风险 ## 最佳实践 1. **童子军规则**：让代码比你发现的更干净 2. **重构时机**：红绿重构（TDD） 3. **渐进式改进**：一致性胜于完美 4. **行为保留**：重构不涉及功能改变 5. **小提交**：以重点单位提交 ** ** ## 行为验证（代码简化器集成） ### 步骤 A：了解当前行为重构之前充分了解当前行为： ## 行为分析 ### 输入 - [输入参数列表] - [类型和限制] ### 输出 - [返回值] - [副作用] ### 不变量 - [必须始终为真的条件] - [边缘情况] ### 依赖关系 - [外部依赖] - [状态依赖] ### 步骤 B：重构后验证 # 1. 运行测试 npm 测试 -- --覆盖率 # 2. 类型检查 npx tsc --noEmit # 3. 棉绒检查 npm 运行 lint # 4. 与之前的行为进行比较（快照测试） npm 测试 -- --updateSnapshot ### 步骤 C：文档更改 ## 重构总结 ### 所做的更改 1.【变更1】：【原因】 2.【变更2】：【原因】 ### 行为保留 - [x] 相同的输入 → 相同的输出 - [x] 相同的副作用 - [x] 相同的错误处理 ### 风险与后续行动 - [潜在风险] - [后续任务] ### 测试状态 - [ ] 单元测试：通过 - [ ] 集成测试：通过 - [ ] E2E 测试：通过 ** ** ## 故障排除 ### 问题：重构后测试失败 **原因**：发生行为更改**解决方案**：恢复并隔离更改，然后重试 ### 问题：代码仍然复杂 **原因**：多个职责混合在一个职能中 **解决方案**：提取为边界清晰的更小的单元 ### 问题：性能回归 **原因**：引入低效抽象 **解决方案**：分析并优化热路径 ** ** ## 多代理工作流程 ### 验证和回顾 * **第 1 轮（Orchestrator）**：验证行为保留清单 * **第二轮（分析师）**：复杂性和重复分析 * **第 3 轮（执行器）** ：测试或静态分析验证 ### 代理角色代理|角色 ---|--- 克劳德|重构计划、代码改造双子座|大规模代码库分析、模式检测法典|测试执行、构建验证 ### 工作流程示例 # 1.Gemini：代码库分析 Ask-gemini“@src/提取高复杂性函数列表” # 2. Claude：重构计划和执行 # 基于 IMPLMENTATION_PLAN.md 的工作 # 3. 法典：验证 codex-cli shell“npm test && npm run lint” ## 参考文献 * [重构（马丁·福勒）]() * [干净代码 (Robert C. Martin)]() * [SOLID 原则]() ## 元数据 ### 版本 * **当前版本**：1.0.0 * **最后更新** : 2025-01-01 * **兼容平台**：Claude、ChatGPT、Gemini ### 相关技能 * [代码审查]() * [后端测试]() ### 标签 `#refactoring` `#code-quality` `#DRY` `#SOLID` `#design-patterns` `#clean-code` ## 示例 ### 示例 1：基本用法 ### 示例 2：高级用法

代码重构

包含技能