重构 改善既有代码的设计(要点总结一)

本文探讨了重构的概念及其重要性,包括重构的基本技巧、时机和常见的代码‘坏味道’。介绍了如何通过小步前进、频繁测试的方式进行重构,以提高代码的可读性和可维护性。
任何一个傻瓜都能写出计算机能够理解的程序,唯有写出人类容易理解的程序,才是优秀的程序员。

定义:

对软件内部结构的一种调整,目的是在不改变软件可观察行为的前提下,提高其可理解性,降低其修改成本

目的:

使软件更容易被理解和修改。 与之形成对比的是性能优化,但是两者出发点不同,性能优化往往使代码较难理解。

性能优化:

不改变程序的外在行为(除了执行速度),只改变内部结构。

重构过程:

在不改变代码外在行为的前提下,对代码做出修改,以改进程序内部的结构。

重构基本技巧

小步前进,频繁测试

重构基本技巧说明

  1. 如果发现需要为程序添加一个特性,而代码结构使你无法很方便的达成目的,
    那就先重构代码,再添加特性。
  2. 重构之前,首先检查自己是否有一套可靠的测试机制,这些测试必须有自我检验能力。
    任何不会被修改的变量我会把它当做参数传入新的方法,
  3. 而会被修改的变量,如果只有一个,我会把它当做返回值。
  4. 重构步骤的本质,由于重构每次修改的幅度都很小,所以任何错误都很容易被发现。
    而会被修改的变量,如果只有一个,我会把它当做返回值。=

重构时机

添加功能时重构
修补错误时重构
复审代码时重构

程序有两面价值:

今天能为你做什么
明天能为你做什么
————Kent Beck

程序为什么难以相与?

难以阅读的程序,难以修改
逻辑重复的程序,难以修改
添加新行为时需要修改已有的程序,难以修改
带复杂条件逻辑的程序,难以修改

因此,我们希望程序:

容易阅读
所有逻辑都只能在唯一地点指定
新的改动不会危及现有行为
尽可能简单表达条件逻辑

间接层价值

允许逻辑共享
分开解释意图和实现
隔离变化
封装条件逻辑

坏味道:

  1. 重复代码 Duplicated Code
    a. 将相似部分和差异部分分开,构成单独一个函数。
  2. 过长函数 Long Method
    a. 间接层带来的利益——解释能力、共享能力、选择能力——都是由小型函数支持的
    b. 每当感觉需要注释来说明点什么的时候,我们就把需要说明的东西写进一个独立的函数中,并以其用途命名。
    c. 条件表达式和循环也常常是提炼的信号,循环和其内的代码可以被提炼到一个独立的函数中。
  3. 过大的类 Large Class
    a. 单个类做太多事情
  4. 过长的参数列表 Long Parameter List
    a. 如果向已有对象发出一条请求就可以取代一个参数,那你应该计划重构手法。
  5. 发散式变化 Divergent Change
    a. 某个类经常因为不同原因在不同方向上发生改变,应将类拆分
  6. 霰弹式修改 Shotgun Surgery
    a. 与发散式变化类似也恰恰相反
    b. 遇到某种变化需要在许多不同的类中做出小修改,需要将一系列相关行为放入一个类
    c. 使“外界变化”和“需要修改的类”趋于一一对应。
  7. 依恋情结 Feature Envy
    a. 将数据和对数据的操作行为包装在一起。
    b. 将总是一起变化的东西放在一块儿
  8. 数据泥团 Data Clumps
    a. 你常常可以在很多地方看到相同的三四项数据:两个类中相同的字段、许多函数签名中相同的参数。
  9. 基本类型偏执 Primitive Obsession
    a. 模糊(甚至打破)了横亘于基本数据和体积较大的类之间的界限。
  10. switch惊悚现身 Switch Statements
    a. 大多数时候可用多态替代
    b. 在单一函数中使用则显杀鸡用牛刀
  11. 平衡继承体系 Parallel Inheritance Hierarchies
    a. 每当为一个类增加一个子类,也要为另一个类增加一个子类。
    b. 策略:让一个继承体系的示例引用另一个继承体系的示例。
  12. 冗赘类 Lazy Class
    a. 如果一个类的所得不值其身价,它就应该消失。
    b. 对于几乎没有用的组件,可使用类的内联化处理。
  13. 夸夸其谈未来性 Speculative Generality
    a. 使用各种各样的钩子和特殊情况来处理一些非必要的事情。
    b. 过度设计未来不需要使用的功能。
  14. 令人迷惑的字段 Temporary Field
    a. 某个实例变量仅为特定情况而设,通常人们会以为对于全局适用。
    b. 把所有和这个类相关的代码都放入一个类。
  15. 过度耦合的消息链 Message Chains
    a. 对象请求一个对象,这个对象又请求另一个。
    b. z拆分或加中间层
  16. 中间人 Middle Man
    a. 某个类接口有一半的函数都是委托给其他类,不干实事
    b. 可使用内联函数把他们放进调用端,其它行为放入实责对象的子类
  17. 狎昵关系 Inappropriate Intimacy
    a. 两个类过于耦合
    b. 把两者共同点提炼到新类,或使用代理代替继承关系
  18. 异曲同工的类 Alternative Classes with Different Interfaces
    a. 合并代码或创建父类
  19. 不完美的库类 Incomplete Library Class
    a. 对于库类的丰富与扩展方法
  20. 纯稚的数据类 Data Class
    a. 拥有一些字段和访问这些字段的函数
    b. 尝试把调用取值、设值的方法放进来,将数据及取值设值的函数隐藏
  21. 被拒绝的遗赠 Refused Bequest
    a. 传统方法:新建兄弟类,将父类的非通用的方法push down
    b. 建议使用委托代替
  22. 过多的注释 Comments
    a. 长长的代码之所以存在乃是因为代码很糟糕。

重新组织函数

  1. 提炼函数 Extract Method
    a. 创建一个函数,根据这个函数的意图来命名,以“做什么”命名,不要以“怎么做”命名。
    b. z局部变量需改动时,使用查询(带返回值)
  2. 内联函数 Inline Method
    a. 间接性可能带来帮助,但非必要的间接性总让人不舒服
    b. 间接层有其价值,但不是所有间接层都有价值
  3. 内联临时变量 Inline Temp
    a. 将所有对该变量的引用动作,替换为对它赋值的那个表达式本身。
  4. 以查询取代临时变量 Replace Temp with Query
    a. 同一个类中所有函数都将获得这份信息
  5. 引入解释性变量 Introduce Explaining Variable
    a. 将复杂的表达式(或其中一部分)的结果放入一个临时变量,以此变量名称来解释表达式的用途。
    b. 可以删除注释,因为代码已经可以完美表达自己的意义了。
  6. 分解临时变量 Split Temporary Variable
    a. 针对每次赋值,创造一个独立、对应的临时变量。
  7. 移除对参数的赋值 Remove Assignments to Parameters
    a. 避免对一个参数进行赋值,使用临时变量替换,以免产生引用传递修改原值的问题。
  8. 以函数对象取代函数 Replace Method with Method Object
    a. 将函数放入一个单独对象中,其局部变量成为字段
    b. 可在同一个对象内进行函数拆解,而不必担心参数传递问题
  9. 替换算法 Substitude Algorithm
    a. 将原算法替换为新算法。
    b. 拆解原算法再进行替换并测试。

重构语录:

  • 三次法则:事不过三,三则重构
  • 计算机科学是这样一门科学:它相信所有问题都可以通过增加一个间接层来解决。 ——Dennis DeBruler
  • 重构往往把大型对象拆成多个小型对象,把大型函数拆成对个小型函数。 如果项目已非常接近最后期限,不应分心于重构。
  • 不过多个项目经验显示,重构的确能提高生产力, 如果最后没有足够的时间,通常表示你其实早该进行重构
  • Ward Cunningham把未完成的重构工作形容为“债务”,很多公司通过借债来使自己更有效的运转,
  • 但是借债就得付利息,过于复杂的代码所造成的维护和扩展的额外成本就是利息。
  • 重构肩负一项特殊使命:它和设计彼此互补。
  • 你必须培养出自己的判断力,判断一个类内有多少实例变量算是太大,一个函数内有多少行代码算是太长。
第1章 重构,第个案例 1 1.1 起点 1 1.2 重构的第步 7 1.3 分解并重组statement() 8 1.4 运用多态取代与价格相关的条件逻辑 34 1.5 结语 52 第2章 重构原则 53 2.1 何谓重构 53 2.2 为何重构 55 2.3 何时重构 57 2.4 怎么对经理说 60 2.5 重构的难题 62 2.6 重构设计 66 2.7 重构与性能 69 2.8 重构起源何处 71 第3章 代码的坏味道 75 3.1 Duplicated Code(重复代码) 76 3.2 Long Method(过长函数) 76 3.3 Large Class(过大的类) 78 3.4 Long Parameter List(过长参数列) 78 3.5 Divergent Change(发散式变化) 79 3.6 Shotgun Surgery(霰弹式修改) 80 3.7 Feature Envy(依恋情结) 80 3.8 Data Clumps(数据泥团) 81 3.9 Primitive Obsession(基本类型偏执) 81 3.10 Switch Statements(switch惊悚现身) 82 3.11 Parallel InheritanceHierarchies(平行继承体系) 83 3.12 Lazy Class(冗赘类) 83 3.13 Speculative Generality(夸夸其谈未来性) 83 3.14 Temporary Field(令人迷惑的暂时字段) 84 3.15 Message Chains(过度耦合的消息链) 84 3.16 Middle Man(中间人) 85 3.17 Inappropriate Intimacy(狎昵关系) 85 3.18 Alternative Classes with Different Interfaces(异曲同工的类) 85 3.19 Incomplete Library Class(不完美的库类) 86 3.20 Data Class(纯稚的数据类) 86 3.21 Refused Bequest(被拒绝的遗赠) 87 3.22 Comments(过多的注释) 87 第4章 构筑测试体系 89 4.1 自测试代码的价值 89 4.2 JUnit测试框架 91 4.3 添加更多测试 97 第5章 重构列表 103 5.1 重构的记录格式 103 5.2 寻找引用点 105 5.3 这些重构手法有多成熟 106 第6章 重新组织函数 109 6.1 Extract Method(提炼函数) 110 6.2 Inline Method(内联函数) 117 6.3 Inline Temp(内联临时变量) 119 6.4 Replace Temp with Query(以查询取代临时变量) 120 6.5 Introduce Explaining Variable(引入解释性变量) 124 6.6 Split Temporary Variable(分解临时变量) 128 6.7 Remove Assignments to Parameters(移除对参数的赋值) 131 6.8 Replace Method with Method Object(以函数对象取代函数) 135 6.9 Substitute Algorithm(替换算法) 139 第7章 在对象之间搬移特性 141 7.1 Move Method(搬移函数) 142 7.2 Move Field(搬移字段) 146 7.3 Extract Class(提炼类) 149 7.4 Inline Class(将类内联化) 154 7.5 Hide Delegate(隐藏“委托关系”) 157 7.6 Remove Middle Man(移除中间人) 160 7.7 Introduce Foreign Method(引入外加函数) 162 7.8 Introduce Local Extension(引入本地扩展) 164 第8章 重新组织数据 169 8.1 Self Encapsulate Field(自封装字段) 171 8.2 Replace Data Value with Object(以对象取代数据值) 175 8.3 Change Value to Reference(将值对象改为引用对象) 179 8.4 Change Reference to Value(将引用对象改为值对象) 183 8.5 Replace Array with Object(以对象取代数组) 186 8.6 Duplicate Observed Data(复制“被监视数据”) 189 8.7 Change Unidirectional Association to Bidirectional(将单向关联改为双向关联) 197 8.8 Change Bidirectional Association to Unidirectional(将双向关联改为单向关联) 200 8.9 Replace Magic Number with Symbolic Constant(以字面常量取代魔法数) 204 8.10 Encapsulate Field(封装字段) 206 8.11 Encapsulate Collection(封装集合) 208 8.12 Replace Record with Data Class(以数据类取代记录) 217 8.13 Replace Type Code with Class(以类取代类型码) 218 8.14 Replace Type Code with Subclasses(以子类取代类型码) 223 8.15 Replace Type Code with State/Strategy(以State/Strategy取代类型码) 227 8.16 Replace Subclass with Fields(以字段取代子类) 232 第9章 简化条件表达式 237 9.1 Decompose Conditional(分解条件表达式) 238 9.2 Consolidate Conditional Expression(合并条件表达式) 240 9.3 Consolidate Duplicate Conditional Fragments(合并重复的条件片段) 243 9.4 Remove Control Flag(移除控制标记) 245 9.5 Replace Nested Conditional with Guard Clauses(以卫语句取代嵌套条件表达式) 250 9.6 Replace Conditional with Polymorphism(以多态取代条件表达式) 255 9.7 Introduce Null Object(引入Null对象) 260 9.8 Introduce Assertion(引入断言) 267 第10章 简化函数调用 271 10.1 Rename Method(函数改名) 273 10.2 Add Parameter(添加参数) 275 10.3 Remove Parameter(移除参数) 277 10.4 Separate Query from Modifier(将查询函数和修改函数分离) 279 10.5 Parameterize Method(令函数携带参数) 283 10.6 Replace Parameter with Explicit Methods(以明确函数取代参数) 285 10.7 Preserve Whole Object(保持对象完整) 288 10.8 Replace Parameter with Methods(以函数取代参数) 292 10.9 Introduce Parameter Object(引入参数对象) 295 10.10 Remove Setting Method(移除设值函数) 300 10.11 Hide Method(隐藏函数) 303 10.12 Replace Constructor with Factory Method(以工厂函数取代构造函数) 304 10.13 Encapsulate Downcast(封装向下转型) 308 10.14 Replace Error Code with Exception(以异常取代错误码) 310 10.15 Replace Exception with Test(以测试取代异常) 315 第11章 处理概括关系 319 11.1 Pull Up Field(字段上移) 320 11.2 Pull Up Method(函数上移) 322 11.3 Pull Up Constructor Body(构造函数本体上移) 325 11.4 Push Down Method(函数下移) 328 11.5 Push Down Field(字段下移) 329 11.6 Extract Subclass(提炼子类) 330 11.7 Extract Superclass(提炼超类) 336 11.8 Extract Interface(提炼接口) 341 11.9 Collapse Hierarchy(折叠继承体系) 344 11.10 Form Tem Plate Method(塑造模板函数) 345 11.11 Replace Inheritance with Delegation(以委托取代继承) 352 11.12 Replace Delegation with Inheritance(以继承取代委托) 355 第12章 大型重构 359 12.1 Tease Apart Inheritance(梳理并分解继承体系) 362 12.2 Convert Procedural Design to Objects(将过程化设计转化为对象设计) 368 12.3 Separate Domain from Presentation(将领域和表述/显示分离) 370 12.4 Extract Hierarchy(提炼继承体系) 375 第13章 重构,复用与现实 379 13.1 现实的检验 380 13.2 为什么开发者不愿意重构他们的程序 381 13.3 再论现实的检验 394 13.4 重构的资源和参考资料 394 13.5 从重构联想到软件复用和技术传播 395 13.6 小结 397 13.7 参考文献 397 第14章 重构工具 401 14.1 使用工具进行重构 401 14.2 重构工具的技术标准 403 14.3 重构工具的实用标准 405 14.4 小结 407 第15章 总结 409
直很喜欢重构这本书,但是由于自己记性不太好,书看过之后其中的方法总是记不住,于是想如果有电子版的重构书就好了,工作中遇到重构的问题可以随时打开查阅。在网上搜索了许久,发现重构这本书有英文chm版本的,而中文版的电子书只有扫描的PDF版本,用起来非常不方便。于是萌生想做重构工具书的想法,本来打算自己重新将重构书的内容再整理归类下,后来发现原书的目录编排就很适合做工具书,包括坏味道分类,重构手法归类等,都有了个比较系统的整理。因此,我利用空余时间制作了这样的本中文的chm版重构,希望对大家有所帮助,也算对中国软件业做出点小小的贡献。 本书基本上是取自”重构”中文版书的内容,但格式上参照的是chm英文版的格式,还有些格式小修改,比如第章的重构前后代码对比。因为时间匆促,个人能力有限,本书难免存在些缺漏,如果大家发现有问题,随时可以给我发邮件,我会尽快更新错误的内容。 最后再次感谢几位大师 Martin Fowler、Kent Beck等,还有翻译的侯捷和熊节先生,为我们带来这么精彩的本书。谢谢。 免责声明:本书仅供个人学习研究之用,不得用于任何商业目的,不得以任何方式修改本作品,基于此产生的法律责任本人不承担任何连带责任。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值