代码的坏味道与解决之道.pdf

1Evolve by case Evolve by case Evolve by case Evolve by case 代码的坏味道代码的坏味道内容代码的坏味道概述代码的坏味道概述代码坏味道的分类代码坏味道的分类坏味道解决之道坏味道解决之道-重构技术重构技术2剩饭剩菜的坏味道代码也有味道 坏味道(bad smell),特别是代码坏味道(code smell),是指在代码之中潜在问题的警示信号.并非所有的坏味道所指示的确实是问题,但是对于大多数坏味道,均很有必要加以查看,并做出相应决定 代码坏味道是需要重构的症状。或者潜在的问题（Potential Problem）或者缺陷（Flaw）发现代码坏味道是我们代码评审的主要目的。同时使大家3发现代码味道对的目的 发现代码坏味道是我们代码评审的主要目的，大家在一起来挑错。同时使大家一起来熟悉这些坏味道 同时使大家，在自己设计和开发过程之中，尽量避免出现这些坏味道。生病的症状4中国中医-望 闻 问 切 中医在长期的医疗实践中，总结出了四种论断疾病的方法，这就是望、闻、望、闻、问、切四诊问、切四诊。望诊就是医生运用视觉来观察病人全身或局部的神、色、形、态的变化；闻诊就是医生凭听觉和嗅觉辨别病人的声音和气味的变化；问诊就是医生凭听觉和嗅觉辨别病人的声音和气味的变化；问诊即通过询问病人和家属，了解疾病的发生与发展过程，以及目前症状及其它与疾病有关的情况；切诊包括切脉和按诊，是切按病人的脉搏和触按病人的皮肤、手、腹部、四肢及其它部位以诊断疾病的方法。不同的症状不同的治疗方案治疗的办法治疗的办法(药药/步步骤骤)不治疗的后不治疗的后果果引起的原因引起的原因症状症状5代码坏味道 坏味道（Code Smell）-坏味道名称 症状（Symptoms）-有助于找出问题的线索 原因（Causes）-对问题如何会发生的说明 采取的措施（WhatToDo）-可能的重构 收益（PayOff）-代码在哪些方面有所改善 不适应情况-在哪些情况下不适用的情况随着经验的逐渐积累,提高确诊能力6专家号已售完伟大程序员的标准“我不是什么伟大的程序员，我只是一个有着很多我不是什么伟大的程序员，我只是一个有着很多好习惯的程序员好习惯的程序员”-Kent Beck-Kent Beck语。语。7任重而道远任重而道远 内容 代码的坏味道概述 代码坏味道的分类代码坏味道的分类 坏味道解决之道-重构技术 常见的症状8重构代码坏味道-1 1Duplicated Code 代码重复几乎是最常见的异味了。他也是Refactoring 的主要目标之一。代码重复往往来自于copy-and-paste 的编程风格。与他相对应OAOO 是一个好系统的重要标志（请参见我的duplicated code 一文：http:/www.erptao.org/download.PHP?op=viewsdownload&sid=6）。2Long method 它是传统结构化的“遗毒“。一个方法应当具有自我独立的意图，不要把几个意图放在一起，我的大类和长方法一文中有具体描述。3Large Class 大类就是你把太多的责任交给了一个类。这里的规则是 One Class One Responsibility。4Divergent Change 一个类里面的内容变化率不同。某些状态一个小时变一次，某些则几个月一年才变一次；某些状态因为这方面的原因发生变化，而另一些则因为其他方面的原因变一次。面向对象的抽象就是把相对不变的和相对变化相隔离。把问题变化的一方面和另一方面相隔离。这使得这些相对不变的可以重用。问题变化的每个方面都可以单独重用。这种相异变化的共存使得重用非常困难。9代码坏味道-2 5Shotgun Surgery 这正好和上面相反。对系统一个地方的改变涉及到其他许多地方的相关改变。这些变化率和变化内容相似的状态和行为通常应当放在同一个类中。6Feature Envy 对象的目的就是封装状态以及与这些状态紧密相关的行为。假如一个类的方法频繁用get 方法存取其他类的状态进行计算，那么你要考虑把行为移到涉及状态数目最多的那个类。7Data Clumps 某些数据通常像孩子一样成群玩耍：一起出现在很多类的成员变量中，一起出现在许多方法的参数中.，这些数据或许应该自己独立形成对象。8Primitive Obsession 面向对象的新手通常习惯使用几个原始类型的数据来表示一个概念。譬如对于范围，他们会使用两个数字。对于Money，他们会用一个浮点数来表示。因为你没有使用对象来表达问题中存在的概念，这使得代码变的难以理解，解决问题的难度大大增加。好的习惯是扩充语言所能提供原始类型，用小对象来表示范围、金额、转化率、邮政编码等等。代码坏味道-3 9Switch Statement 基于常量的开关语句是OO 的大敌，你应当把他变为子类、state 或strategy。10 Parallel Inheritance Hierarchies 并行的继续层次是shotgun surgery 的非凡情况。因为当你改变一个层次中的某一个类时，你必须同时改变另外一个层次的并行子类。11 Lazy Class 一个干活不多的类。类的维护需要额外的开销，假如一个类承担了太少的责任，应当消除它。12 Speculative Generality 一个类实现了从未用到的功能和通用性。通常这样的类或方法唯一的用户是testcase。不要犹豫，删除它。13 Temporary Field 一个对象的属性可能只在某些情况下才有意义。这样的代码将难以理解。专门建立一个对象来持有这样的孤儿属性，把只和他相关的行为移到该类。最常见的是一个特定的算法需要某些只有该算法才有用的变量。10代码坏味道-4 14 Message Chain 消息链发生于当一个客户向一个对象要求另一个对象，然后客户又向这另一对象要求另一个对象，再向这另一个对象要求另一个对象，如此如此。这时，你需要隐藏分派。15 Middle Man 对象的基本特性之一就是封装，而你经常会通过分派去实现封装。但是这一步不能走得太远，假如你发现一个类接口的一大半方法都在做分派，你可能需要移去这个中间 人。16 Inappropriate Intimacy 某些类相互之间太亲密，它们花费了太多的时间去砖研别人的私有部分。对人类而言，我们也许不应该太假正经，但我们应当让自己的类严格遵守禁欲主义。17 Alternative Classes with Different Interfaces 做相同事情的方法有不同的函数signature，一致把它们往类层次上移，直至协议一致。18 Incomplete Library Class 要建立一个好的类库非常困难。我们大量的程序工作都基于类库实现。然而，如此广泛而又相异的目标对库构建者提出了苛刻的要求。库构建者也不是万能的。有时候我们会发现库类无法实现我们需要的功能。而直接对库类的修改有非常困难。这时候就需要用各种手段进行Refactoring。19 Data Class 对象包括状态和行为。假如一个类只有状态没有行为，那么肯定有什么地方出问题了。重构 封面3 坏味道以及相关重构技术常用的重构之道坏味道11Refactoring to Patterns代码坏味道的分类12重构手册 类之中的坏味道可度量的坏味道代码命名不必要的复杂性代码重复条件逻辑 类之间的坏味道数据功能职责相关改变库类内容 代码的坏味道概述 代码坏味道的分类 坏味道解决之道坏味道解决之道-重构技术重构技术13何为重构 名词定义:对软件内部结构的一种调整,目的是在不改变功能的前提下,提高其可理解性,降低其修改成本 动词定义:使用一系列重构准则,在不改变软件功能的前提下,调整其结构.重构周期重构周期（Refactoring Cycle）：如果发现代码存在坏味道，则：1.分析代码，挑出最坏的味道2.选择一种可以解决该坏味道的重构3.应用此重构4.验证测试14重构资料