Design & UI
Read the complete source ↗
refactoring
代码重构助手,基于《重构:改善既有代码的设计(第2版)》。包含28种代码坏味道识别方法和完整的61种重构手法。 使用场景: (1) 识别代码中的坏味道并获取重构建议 (2) 查找特定重构手法的详细步骤和示例 (3) 系统化地改善代码结构和可维护性 (4) 学习重构的最佳实践
Onweekendd · Static checks on file
Installation
Read the source and dependencies before running a command. Copying does not install or execute anything.
npx skills add Onweekendd/ScreenWright --skill refactoringAbout this skill
name: refactoring description: | 代码重构助手,基于《重构:改善既有代码的设计(第2版)》。包含28种代码坏味道识别方法和完整的61种重构手法。 使用场景: (1) 识别代码中的坏味道并获取重构建议 (2) 查找特定重构手法的详细步骤和示例 (3) 系统化地改善代码结构和可维护性 (4) 学习重构的最佳实践
代码重构助手
本 skill 基于 Martin Fowler 的《重构:改善既有代码的设计(第2版)》,提供代码坏味道识别和系统化的重构指导。
快速开始
识别代码坏味道
当发现代码问题时,可对照以下28种坏味道进行识别(基于《重构》第2版 24种核心坏味道 + 4种常见变体):
| 坏味道 | 典型特征 | 推荐重构 |
|---|---|---|
| 神秘的命名 | 名字不能清晰表达用途 | 变量改名(137)、函数改名(124)、字段改名(244) |
| 重复代码 | 相同代码结构出现在多处 | 提炼函数(106)、提炼类(182)、函数上移(350)、字段上移(353)、滑动语句(223) |
| 过长函数 | 函数体超过一屏或包含多层抽象 | 提炼函数(106)、拆分阶段(155)、以命令取代函数(337)、以查询取代临时变量(178) |
| 过长参数列表 | 参数超过3-4个 | 引入参数对象(140)、保持对象完整(319)、以查询取代参数(324) |
| 全局数据 | 任何地方都可访问和修改 | 封装变量(132)、封装记录(162) |
| 可变数据 | 数据在多处被修改 | 封装变量(132)、以查询取代派生变量(248)、移除设值函数(331)、拆分变量(240)、将引用对象改为值对象(252) |
| 发散式变化 | 一个类因多种原因修改 | 提炼类(182)、提炼超类(375)、拆分阶段(155) |
| 霰弹式修改 | 每次修改需改动多个类 | 搬移函数(198)、搬移字段(201)、以函数调用取代内联代码(217)、组合函数为类(144)、组合函数为变换(149) |
| 依恋情结 | 函数更多使用其他类数据 | 搬移函数(198)、搬移字段(201)、提炼函数(106) |
| 数据泥团 | 总是同时出现的一组数据 | 引入参数对象(140)、提炼类(182)、保持对象完整(319) |
| 基本类型偏执 | 过度使用基本类型 | 以对象取代基本类型(174)、封装记录(162)、将值对象改为引用对象(256) |
| 重复的switch | 相同switch逻辑多处出现 | 以多态取代条件表达式(272)、以子类取代类型码(362) |
| 循环 | 使用传统循环而非管道 | 以管道取代循环(231)、拆分循环(227) |
| 冗赘的元素 | 不再使用的代码(未用函数/类/接口) | 移除死代码(237)、内联函数(115)、内联类(186)、折叠继承体系(380)、移除子类(369) |
| 夸夸其谈通用性 | 为未存在需求设计的抽象(过度设计) | 折叠继承体系(380)、移除子类(369)、以委托取代超类(399)、内联函数(115)、内联类(186) |
| 临时字段 | 字段只在特定情况使用 | 提炼类(182)、引入特例(289) |
| 过长的消息链 | a.b.c.d 调用链 | 隐藏委托关系(189)、提炼函数(106)、搬移函数(198) |
| 中间人 | 类大部分函数委托给其他类 | 移除中间人(192)、内联类(186) |
| 过大的类 | 类承担过多责任 | 提炼类(182)、拆分阶段(155)、提炼超类(375)、提炼子类(以子类取代类型码362) |
| 异曲同工的类 | 不同类做同样事但接口不同 | 改变函数声明(124)、搬移函数(198)、提炼超类(375) |
| 数据类 | 只有数据没有行为 | 封装记录(162)、封装集合(170)、移除设值函数(331)、搬移函数(198) |
| 被拒绝的遗赠 | 子类不需要超类部分功能 | 以委托取代子类(381)、函数下移(359)、字段下移(361)、以委托取代超类(399) |
| 注释 | 用注释解释"做什么"而非"为什么" | 提炼函数(106)、改变函数声明(124)、引入断言(302) |
| 不恰当的亲密 | 类之间过度了解彼此内部(直接访问私有成员) | 搬移函数(198)、搬移字段(201)、隐藏委托关系(189)、提炼类(182) |
| 内幕交易 | 类之间通过其他类间接访问(过度耦合) | 搬移函数(198)、搬移字段(201)、隐藏委托关系(189)、以委托取代超类(399)、以委托取代子类(381) |
| 令人迷惑的临时变量 | 变量用途不清晰或多次赋值 | 拆分变量(240)、变量改名(137)、提炼变量(119)、内联变量(123)、以查询取代临时变量(178) |
| 不必要的上下文 | 函数接收完整对象但只用部分字段 | 以查询取代参数(324)、保持对象完整(319反向)、搬移函数(198) |
| 发散的递归/嵌套 | 深度嵌套的条件或递归难以跟踪 | 以卫语句取代嵌套条件(266)、分解条件表达式(260)、引入特例(289) |
| 死代码 | 永远不会执行的代码分支 | 移除死代码(237)、折叠继承体系(380)、移除子类(369) |
| 交叉赋值 | 变量承担多个职责 | 拆分变量(240)、以查询取代派生变量(248) |
重构手法分组
根据代码问题类型,选择对应章节的详细参考:
- 基础重构 → ch6-first-group.md
- 封装相关 → ch7-encapsulation.md
- 搬移特性 → ch8-moving-features.md
- 数据组织 → ch9-reorganizing-data.md
- 条件逻辑 → ch10-simplifying-conditionals.md
- API重构 → ch11-refactoring-apis.md
- 继承关系 → ch12-handling-inheritance.md
重构原则
两顶帽子
使用重构时,要明确自己当前戴的是哪顶帽子:
- 添加功能:添加新能力,不修改已有代码
- 重构:调整代码结构,不添加新功能
不要同时戴上这两顶帽子。
重构的定义
重构是对软件内部结构的一种调整,目的是在不改变软件可观察行为的前提下,提高其可理解性、降低其修改成本。
何时重构
- 事不过三:同样的代码出现第三次时,进行重构
- 添加功能时:如果代码结构妨碍添加功能,先重构
- 修复bug时:如果代码难以理解,先重构
- 代码审查时:发现需要改进的地方
何时不重构
- 需要完全重写时
- 项目临近截止时
- 代码不会被使用时
常用重构速查
| 编号 | 名称 | 用途 |
|---|---|---|
| 基础重构 (Chapter 6) |