《重构:改善既有代码的设计》读书笔记

  如果一个人没有听说过《重构》这本书,那么他一定不敢说自己是程序员;如果一个人没有阅读过《重构》这本书,那么很难想象他会是一名优秀的程序员。这本书是很多公司要求Java程序员必读的三本书之一(另外两本书是《Java编程思想》和《Effective Java》),其实无关编程语言,是程序员就能够从这本书中受益。
  何谓重构?重构是对软件内部结构的一种调整,目的是在不改变软件可观察行为的前提下,提高其可理解性,降低修改成本。重构是用微小的步伐修改程序,在这个过程中也能够很容易的发现程序中的错误。重构的时机可以是添加功能时,也可以是修补错误时,还可以是复审代码时。重构的目标是让代码容易阅读、所有逻辑都在唯一地点指定、新的改动不会危及现有行为、尽可能简单的表达逻辑。
  这本书我个人最喜欢的第三章 - “代码的坏味道”,因为我喜欢在写完代码后去思考我的代码中有没有这些坏味道,然后再去想一想应该如何重构代码。这本书的作者是世界级的软件开发大师Martin Fowler,他也被誉为软件开发“教父”,同时他还是敏捷开发的创始人之一。Martin Fowler编写了很多极好的书籍,包括《企业应用架构模式》、《领域特定语言》、《NoSQL精粹》、《分析模式:可重用对象模型》等。Martin Fowler给出的代码的坏味道包括:
- Duplicated Code(重复代码):“代码有很多中坏味道,重复是最坏的一种”,这句话我经常讲给自己的学生听,但是他们真正领悟并践行这句话的人却不多。一个类中的两个方法有重复代码,那么一定可以通过抽取方法的方式将重复代码放到另一个方法中以供调用;两个互为兄弟的子类中如果有重复代码可以将其重复代码抽取到父类中;两个没有关系的类中如果有重复代码,那么可以重新抽取一个类将重复代码放到这个第三方类中。
- Long Method(长的方法):程序越长理解起来就越困难,这已经是常识了,使用短小的方法首先符合高内聚的要求,同时也可以给通过给方法起一个好的名字来帮助理解方法的作用。如果感觉到方法的某个地方需要注释来说明什么,那么可以把这些东西放入一个独立的方法中,并以用途(注意不是实现手法)来命名方法。
- Large Class(巨大的类):如果希望写一个类来做很多的事情,那么最终势必导致重复和混乱的代码。类的设计应当遵循单一职责原则(SRP)。重构一个巨大的类可以使用抽取接口的方式来搞清楚这个类应该如何分解。
- Long Parameter List(长参数列表):这个对于做过Windows编程或者用过MFC(Microsoft Foundation Class)的程序员来说再熟悉不过了,Windows函数和MFC中的方法那些长得变态的参数列表对程序员来说都是恶梦。重构的方式很多,比较常见的是将相关的参数组织成一个对象来替换掉这些参数。
- Divergent Change(分散的可变性)和Shotgun Surgery(散弹式手术):这两种坏味道前者讲的是新功能难以加入,后者说的是某种变化会引发多个细节的修改。简单的说如果程序中的可变因素散落在代码的各个角落中,那么代码的维护将是一场恶梦。重构的方法是找到特定原因造成的所有变化,然后将它们抽取到另一个类中。设计模式中的桥梁模式就是为了解决这一问题而提供的解决方案。
- Feature Envy:这个真没想到如何翻译会比较容易理解,简单的说就是一个方法从另一个类的对象那里获取许多的值,重构的方案是将该方法移到另一个类中。听起来很简单,但是在实践的时候却经常会忘了这么做。
- Data Clumps(数据群集):状况类似于长参数列表。
- Primitive Obsession(基本类型偏执)。一个类中如果有很多基本类型的成员,通常可以考虑将不同的基本类型分散组装成对象,就像Hibernate中的组合映射那样,将一个类的对象嵌入到另一个类中作为其成员而不是只写一个类,里面有很多基本数据类型的成员。
- Switch Statements(重复的switch语句):面向对象程序的一个明显特征就是用多态替换掉switch结构,因为这种switch结构会在多个地方重复。
- Parallel Inheritance Hierarchies(平行继承结构):情况跟Shortgun Surgery差不多,可以使用桥梁模式进行重构。
- Lazy Class(冗余类):如果一个类不值得存在,那么它就应该消失。
- Speculative Generality(投机通用性):如果你的抽象类、委托、方法的参数没有实际的作用,那么就应当被移除掉。
- Temporary Field(临时字段):类中某个字段只为某些特殊情况而设置。
- Message Chains(消息链):我个人并没有感觉到这个有多么坏。
- Middle Man(中间人):如果一个类的很多功能都通过委托给其他类来完成,那么就不如去掉这些中间人直接和真正负责的对象打交道。
- Inappropriate Intimacy(过于亲密):使用继承复用代码会经常性的引发这种问题,因为子类对父类的了解总是超过后者的主观愿望,如果你觉得这个孩子可以独立生活了,就应该让它离开继承体系,这一点跟面向对象设计原则中的合成聚合复用原则不谋而合。
- Alternative Classes with Different Interfaces(异曲同工):两个方法做同一件事情却有着不同的签名。
- Incomplete Library Class(不完整类库)。
- Data Class(数据类):类的退化结构。我们在分层开发中经常使用的失血模型(事务脚本模式)中的业务实体不就是数据类吗,这明显与面向对象的思想是背道而驰的。
- Refused Bequest(拒绝遗产):如果子类复用了父类的行为,又不愿意支持父类的接口,可以考虑用合成关系聚合关系取代继承关系来消除这种坏味道。
- Comments(注释劣质代码):注释不是用来补救劣质代码的,事实上如果我们去除了代码中的所有坏味道,当劣质代码都被移除的时候,注释已经变得多余,因为代码已经讲清楚了一切。

  彻底根除代码中这些坏味道的方法在《重构》一书的第六章到第十二章,提供了约70条重构建议,其中一部分常用的重构建议在IDE的重构菜单中也能找到。Eclipse和IntelliJ的重构菜单分别如下面两张图所示。
Eclipse的重构菜单:
这里写图片描述
IntelliJ的重构菜单:
这里写图片描述

第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等,还有翻译的侯捷和熊节先生,为我们带来这么精彩的一本书。谢谢。 免责声明:本书仅供个人学习研究之用,不得用于任何商业目的,不得以任何方式修改本作品,基于此产生的法律责任本人不承担任何连带责任。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值