重构-改善既有代码的设计精华摘录

《重构-改善既有代码的设计》对于程序开发者来说是一本好书,其中重构的思想对我们改善程序代码的质量很有帮助,除此之外书中还有很多中肯的编程建议,非常感谢作者和重构课题相关科研人员的慷慨馈赠,也希望大家能认真对待这篇文章。

第1章 重构,第一个案例

1、差劲的系统是很难修改的,因为很难找到修改点。如果很难找到修改点,程序员就可能犯错,从而引入bug。
2、你心里牢牢记着那句古老的工程谚语:“如果它没坏,就不要动它。”这个程序也许还没坏掉,但它造成了伤害。它让你生活比较难过,因为你发现很难完成客户所需的修改。这时候,重构技术就该隆重登场了。
3、测试过程中很重要的一部分,就是测试程序对于结果的报告方式。它们要么说“OK”,表示所有新字符串都和参考字符串一样,要么就列出失败清单,显示问题字符串出现的行号。这些测试都能够自我检验。是的,你必须让测试有能力自我检验,否则就得耗费大把时间来回对比,这会降低你的开发速度。
4、任何一个傻瓜都能写出计算机可以理解的代码,唯有写出人类容易理解的代码,才是优秀的程序员。
5、代码应该表现自己的目的,这一点很重要。阅读代码的时候我经常进行重构,这样随着对程序的理解逐渐加深,我也就不断地把这些理解嵌入到代码中和,这么一来才不会遗忘我曾经理解的东西。
6、绝大多数情况下,函数应该放在他所使用的数据的所属对象内。
7、任何不会被修改的变量都可以被我当成参数传入新的函数,至于会被修改的变量就要格外小心。如果只有一个变量会被修改,我可以把它当做返回值。

待解决问题:
Replace Temp with Query是一种很好的去除临时变量的方法,不过去除临时变量也需付出性能上的代价,例如本例的费用就被计算了两次。但是很容易在Rental类中被优化。如何进行优化呢?

第2章 重构的原则

1、重构定义扩展
首先,重构的目的是使软件更容易被理解和修改。与之形成对比的是性能优化,和重构一样,性能优化通常不会改变组件的行为(除了执行速度),只会改变其内部结构。但是两者的出发点不同:性能优化往往使代码较难理解,但是为了得到所需的性能你不得不那么做。
其次,重构不会改变软件可观察的行为——重构之后软件功能一如既往。任何用户,不论是最终用户或其他程序员,都不知道已经有东西发生了变化。
2、完全相同的一件事,设计不良的程序往往需要更多的代码,这常常是因为代码在不同的地方使用完全相同的语句做同样的事,你在这做了点修改,系统却不如期那样工作,是因为你没有修改另一处——那的代码做着几乎完全一样的事情,只是所处的环境略有不同。如果消除重复代码,你就可以确定所有事物和行为在代码中只表述一次,这正是优秀设计的根本。因此改进设计的一个重要方向就是消除重复代码。
3、重构不是一件应该特别拨出时间做的事情,重构应该随时地进行。你不应该为重构而重构,你之所以重构,是因为你想做别的什么事,而重构可以帮你把那事做好。
4、事不过三,三则重构。
5、重构可以帮助自己理解不熟悉的代码和软件。
6、是什么让程序如此难以相与?眼下我能想起下述四个原因,它们是:

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

因此,我们希望程序:
(1)容易阅读
(2)所有逻辑都只在唯一地点指定
(3)新的改动不会危及现有行为
(4)尽可能简单表达条件逻辑。
7、如果重构手法改变了已发布接口,你必须同时维护新旧两个接口,让旧接口调用新接口,直到所有用户都有时间对这个变化做出反应。当你要修改某个函数名称时,请留下旧函数,让他调用新函数。千万不要复制函数实现,那会让你陷入重复代码的泥淖中难以自拔。
8、虽然重构可能使软件运行更慢,但它也使软件的性能更容易优化。除了对性能有严格要求的实时系统,其他任何情况下“编写高性能软件”的秘密就是:首先写出可调的软件,然后调整它以求获得足够的速度。
9、关于性能,一件很有趣的事情就是:如果你对大多数程序进行分析,就会发现它把大半时间都耗费在一小半代码身上。如果你一视同仁地优化所有代码,90%的优化工作都是白费劲的,因为你的优化很少执行。所以在性能优化期间,你首先应该用一个度量工具来监控程序的运行,让他告诉你程序中哪些地方大量耗费时间和空间。这样你就可以找出性能热点所在的一小段代码,并使用持续关注法中的优化手段来优化他们。由于你把注意力都集中在热点上,较少的工作便可显现较好的成果。

第3章 代码的坏味道

1、每当感觉需要用注释来说明点什么的时候,我们就把需要说明的东西写进一个独立函数中,并以其用途(而非实现手法)命名。我们可以对一组甚至短短一行代码做这件事。哪怕替换后的函数调用动作比函数自身还长,只要函数名称能够解释其用途,我们也该毫不犹豫地这么做。关键不在于函数的长度,而在于函数“做什么”和“如何做”之间的语义距离。
2、条件表达式和循环常常也是提炼的信号,你可以使用Decompose Conditional处理条件表达式。至于循环,你应该将循环和其内部代码提炼到一个独立函数中。
3、如果向已有的对象发出一条请求就可以取代一个参数,那么你应该激活重构手法Replace Parameter with Method。在这里,“已有的对象”可能是函数所属类内的一个字段,也可能是另一个参数。你还可以运用Preserve Whole Object将来自同一对象的一堆数据收集起来,并以该对象替换他们。如果某些数据缺乏合理的对象归属,可使用Introduce Parameter Object为他们制造一个“参数对象”。
4、Divergent Change是指“一个类受多种变化的影响”,Shotgun Surgery是指“一种变化引发多个类相应修改”。这两种情况下你都会希望整理代码,使“外界变化”与“需要修改的类”趋于一一对应。
5、对象技术的全部要点在于:这是一种“将数据和对数据的操作行为包装在一起”的技术,有一种经典的气味是:函数对某个类的兴趣高于对自己所处的类的兴趣。当然一个函数往往会用到几个类的功能,那么他究竟该被置于何处呢?我们的原则是:判断哪个类拥有最多被此函数使用的数据,然后就把这个函数和那些数据放在一起。最根本的原则是:将总是一起变化的东西放在一起,数据和引用这些数据的行为总是一起变化的。
6、Data Class(数据实体类)就像小孩子。作为一个起点很好,但若要让他们像成熟的对象那样参与整个系统的工作,他们就必须承担一定责任。

第4章 构筑测试体系

1、一旦功能测试者或最终用户找到软件中的bug,要除掉它至少需要做两件事。当然你必须修改代码,才得以排除错误,但你还应该添加一个单元测试,用来暴露这个bug。
2、测试的要诀是:测试你担心出错的部分,这样你就能从测试工作中得到最大利益。
3、考虑可能出错的边界条件,把测试火力集中在那。“寻找边界条件”也包括寻找特殊的、可能导致失败的情况。对于文件相关的测试,空文件是一个不错的边界条件。

第5章 重构列表

1、重构的基本技巧——小步前进、频繁测试已经得到多年的实践检验,特别是在Smalltalk社群中。所以,我敢保证,重构的这些基础思想是非常可靠的。
2、许多重构手法都涉及向系统引入设计模式,正如GoF的经典著作所说:“设计模式……为重构行为提供了目标。”模式和重构之间有着一种与生俱来的关系。模式是你希望达到的目标,重构则是到达之路。

  • 3
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 2
    评论
一直很喜欢重构这本书,但是由于自己记性不太好,书看过之后其中的方法总是记不住,于是想如果有电子版的重构书就好了,工作中遇到重构的问题可以随时打开查阅。在网上搜索了许久,发现重构这本书有英文chm版本的,而中文版的电子书只有扫描的PDF版本,用起来非常不方便。于是萌生想做一本重构工具书的想法,本来打算自己重新将重构书的内容再整理归类一下,后来发现原书的目录编排就很适合做工具书,包括坏味道分类,重构手法归类等,都有了一个比较系统的整理。因此,我利用空余时间制作了这样的一本中文的chm版重构,希望对大家有所帮助,也算对中国软件业做出一点小小的贡献。 本书基本上是取自”重构”中文版一书的内容,但格式上参照的是chm英文版的格式,还有一些格式小修改,比如第一章的重构前后代码对比。因为时间匆促,个人能力有限,本书难免存在一些缺漏,如果大家发现有问题,随时可以给我发邮件,我会尽快更新错误的内容。 最后再次感谢几位大师 Martin Fowler、Kent Beck等,还有翻译的侯捷和熊节先生,为我们带来这么精彩的一本书。谢谢。 免责声明:本书仅供个人学习研究之用,不得用于任何商业目的,不得以任何方式修改本作品,基于此产生的法律责任本人不承担任何连带责任。
第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
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

changuncle

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值