如何实施代码重构?

原创 2016年08月30日 13:48:23

阅读《重构》的笔记献上。

重构的定义

重构是在不改变软件可观察行为的前提下改善其内部结构。

重构的节奏

以微小的步伐修改程序。如果你犯下错误,很容易便可发现它。

  • 一个方法里面,不应该有很多的代码,我们可以通过分解后重组。
  • 好的代码应该清楚的表达出自己的功能,变量名称是代码清晰的关键。
  • 尽量减少临时变量,大量参数被传来传去,很容易跟丢,可读性差。
  • 提炼出逻辑代码,以便功能复用。

重构(名词):对软件内部结构的一种调整,目的是在不改变软件可观察行为的前提下,提高其可理解性,降低其修改成本。
重构(动词):使用一系列重构首发,在不改变软件可观察行为的前提下,调整其结构。

为何重构?

  • 重构改进软件设计
  • 重构是软件更容易理解
  • 重构帮助找到bug
  • 重构提高编程速度

何时重构?

几乎任何情况下我都反对专门拔出时间进行重构。在我看来重构本来就不是一件应该特别拨出时间做的事情,重构应该随时随地的进行。你不应该为重构而重构,你之所以重构,是因为你想做别的什么事,而重构可以帮助你把那些事做好。

三次法则

第一次做某件事只管去做,第二次做类似的事情会有反感,第三次再做类似的事,你就应该重构。
事不过三,三则重构。

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

为什么重构有用?

难以修改的程序

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

好的程序

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

重构是这样一个过程:它在一个目前可运行的程序上进行,在不改变程序行为的前提下使其具备上述美好性质,使我们能够继续保持高速开发,从而新增程序的价值。

何时不该重构?

  • 无法稳定运行直接重写不用重构
  • 项目以及接近最后期限,不应该重构,虽然重构能够提高生产力,但是你没有足够的时间,通常标示你其实早该进行重构了。

代码的坏味道

  • Duplicated Code 重复代码
  • Long Method 过长函数
  • Large Class 过大的类
  • Long Parameter List 过长参数列
  • Divergent Change 发散式变化
  • Shotgun Surgery 散弹式修改
  • Feature Envy 依恋情结 (Strategy\Visitor)
  • Data Clumps 数据泥团
  • Primitive Obsession 基本类型偏执
  • Switch Statements switch惊悚现身 (使用多态性替换)
  • Parallel Inheritance Hierarchies 平行继承体系
  • 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 过多的注释

当你感觉需要撰写注释时,请先尝试重构,试着让所有注释变得多余。

构建测试体系

  • 确保所有测试都完全自动化,让他们检查自己的测试结果。
  • 一套测试就是一个强大的bug侦察器,能够大大缩减查找bug所需要的时间。
  • 频繁地运行测试。每次编译请把测试也考虑进去—— 每天至少执行每个测试一次。
  • 每当你收到bug报告,请先写一个单元测试来暴露这个bug。
  • 编写未完善的测试并执行,好过对完美测试的无尽等待。
  • 考虑可能出错的边界条件,把测试火力集中在那儿。
  • 当事情被认为应该会出错时,别忘了检查是否抛出了预期的异常。
  • 不要因为测试无法捕捉所有bug就不写测试,因为测试可以捕捉到大多数的bug。

重构列表

重构记录格式

  • 名称
  • 概要
    • 描述解决的问题
    • 描述要做的事情
    • 速写图展示重构前和重构后的示例
  • 动机
  • 做法
  • 范例

重构的基本技巧—小步前进、频繁测试

模式和重构之间有着一种与生俱来的关系。模式是你希望到达的目标,重构则是到达之路。

重新组织函数

  • Extract Method 提炼函数
    • 你有一段代码可以被组织在一起并独立出来。将这段代码放进一个独立函数中,并让函数名称解释该函数的用途。
  • Inline Method 内联函数
    • 一个函数,其本体应该与其名称同样清楚易懂。在函数调用点插入函数本体,然后移除该函数。
  • Inline Temp 内联临时变量
    • 你有一个临时变量,只被一个简单表达式赋值一次,而它妨碍了其他重构方法。将所有对该变量的引用动作,替换为对它赋值的那个表达式本身。
  • Replace Temp with Query 已查询取代临时变量
    • 你的程序以一个临时变量(temp)保存某一个表达式的运算结果。将这个表达式提炼到一个独立函数(query查询式)中。将这个临时变量的所有被引用点替换为对新函数的调用。新函数可被其他函数使用。
  • Introduce Explaining Variable 引入解释性变量
    • 你有一个复杂的表达式。将该复杂表达式(或其中一部分)的结果放进一个临时变量,以此变量名称来解释表达式用途。
  • Split Temporary Variable 分解临时变量
    • 你的程序有某个临时变量被赋值超过一次,它既不是循环变量,也不是一个集用临时变量(collecting temporary variable)。针对每次赋值,创造一个独立。对应的临时变量。
  • Remove Assignments to Parameters 移除对参数的赋值
    • 你的代码对一个参数进行赋值动作。以一个临时变量取代该参数的位置。
  • Replace Method with Method Object 以函数对象取代函数
    • 你有一个大型函数,其中对局部变量的使用,使你无法采用Extract Method。将这个函数放在一个独立的对象中,如此一来局部变量就变成了对象内的值域,然后你可以在同一个对象中将这个大型函数分解为数个小型函数。
  • Substitute Algorithm 替换算法
    • 你想要把某个算法替换为另一个更清晰的算法。将函数本体替换为另一个算法。

在对象之间搬移特性

  • Move Method 搬移函数
    • 你的程序中,有个函数与其所驻class之外的另一个class进行更多交流:调用后者,或被后者调用。在函数最常引用的class中建立一个有着类似行为的新函数。将旧函数变成一个单纯的委托函数,或是将旧函数完全移除。
  • Extract Class 提炼类
    • 你的程序中,某个field(值域)被所驻class之外的另一个class更多地用到。在target class 建立一个new field ,修改source field 的所有用户,令它们改用new field.
  • Inline Class 将类内敛化
    • 某个class做了应该由两个classes做的事情。建立一个新的class,将相关的值域和函数从就class搬移到新class。
  • Hide Delegate 隐藏委托类
    • 客户直接调用其server object(服务对象)的delegate class。在sever端(某个class)建立客户所需要的所有函数,用以隐藏委托关系。
  • Remove Middle Man 移除中间人
    • 某个class做了过多的简单委托(simple delegation).让客户直接调用delegate(受托类)。
  • Introduce Foreign Method 引入外加函数
    • 你所使用的server class 需要一个额外函数,但你无法修改这个class。在client class 中建立一个函数,并以一个server class实体作为第一引数(argument)。
  • Introduce Local Extension 引入本地扩展
    • 你所使用的server class 需要一些额外函数,但你无法修改这个class。建立一个新class,使它包含这些额外函数。让这个扩展品成为source class的subclass(子类)或(wrapper)外覆类。

重新组织数据

  • Self Encapsulate Field 自封装字段
    • 你直接访问一个值域(field),但与值域直接的耦合关系变得逐渐变得笨拙。为这个值域建立取值/设值函数,并且只有这些函数来访问值域。
  • Replace Data Value with Object 以对象取代数据值
    • 你有一笔数据项(data item),需要额外的数据和行为。将这笔数据项变成一个对象。
  • Change Value to Reference 将值对象改成引用对象
    • 你有一个class,衍生出许多相等视图(equal instance),你希望将它们替换为单元对象。将这个 value object(实值对象)变成一个reference object(引用对象)。
  • Change Reference to Value 将引用对象改成值对象 (equals hashCode)
    • 你有一个reference object(引用对象),很小且不可变,而且不易管理。将他变成一个value object(实值对象)。
  • Replace Array with Object 以对象取代数组

    • 你有一个数组(array),其中的元素个各自代表不同的东西,以对象替换数组。对于数组中的每个元素,以一个值域表示之。
  • Duplicate Observed Data 复制“被监听数据”

    •  你有一些domain data 置身GUI控件中,而domain method 需要访问之。即那个该笔数据拷贝到以到domain object。建立一个observer模式,用以对domain object和GUI object 内的重复数据进行同步控制(sync).
  • Change Unidirectional Association to Bidirectional 将单向关联改为双向关联

    • 两个classes都需要使用对方特性,但其间只有一条单向连接。添加一个反向指针,并使修改函数能够同时更新两条连接。
  • Change Bidirectional Association to Unidirectional 将双向关联改成单向关联

    • 两个classes之间有双向关联,但其中一个class如今不再需要另一个class的特性。去除不必要的关联(association)。
  • Replace Magic Number with Symbolic Constant 以字面常量取代魔法数

    • 你有一个字面值,带有特别的含义。创造一个常量,根据其意义为它命名,并将上述的字面数值替换为这个常量。
  • Encapsulate Field 封装字段

    • 你的class存在一个public值域。将它声明为private,并提供相应的访问函数。
  • Encapsulate Collection 封装集合

    •  有个函数返回一个群集(collection)。放这个函数返回该群集的一个只读映件,并在这个class中提供添加移除群集元素的函数。
  • Replace Record with Data Class 以数据类取代记录

    • 你需要面对传统编程环境中的record structure(记录结构)。为该record(记录)创建一个哑数据对象(dumb data object)。
  • Replace Type Code with Class 以类取代类型码

    •  class之中有一个数值别码,但他并不影响class的行为。以一个新的class替换数值型别码。
  • Replace Type Code with Subclasses 以子类取代类型码 (多态机制)
    •  你有一个不可变的type code,它会影响class的行为。以一个subclass取代这个type code。
  • Replace Type Code with State/Strategy 以State/Strategy取代类型码
    • 你有一个type code,它会影响class 的行为,但你无法使用subclassing。以state object取代type code.
  • Replace Subclass with Fields 以字段取代子类
    • 你的各个subclasses的唯一差别只在返回常量数据的函数身上。修改这些函数,使他们返回superclass中的某个(新增)值域,然后销毁sublcasses。

简化条件表达式

  • Decompose Conditional 分解条件表达式
    • 你有一个复杂的条件语句。从if、then、else三个段落中分别提出独立函数。
  • Consolidate Conditional Expression 合并条件表达式
    •  你有一系列条件测试,都得到相同结果。将这些测试合并为一个条件式,并将这个条件式提炼成为一个独立函数。
  • Consolidate Duplicate Conditional Fragments 合并重复的条件片段
    • 在条件式的每一个分支上着相同的代码。将这个段重复代码搬移到条件式之外。
  • Remove Control Flag 移除控制标记 (break/continue/return)
    • 在一系列布尔表达式中,某个变量带有控制标记的作用,以break语句或return语句取代控制标记。
  • Replace Nested Conditional with Guard Clauses 以卫语句取代嵌套条件表达式 (单独判断被称为“卫语句”)
    • 函数中的条件逻辑使人难以看清正常的执行路径。使用卫语句表现所有特殊的情况。卫语句就是把复杂的条件表达式拆分成多个条件表达式,比如一个很复杂的表达式,嵌套了好几层的if - then-else语句,转换为多个if语句,实现它的逻辑,这多条的if语句就是卫语句
  • Replace Conditional with Polymorphism 以多态取代条件表达式
    • 你手上有个条件式,它根据对象型别的不同而选择不同的行为。将这个条件式的每个分支放进一个subclass内的覆写函数中,然后将原始函数声明为抽象函数。
  • Introduce Null Object 引入Null对象
    • 你需要再三检查某个是否为null value。将null value(无效值)替换为null object(无效物)
  • Introduce Assertion 引入断言
    • 某一段代码需要对程序状态做出某种假设。以assertion(断言)明确表现这种假设。

简化函数调用

  • Rename Method 函数改名
    • 函数的名称未能揭示函数的用途,修改函数名称。
  • Add Parameter 添加参数
    • 某个函数需要从调用端得到更多信息。为此函数添加一个对象参数,让该对象带进函数所需信息。
  • Remove Parameter 移除参数
    • 函数本体不再需要某个参数,将该参数去除。
  • Separate Query from Modifier 讲查询函数和修改函数分离
    • 某个函数即返回函数对象状态值,又修改对象状态。将来两个不同的函数,其中一个负责查询,另一个负责修改。
  • Parameterize Method 令函数携带参数
    • 若干函数做了类似的工作,但在函数本体中却包含了不同的值。建立单一函数,以参数表达那些不同的值。
  • Replace Parameter with Explicit Methods 以明确函数取代参数
    • 你有一个函数,其内完全取决于参数值而采取不同反应。针对该参数的每一个可能值,建立一个独立函数。
  • Preserve Whole Object 保持对象完整
    •  你从某个对象中取出某个值,将它们作为某一次函数调用的参数。该引用(传递)整个对象。
  • Replace Parameter with Methods 以函数取代参数
    • 对象调用某个函数,并将所得结果作为参数,传递给另一个函数。而接受该参数的函数也可以调用前一个函数。让参数接受者去除该项参数,并直接调用前一个函数。
  • Introduce Parameter Object 引入参数对象
    • 某个参数总是很自然地同时出现。以一个对象取代这些参数。
  • Remove Setting Method 移除设置函数
    • 你的class中的某个值域,应该在对象初创时被设值,然后就不再改变。去掉该值域的所有设置函数。
  • Hide Method 隐藏函数
    • 有一个函数,从来没有被其他任何class用到。将这个函数改为private。
  • Replace Constructor with Factory Method 以工厂函数取代构造函数
    • 你希望在创建对象时不仅仅是对它做简单的构建工作,将construcotr(构造函数)替换为factory method(工厂函数)
  • Encapsulate Downcast 封装向下转型
    • 某个函数返回的对象,需要由函数调用者执行向下转型动作。将向下转型动作移到函数中。
  • Replace Error Code with Exception 以异常取代错误码
    • 某个函数返回一个特定的代码,用以表示某种错误情况。改用异常。
  • Replace Exception with Test 以测试取代异常
    • 面对一个调用者可预先加以检查的条件,你抛出一个异常。修改调用者,使它在调用函数之前先做检查。

处理概括关系

  • Pull Up Field 字段上移
    • 两个subclass拥有相同的值域。将此一值域移至superclass。
  • Pull Up Method 函数上移
    • 有些函数,在各个subclass中产生完全相同的效果。将该函数移至superclass。
  • Pull Up Constructor Body 构造函数本体上移
    • 你的各个subclass中拥有一些构造函数,它们的本体几乎完全一致。在superclass中新建一个构造函数,并在subclass构造函数中调用它。
  • Push Down Method 函数下移
    • superclass中的某个函数只与部分(而非全部)subclass有关。将这个函数移到相关的那些subclasses去。
  • Push Down Field 字段下移
    • superclass中的某个值域只被部分subclass用到。将这个值域到需要它的那些subclasses去。
  • Extract Subclass 提炼子类
    • class中某些特性只被某些而非全部实体用到。新建一个subclass,将上面所说的那一部分特性移到subclass中。
  • Extract Superclass 提炼超类
    • 两个classes有相似特性。为这连个classes建立一个superclass.将相同特性移至superclass.
  • Extract Interface 提炼接口
    • 若干客户使用class接口中的同一子集。或者,两个Classes的接口有部分相同。将相同的子集提炼到一个独立接口中。
  • Collapse Hierarchy 折叠继承体系
    • superclass和subclass之间无太大区别。将它们和为一体。
  • Form Template Method 塑造模板函数
    • 有一些subclasses,其中相应的某些函数以相同顺序执行类似的措施,但各措施实际上有所不同。将各个措施分别放进独立函数中,并保持它们都有相同的签名式,于是原函数也就变得相同了。然后将原函数上移至superclass。
  • Replace Inheritance with Delegation 以委托取代继承
    • 某个subclass只使用superclass接口中的一部分,或是更本不需要继承而来的数据。在subclass中新建一个值域用以保存superclass;调整subclass函数,令它改而委托superclass;然后去掉两者之间的继承关系。
  • Replace Delegation with Inheritance 以继承取代委托
    • 你的两个classes之间使用了委托关系,并经常为整个接口编写许多极其简单的请托函数。让请托Class继承受托class。

大型重构

  • Tease Apart Inheritance 梳理并分解继承体系
    • 某个继承体系同时承担两项责任。建立两个继承体系,并通过委托关系让其中一个可以调用另一个。
  • Convert Procedural Design to Objects 将过程化设计转化为对象设计
    • 你手上有一些代码,以传统的过程化风格写就。将数据记录变成对象,将行为分开,并将行为移入相关对象中。
  • Separate Domain from Presentation 将领域和表述/显示分离
    • 某些GUI classes之中包含了domain login(领域逻辑)。将domain loginc(领域逻辑)分离出来,为它们建立独立的domain classes.
  • Extract Hierarchy 提炼继承体系
    • 你有某个class做了太多工作,其中一个部分工作以大量条件式完成的。建立继承体系,以一个subclass表示一种特殊情况。
版权声明:本文为博主原创文章,未经博主允许不得转载。 公众号:码个蛋

相关文章推荐

为什么要重构&如何实施代码重构?

代码重构简介:(英语:Code refactoring)重构就是在不改变软件系统外部行为的前提下,改善它的内部结构。 为什么要重构(Refactoring)??? 为什么要这么做?投入精力...

Android 混淆代码 原理与实施

Android 混淆代码 原理与实施 目录  [隐藏]  1 proguard 原理2 proguard 配置3 proguard 问题和...

C#代码规范实施

  • 2017-02-17 14:38
  • 24KB
  • 下载

《重构-改善既有代码的设计》-第1例:租赁影片(2)

2  运用多态取代与价格相关的条件逻辑 2.1 最好不要在另一个对象的属性基础上运用switch语句,应该在对象自己的数据上使用。 2.1.1 移动 getCharge 方法到Movie 类中去。...

代码重构的技巧

代码重构的要点

重构 改善既有代码的设计——在对象之间搬移特性

在面向对象的设计过程中,“决定把责任放到哪”即使不是最重要的事情,也是最重要的事之一。 一.Move Method(搬移函数) 你的程序中,有个函数与其所驻类之外的另一个类有更多的交流:调用后者或被后...

【转载】代码重构与灵活交付

百度技术沙龙第56期回顾:代码重构与灵活交付(含资料下载) 作者 黄丹 发布于 2014年11月18日 | 讨论 2014年11月15日,由@百度主办、@InfoQ负责策划组织和实...

重构-改善既有代码的设计读书笔记(九)

简化条件表达式9.5 Replace Nested Conditional with Guard Clauses(以卫语句取代嵌套条件表达式)函数中的条件逻辑使人难以看清正常的执行路径。使用卫语句表现...

spark 代码重构

package com.lhj.www import org.apache.spark.{SparkContext, SparkConf} object Test { def main(ar...

改善代码设计-重构

这几天我的任务把某一长方法进行提取函数,使其代码更简短,更好理解,更好修改!      其实这些吧,专业术语叫做代码重构!        针对局部代码的重构是比较简单的,不过需要注意的地方是,你一...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:深度学习:神经网络中的前向传播和反向传播算法推导
举报原因:
原因补充:

(最多只允许输入30个字)