重构改善既有代码的设计

本文探讨了重构和测试的关系,提出了重构的基本原则,如小步前进和频繁测试,并介绍了多种重构手法,包括Extract Method、Inline Method等,旨在提高代码质量和可维护性。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

构筑测试体系

重构+测试 密不可分

自测试代码的价值

Q:程序员时间耗费在哪里?

   调试

Q:类应该包含他们自己的测试代码吗?

   在自动化无法进行覆盖的同时需要有代码测试机制

Q:继承和多态会让测试变的比较困难,是否还需要继续?

   “花合理的时间抓出大多数bug”好过“穷尽一生抓出所有bug”

重构列表

重构的记录格式

E:重构手法都有五个部分:名称(重构词汇表)、简短概要、动机、做法、范例

这些重构手法有多成熟

E:重构的基本技巧——小步前进,频繁测试。

重新组织函数

对付过长的函数,手法:Extract MethodInline Method

Extract Method

TheGreatest Difficulty:处理局部变量,而临时变量则是其中一个主要的困难源头

Ways:Replace Temp WithQuery,Split Temporary Variable

动机:

1、 每个函数的颗粒度都非常小,那么函数被复用的机会就更大

2、 这会使高层函数读起来就像一系列注释

3、 如果函数都是细粒度,那么函数的覆写也会更容易些

关键之处:在于函数和函数本体之间的语义距离,如果提炼可以强化代码的清晰度,那就去做,就算函数名称比提炼出来的代码还长也无所谓(不禁令人思考,其目的就是为了更清晰的阅读代码,不用写注释就能看懂其相关语义,那我是否可以说基类中的方法清晰可读性强,子类复用度就高?还有针对过长的算法是否更能体现其可读性呢?答案肯定是是的!)

做法:

1、 创造一个函数,根据函数的意图来命名

2、 将提炼出来的代码从源函数复制到新建的目标函数中

3、 仔细检查,判断是否引用了“作用域限于原函数”

4、 检查是否有“仅用于被提炼代码段”的临时变量

5、 检查被提炼代码段,看是否有局部变量的值被其改变

6、 将被提炼代码段中需要读取的局部变量,当做参数传给目标函数

7、 处理完所有局部变量后,进行编译

8、 调用

9、 编译测试

关键之处:如何处理好被提炼出来的函数内临时变量,这才是Extract Method如何做的关键(那么在ExtractMethod之前你必须对将要提出的函数的含义了解清楚,对其设计到的所有临时变量及成员变量的作用域及值非常清楚,否则过程的准确性谁来保证,Utest只是对过的保证,编译测试时间岂不很长)

Inline Method(内联函数)

注:在函数调用点插入函数本体,然后移除该函数

动机

1、 一大群组织不合理的函数,可内联到大型函数中,并从中提炼出组织合理的小型函数

2、 如果使用了太多间接层,那么对于函数来说就只是对另一个函数的简单委托,起不到真正意义上的清晰可读

注:我们提炼函数的标准是,找出那些有用的间接层,去掉无用的间接层

做法

1、 分析函数,确保函数不具多态性(一般不存在子类继承父类的内联函数,这种是不符合多态的标准)

2、 找出这个函数的所有被调用点

3、 将这个函数所有被调用点都替换为函数本体

4、 编译、测试

5、 删除该函数的定义

注:对于递归、多返回点、内联到对象且未提供访问函数等的情况不适用Inline Method

Inline Temp(内联临时变量)

将所有对该变量的引用动作,替换为对他赋值的那个表达式本身,目的:去掉无效的中间临时变量

Replace Temp With Query(以查询替代临时变量)

将表达式提炼到一个独立的函数中(这个函数只表述一种表达式),并将这个临时变量的所有引用点替换为对新函数的调用,此后,新函数就可被其他函数使用。

注:Replace Temp With Query 是Extract Method之前必不可少的一个步骤,当局部变量难以被提炼时,应该尽可能把他们替换为查询式。

Introduce Explaining Variable(引入解释性变量)

当表达式很复杂,或分为多个分步的表达式嵌套使用,此时将其中一部分结果放进一个临时变量,此变量名称来解释表达式用途。

注:使用场景->表达式有可能非常复杂而难以阅读,此时使用临时变量可以更容易管理并分解表达式。

Remove Assignments to Parametes(移除对参数的赋值)

避免给参数赋值,以免改变参数的值。故,一般采用引用参数,但是对于对象来说,对象引用是按值传递的,因此可以修改对象内部状态,单对参数对象赋值是没有意义的,他只是一个代码块

Replace Method with Method Object(以函数对象取代函数)

如果你有一个大型函数,其中度局部变量的使用无法采用Extract Method,那将这个函数放进一个单独对象中,如此一来,局部变量就成了对象内的字段,然后你可以再同一个对象中将这个大型函数分解为多个小型函数。

目的:强调小函数的优美、可读性

 

第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
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值