《重构-改善既有代码的设计》读书笔记&心得体会

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

        （动词）使用一系列重构手法，在不改变软件可观察行为的前提下，调整其结构

          重构的目的是使软件更容易被理解和修改

重构就是在代码写好之后改进它的设计

 

如果你发现自己需要为程序添加一个特性，而代码结构使你无法很方便地达成目的，那就先重构那个程序，使特性的添加比较容易进行，然后再添加特性

重构之前，首先检查自己是否有一套可靠的测试机制。这些测试必须有自我检验能力

重构技术就是以微小的步伐修改程序。如果你犯下错误，很容易便可发现他

任何一个傻瓜都能写出计算机可以理解的代码。唯有写出人类容易理解的代码，才是优秀的程序员。（修改变量名、方法名等提高可读性，代码应该体现目的）

// 绝大多数情况下，函数应该放在它使用的数据的所属对象内。

 

何时重构

三次法则：第一次做某件事时只管去做；第二次做类似的事时会产生反感；第三次再做类似的事，就需要重构

添加功能时需要重构：帮助理解需要修改的代码

修补错误时重构：提高代码可读性

复审代码时重构：改善开发状况

 

不要过早发布接口，请修改你的代码所有权政策，使重构更顺畅

 

编写快速软件：首先写出可调软件，然后调整它以获得足够速度

 

坏味道：

duplicated code（重复代码）

long method（过长函数）：如果函数需要注释来说明，那么需要把说明内容写成一个函数，并用函数名说明用途

large class（过大的类）

long parameter list（过长参数）：使用对象代替参数

divergent change（发散式变化）：某个类经常因为不同的原因在不同的方向上发生变化。一个类受多种变化的影响

shotgun surgery（霰弹式修改）：遇到某种变化，必须在许多不同的类中做出许多小修改。一种变化引发多个类进行修改

feature envy(依恋情结):函数对于某个类的兴趣高于自己所处类的兴趣。解决：将总是一起变化的东西放一块，保持变化在一地发生。

data clumps(数据泥团)：两个类中相同的字段、许多函数签名中相同的参数，总是绑定在一起出现的数据应当拥有数据它们自己的对象。删掉其中一个数据项，其他数据若无意义，需要新建对象

primitive obssession（基本类型偏执）：结构类型允许你将数据组织成有意义的形式，基本类型则是构成结构类型的积木块。对象的价值在于，它们模糊（打破）了横亘与基本数据和体积较大的类之间的界限

switch statments：少用switch，应使用多态替换它

parallel inheritance hierarchies（平行继承体系）：为某个类增加一个子类，另一个类也相应增加一个子类。

lazy class（冗赘类）：无用的类予以消除

sepculative 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

 

 

重新组织函数

extract method（提炼函数）：将一段代码放进一个独立函数中，并让函数名称解释该函数的用途（做什么的）。

    注意点：被提炼代码是否改变了某局部变量的值，若改变则考虑将被提炼代码处理为一个查询（query，将被提炼代码的目标函数的返回值赋给该临时变量）

 

inline method（内联函数）：在函数调用点插入函数背题，然后移除该函数

    适用点：函数比较短，直接使用代码更清晰；多个函数内联成一个大的函数，再组织精炼成小的函数

inline temp（内联临时变量）：将所有对该变量的引用动作，替换为对他赋值的那个表达式本身。少定义临时变量

replace temp with query（以查询取代临时变量）：将这个表达式提炼到一个独立函数中，将这个临时变量的所有引用点替换为对新函数的调用。此后，新函数就可以被其他函数使用。

introduce explaning variable（引入解释性变量）：将复杂表达式（或其中一部分）的结果放进一个临时变量，以此变量名称来借试表达式用途

split temporary variable（分解临时变量）：某个临时变量被赋值超过一次，既不是循环变量，也不被用于收集计算结果。针对每一次赋值，创造一个独立、对应的临时变量。

remove assignments to parameters（移除对参数的赋值）：以一个临时变量取代该参数的位置，提高可读性，尽量避免参数被赋值、修改等含混

replace method with method object（以函数对象取代函数）：将这个函数放进一个单独对象中，如此一来局部变量就成了对象内的字段。然后你可以在同一个对象中将这个大型函数分解为多个小型函数。

                                                                                                // 将所有局部变量都变成函数对象的字段，然后可以对这个新对象使用extract method创造出新的函数，从而将原本的大函数拆解（extract method）

substitute algorithm（替换算法）：将函数本体替换为另一个算法 // 使用一个新的算法来优化现有的算法逻辑

move method（搬移函数）：程序中有个函数与其所在类外的另一个类进行更多交流，调用后者或者被后者调用。在该函数最常引用类中建立一个有着类似行为的新函数。将旧函数编程一个单纯的委托函数，或者将旧函数完全移除。

move field（搬移字段）：程序中某个字段被其所在类之外的另外一个类更多的用到。在目标类新建一个字段，其他使用该字段的场景改用新字段

extract class(提炼类)：某个类做了应该由两个类做的事。建立一个新类，将相关的字段和函数从旧类搬移到新类。// 一个类应该是一个清楚的抽象，处理一些明确的责任。

inline class（将类内联化）：某个类没有做太多事情。将这个类的所有特性搬移到另一个类中， 然后移除源类。

hide delegate（隐藏“委托关系”）：客户通过一个委托类来调用另一个对象。在服务类上建立客户所需的所有函数，用以隐藏委托关系。利用封装，少用public

remove middle man（移除中间人）：某个类做了过多的简单委托动作。让客户直接调用受托类。

introduce foreign method（引入外加函数）：需要为提供服务的类增加一个函数，但无法修改这个类。在客户类中建立一个函数，并以第一参数的形式传入一个服务类实例

introduce local extension（引入本地扩展）：需要为服务类提供一些额外函数，但无法修改这个类。建立一个类，使它包含这些额外函数。让这个扩展品成为源类的子类（subclass）或包装类（wrap）。

 

重新组织数据

// 面向对象语言有一个很有用的特征，除了允许使用传统语言提供的简单数据类型，他们还允许你定义新类型。

self encapsulate field（自封装字段）：可直接访问一个字段，但与字段之间的耦合关系逐渐变得笨拙。为这个字段设立取值/设值函数，并且只以这些函数来访问字段。    

                                    // 间接访问变量的好处：子类可以通过覆写一个函数而改变获取数据的方式；延迟初始化

                                    // 直接访问大好处：代码易读

replace data value with object（以对象取代数据值）：有一个数据项，需要与其他数据和行为一起使用才有意义。将数据项变为对象

change value to reference（将值对象改为引用对象）：从一个类中衍生出许多彼此相等的实例，希望将他们替换为同一个对象。 将这个值对象变成引用对象。

                                            // 引用对象：代表真实世界的一个实物；值对象：完全由其所含的数据值来定义，应该是不可变的。

change reference to value(将引用对象改为值对象)：有一个引用对象，很小且不可变，且不易管理。将它变成一个值对象。

change array with object（以对象取代数组）：数组中的各元素代表不同的东西。以对象替换数组，数组中的每个元素，以一个字段来表示。

duplicate observed data（复制“被监视数据”）：有一些领域数据置身于GUI控件中，而领域函数需要访问这些数据。将该数据复制到一个领域对象中。建立一个observer模式，用以同步领域对象和gui对象内的重复数据

change unidirectional assocaition to bidirectional（将单向关联改为双向关联）：两个类都需要使用对方特性，但其间只有一条单向连接。添加一个反向指针，并使修改函数能够同时更新两条连接

change bidirectional association to unidirectional（将双向关联改为单向关联）：两个类之间有双向关联，但其中一个类如今不再需要另一个类的特性。去除不必要的关联。

replace magic number with symbolic constant（以字面常量取代魔法数）：你有一个字面数值，带有特别含义。创造一个常量，根据其意义为它命名，并将上述的字面数值替换为这个常量。

encapsulate field（封装字段）：你的类中存在一个public字段。将它声明为private，并提供相应的访问函数

encapsulate collection（封装集合）：有个函数返回一个集合。让这个函数返回该集和的一个只读副本，并在这个类中提供添加/移除集合元素的函数。

replace record with data class（以数据类取代记录）：你需要面对传统编程环境中的记录结构。为该记录创建一个“哑”数据对象。

replace type code with class（以类取代类型码）：类之中有一个数值类型码，但它并不影响类的行为。以一个新的类替换该数值类型码。

replace type code with subclasses（以子类取代类型码）：你有一个不可变的类型码，它会影响类的行为。以子类取代这个类型码。//以类型码的宿主类为积累，针对每种类型码建立相应的子类

replace type code with state/strategy（以state/strategy取代类型码）：你有一个类型码，他会影响类的行为，但你无法通过继承手段消除它。以状态对象取代类型码。

replace subclass with fields（以字段取代子类）：你的各个子类的唯一差别只在“返回常量数据”的函数身上。修改这些函数，是他们返回超类中的某个（新增）字段，然后销毁子类。

 

简化条件表达式

decompose conditional（分解条件表达式）：你有一个复杂的条件（if-then-else）语句。从if、then、else三个段落中分别提炼出独立函数

consolidate conditional expression（合并条件表达式）：你有一系列条件测试，都得到相同结果。将这些测试合并为一个条件表达式，并将这些条件表达式提炼成一个独立函数

consolidate duplicate conditional fragments（合并重复的条件片段）：在条件表达式的每个分支上有着相同的一段代码。将这段重复代码搬移到条件表达式之外。

remove control flag（移除控制标记）：在一系列布尔表达式中，某个变量带有“控制标记”的作用。以break或return取代控制标记。

replace nested conditional with guard clauses（以卫语句取代嵌套条件表达式）：函数中的条件逻辑试人难以看清正常的执行路径。使用卫语句表现所有特殊情况。// 某条件极其罕见，应单独检查该条件，并在该条件为真时立即从函数中返回，这种单独检查语句成为“卫语句”。

                                                                // 精髓：给某一条分支以特别的重视。卫语句要么就从函数中返回，要么就抛出异常

replace conditional with polymorphism（以多态取代条件表达式）：你手上有个条件表达式，它根据对象类型的不同而选择不同的行为。将这个条件表达式的每个分支放进一个子类内的覆写函数中，然后将原始函数声明为抽象函数。

introduce null object（引入Null对象）你需要再三检查某对象是否为null。将null值替换为null对象

introduce assertion（引入断言）某一段代码需要对程序状态做出某种假设。以断言明确表现这种假设。// 在交付时，断言一般都会被删除。// 断言的价值：帮助理解代码正确运行的必要条件

 

简化函数调用

 

rename method（函数改名）函数的名称未能揭示函数的用途。修改函数名称。// 可以考虑将复杂的处理过程分解成小函数。然后考虑给这个函数添加注释，最后想办法将注释编程函数名。

add parameter（添加参数）某个函数需要从调用端得到更多信息，为此函数添加一个对象参数，让该对象带进函数所需信息。// 一般不建议使用

remove parameter（移除参数）函数本体不再需要某个参数。将该参数去除。 // 无用的参数尽量去除掉，避免增加阅读难度

separate query from modifier（将查询函数和修改函数分离）某个函数既返回对象状态值，又修改对象状态。建立两个不同的函数，其中一个负责查询，另一个负责修改。//任何有返回值的函数，都不应该有看得到的副作用。

parameterize method（令函数携带参数）若干函数做了类似的工作，但在函数本题中却包含了不同的值。建立单一函数，以参数表达那些不同的值。//多个函数做着类似的工作，因少数几个值致行为略有不同。使用参数来处理变化，用以简化问题。

replace parameter with explict methods（以明确函数取代参数）你有一个函数，其中完全取决于参数值而采取不同行为。针对该参数的每一个可能值，建立一个独立函数。// 与parameterize method相反。

preserve whole object（保持对象完整）你从某个对象中取出若干值，将他们作为某一个函数调用时的参数。改为传递整个对象。// 函数未来可能需要某对象的其他值，传对象可避免大的修改。问题在与传对象与传值的取舍，传值更简单直接。

replace parameter with methods（以函数取代参数）对象调用某个函数，并将所得结果作为参数传递给另一个函数，而接收该参数的函数本身也能够调用前一个函数。让参数接收者取初该项参数，并直接调用前一个函数。

                                                        // 如果函数可以通过其他途径获取参数值，就不应该通过参数获取该值。 // 将参数的计算过程移入函数内部，再进行更进一步的重构。

introduce parameter object（引入参数对象）某些参数总是很自然的同时出现。以一个对象取代这些参数。// data clumps（数据泥团），一组参数总是被一起作为参数传递。使用对象取代这些参数项，缩短参数列。

                                                        // 用一对值表时一个范围，使用Range模式，使用范围对象来取代这对值。

remove setting method（移除设值函数）类中的某个字段应该在对象创建时被设值，然后就不再改变。去掉字段的所有设值函数。//拥有设值函数的字段是可修改的，若不希望修改则不需要设值函数并设置成final

hide method（隐藏函数）有一个函数，从来没有被其他类用过。将这个函数修改为private。// 很多取值/设值函数可被private。尽可能降低所有函数的可见度。

replace constructor with factory method（以工厂函数取代构造函数）你希望在创建对象时不仅仅是做简单的构建动作。将构造函数替换为工厂函数。//  隐藏构造函数，统一使用工厂来进行生成子类

encapsulate downcast（封装向下转型）某个函数返回的对象，需要由函数调用者执行向下转型。将向下转型动作转移到函数中。// 函数应该给用户确切的类型。但是真的需要向下转型，考虑下模板类

replace error code with exception（以异常取代错误码）某个函数返回一个特定的代码，用以标示某种错误情况。改用异常。// 程序有异常是正常的，有异常应该抛出并处理。

replace exception with test（以测试取代异常）面对一个调用者可以预先检查的条件，你跑出了一个异常。修改调用者，使它在调用函数之前先做检查。// 异常是好用的，但是如果能提前进行检查做好测试，避免异常更好

        

 

处理概况（继承）关系

 

pull up field（字段上移）两个子类拥有相同的字段。将该字段移至超类。

pull up method（函数上移）有些函数，在各个子类中产生完全相同的结果。将该函数移至超类。 

pull up constructor body（构造函数本体上移）你再各个子类中拥有一些构造函数，他们的本体几乎完全一致。在超类中新建一个构造函数，并在子类构造函数中调用它

push down method(函数下移)超类中的某个函数只与部分（而非全部）子类有关。将这个函数移到相关的那些子类去。

push down field（字段下移）超类中的某个字段只被部分（而非全部）子类用到。

extract subclass（提炼子类）类中的某些特性只被某些（而非全部）实例用到。新建一个子类，将上面所说的那一部分特性移到子类中。

extract superclass（提炼超类）两个类有相似特性。为这两个类建立一个超类，将相同特性移至超类。

extract interface（提炼接口）若干客户使用类接口中的同一子集，或者两个类的接口有部分相同。将相同的子集提炼到一个独立接口中。

collapse hierarchy（折叠继承关系）超类和子类之间无太大区别。将他们合为一体。

from template method（塑造模板函数）你有一些子类，其中相应的某些函数以相同顺序执行类似的操作，但各个操作的细节上有所不同。将这些操作分别放进独立函数中，并保持他们都有相同的签名，于是原函数也就变得相同了，然后将原函数上移至超类。

                                        // 两个函数以相同顺序执行大致相近的擦偶哦，但是各操作不完全相同，需要将执行操作的序列移至超类，并借助多态保证各操作仍保持差异性。成为Template Method

replace inheritance with delegation（以委托取代继承）某个子类只使用超类接口中的一部分，或是根本不需要继承而来的数据。在子类中新建一个字段用以保存超类；调整子类函数，令它改而委托超类；然后去掉两者之间的继承关系。

replace delegation with inheritance（以继承取代委托）在两个类之间使用委托关系，并经常为整个接口编写许多极简单的委托函数。让委托类继承受托类。

                                                            // 如果并没有使用受托类的所有函数，没必要使用；受托对象不止被一个其他对象共享，受托对象是可变的，不可用。

 

 

 

大型重构

 

Tease apart inheritance(梳理并分解继承体系) 某个继承体系同时承担两项责任。建立两个继承体系，并通过委托关系让其中一个可以调用另一个。

convert procedural design to objects（将过程化设计转化为对象设计）你手上有一些传统过程化风格的代码。将数据记录变成对象，将大块的行为分成小块，并将行为移入相关对象中。

separate domain from presentation（将领域和表述/显示分离）某些GUI类之中包含了领域逻辑。将领域逻辑分离出来，为他们建立独立的领域类。// MVC分层，将数据、业务逻辑、显示分离。

extract hierarchy（提炼继承体系）你有某个类做了太多工作，其中一部分工作是以大量的条件表达式完成的。建立继承体系，以一个子类表示一种特殊情况。

                                                        // 将一种变化封装起来成为一个类

 

 

体会：

花了2周时间吧，把这本书读完了。

但是面对已有的代码，还是有点不知所措。我觉得还是欠缺一些思考，对项目整体的把控，对面向对象的理解。

还需要很多的学习吧！