|
|
|
|
|
# 16 | 熊节：什么代码应该被重构？
|
|
|
|
|
|
|
|
|
|
|
|
你好，我是郑晔。
|
|
|
|
|
|
|
|
|
|
|
|
代码坏味道的说法源自《[重构](https://book.douban.com/subject/30468597/)》这本书，坏味道和重构这两个概念几乎是如影随形。提及《重构》这本书，在国内谁还能比《重构》两版的译者熊节更了解它呢？所以，这一讲，我就请来了我的老朋友熊节，谈谈在他眼中看到的重构和坏味道。有请熊节老师！
|
|
|
|
|
|
|
|
|
|
|
|
你好，我是熊节。
|
|
|
|
|
|
|
|
|
|
|
|
自从翻译了《重构》以后，很多公司找我去做重构的培训，光是华为一家，这个主题在各个不同的部门就培训过好些次。每次讲这个主题，我都觉得挺为难的：重构这事有什么可培训的呢，不就是一个无脑模式匹配的事吗！然而跟各家公司的读者们一交流，我就发现事情并没有那么简单。
|
|
|
|
|
|
|
|
|
|
|
|
很多人一说到重构，就聊到虚无缥缈的事上了，像什么架构啦、文化啦，等等。我不得不先把他们拉住仔细问问，他们是怎么读《重构》这本书的？这一问我就发现，原来很多读者（恐怕是绝大多数读者），还没弄明白这本书到底应该怎么读。
|
|
|
|
|
|
|
|
|
|
|
|
## 什么代码应该被重构？
|
|
|
|
|
|
|
|
|
|
|
|
《重构》这本书，以及重构这门手艺，提纲挈领的部分，都在一个关键的问题上：**什么代码应该被重构**。
|
|
|
|
|
|
|
|
|
|
|
|
你可能会说，质量不好的代码需要被重构。没错，可是代码的质量到底应该如何评判呢？
|
|
|
|
|
|
|
|
|
|
|
|
首先我们要明确的是，代码的好与坏不应当用个人好恶、“含混的代码美学”来表达，因为这会带来两个困难：
|
|
|
|
|
|
|
|
|
|
|
|
* 第一，每个人对于“好”或“美”的观念可能相当不同；
|
|
|
|
|
|
* 第二，对于坏代码缺乏明确的“症状”判断，也就很难提出明确的改进措施。
|
|
|
|
|
|
|
|
|
|
|
|
即便是一些经典的程序设计原则，也有同样的问题。例如“高内聚低耦合”，尽管这是所有人都赞同的设计原则，但究竟什么样的代码呈现了“低内聚”、什么样的代码呈现了“高耦合” 、“低内聚”与“高耦合”是否总是同时出现、应该以何种办法提高内聚降低耦合……这些问题仍然是悬而未决的。
|
|
|
|
|
|
|
|
|
|
|
|
因此，对于真正在一线工作的人来说，“高内聚低耦合”很多时候就成了一句咒语，念完咒语后，呼唤出的其实还是每个人原本的编程习惯与风格，并不真正指导任何行为的改变。
|
|
|
|
|
|
|
|
|
|
|
|
而当我们去观察“低内聚高耦合”带来的问题时，事情就变得明朗了。比如，当我们仔细阅读《重构》第三章时，我们会发现，“低内聚”会直接引发的现象是“霰弹式修改（Shotgun Surgery）”：
|
|
|
|
|
|
|
|
|
|
|
|
> 每当需要对某个事情做出修改时，你都必须在许多不同的类内做出许多小修改，那么就可以确定，你所面临的坏味道是霰弹式修改。当需要修改的代码分散在多处，你不但很难找到它们，也很容易忘记某个重要的修改。
|
|
|
|
|
|
|
|
|
|
|
|
而“高耦合”直接引发的现象则是有某种相似性、但又表现不同的“发散式变化（Divergent Change）”：
|
|
|
|
|
|
|
|
|
|
|
|
> 如果某个类经常因为不同的原因在不同的方向上发生变化，发散式变化就出现了。
|
|
|
|
|
|
|
|
|
|
|
|
我再举另一个设计原则的例子。“迪米特原则”也是常被提及的面向对象设计原则之一，然而知道这个名称是一回事，知道如何识别不符合迪米特原则的代码，则又需要更多的个人经验。《重构》第三章则把这个原则表述为两个非常直观的症状：“过长的消息链（Message Chains）”和“中间人（Middle Man）”。
|
|
|
|
|
|
|
|
|
|
|
|
> 如果你看到用户向一个对象请求另一个对象，而后者再次请求另一个对象，然后再请求另一个对象……这就是消息链。在实际代码中，你看到的可能是一长串取值函数，或者一长串临时变量。
|
|
|
|
|
|
|
|
|
|
|
|
> 人们可能过度运用委托。你也许会看到某个类接口有一半的函数都委托给其他类，这样就是过度运用。
|
|
|
|
|
|
|
|
|
|
|
|
你发现没？对于开始我们提到的“什么代码应该被重构”这个关键问题，虽然《重构》作者Martin Fowler和Kent Beck非常客气地声称：“并不试图给你一个何时必须重构的精确衡量标准”，实际上，《重构》给出的24项“坏味道”（在《重构》第一版中是22项）已经形成了一个非常明确的代码质量检查清单。
|
|
|
|
|
|
|
|
|
|
|
|
尽管这本书从未声称这是一份完备的坏味道清单，但在实际工作中，还不用说完全识别并消除这份列表中的全部坏味道，只要能做到命名合理、没有重复、各个代码单元（类、函数等）体量适当、各个代码单元有明确且单一的职责、各个代码单元之间有恰当的交互，这就已经是质量相当高的代码了。
|
|
|
|
|
|
|
|
|
|
|
|
更重要的是，伴随着对具体症状的了解，对症的解决办法也变得明确。在《重构》第三章里非常明确地讲到：
|
|
|
|
|
|
|
|
|
|
|
|
* 对于“霰弹式修改”，解决的办法是使用“搬移函数”和“搬移字段”，把所有需要修改的代码放进同一个模块；
|
|
|
|
|
|
* 对于“发散式变化”，解决的办法是首先用“提炼函数”将不同用途的逻辑分开，然后用“搬移函数”将它们分别搬移到合适的模块；
|
|
|
|
|
|
* 对于“过长的消息链”，你应该使用“隐藏委托关系”；
|
|
|
|
|
|
* 对于“中间人”，对症的疗法则是“移除中间人”，甚至直接“内联函数”。
|
|
|
|
|
|
|
|
|
|
|
|
这就是我前面所说的“无脑模式匹配”。
|
|
|
|
|
|
|
|
|
|
|
|
讲到这里，你也就明白了，对于绝大多数程序员而言，阅读和使用《重构》这本书的正确方法就应该是：
|
|
|
|
|
|
|
|
|
|
|
|
1. 打开任意一段代码（可以是自己刚写完的或者马上要动手修改的）；
|
|
|
|
|
|
2. 翻开《重构》第三章，遍历其中的每个坏味道：
|
|
|
|
|
|
1. 识别这段代码中是否存在上述坏味道；
|
|
|
|
|
|
1. 如有，则遵循该坏味道所列的重构手法，对该段代码进行重构；
|
|
|
|
|
|
2. 如无，则继续遍历代码。
|
|
|
|
|
|
|
|
|
|
|
|
上述过程不需要玄妙的理论和含混的代码美学，只需要机械的重复和简单的模式匹配。正因为此，重构才是一项完完全全具备可操作性、能够在任何遗留代码库上实践的技术。
|
|
|
|
|
|
|
|
|
|
|
|
## 培养对“坏味道”的判断力
|
|
|
|
|
|
|
|
|
|
|
|
当然，每位实践者仍然“**必须培养出自己的判断力，学会判断一个类内有多少实例变量算是太大、一个函数内有多少行代码才算太长”。**
|
|
|
|
|
|
|
|
|
|
|
|
就在最近，我看到某大厂的一位“代码委员会理事”在文章里说，某段代码“挺好的，长度没超过80行，逻辑比较清晰”。而在我看来，一个函数超过7行就已经是“太长”（这还是在考虑到Java语法比较啰嗦的前提下）。这就是不同实践者“自己的判断力”所体现的差异。
|
|
|
|
|
|
|
|
|
|
|
|
尽管从来没有明确指定对每个函数或类的代码行数要求，但“对象健身操”这篇文章（见于《[ThoughtWorks文集](https://www.infoq.cn/minibook/thoughtworks-anthology)》）提出的9项规则已经有非常明确的指向：
|
|
|
|
|
|
|
|
|
|
|
|
* 方法中只允许使用一级缩进；
|
|
|
|
|
|
* 不允许使用else关键字；
|
|
|
|
|
|
* 封装所有的原生类型和字符串；
|
|
|
|
|
|
* ……
|
|
|
|
|
|
|
|
|
|
|
|
在这样的规则约束下，写出一个超过10行的函数将是相当困难的（实际上在“规则6：保持实体对象简单清晰”中已经明确提出，每个类的长度不能超过50行）。
|
|
|
|
|
|
|
|
|
|
|
|
正如“对象健身操”这篇文章的作者Jeff Bay自己所说，这套“健身操”的意义在于：“在一个简单的项目里尝试一些比以前严格得多的编码标准……会迫使你更为严格地以面向对象的风格编写代码”，从而“以一种全新的方式思考你的代码”。
|
|
|
|
|
|
|
|
|
|
|
|
不过这得需要你刻意练习。正所谓“台上一分钟，台下十年功”，**缺乏在受控环境下的刻意练习，很难通过工作中的自然积累提升判断力。**
|
|
|
|
|
|
|
|
|
|
|
|
另外，对正确的代码构造足够熟悉，也是很重要的一个基本功，这个观点最早是Kent Beck的《[实现模式](http://book.douban.com/subject/3324516/)》这本书中提到的。什么意思呢？
|
|
|
|
|
|
|
|
|
|
|
|
传说旧时民间古董店的学徒需要先在仓库里看真货，看得多了，见到假货时就会本能地提起警觉。对于代码也是一样：程序员需要熟悉正确的代码构造，在看到有问题的代码构造时才会本能地提起警觉。并且，**“正确的代码构造”并非无穷无尽，实际上在单线程编程中，几十个常见的模式已经几乎能够完全覆盖所有场景。**
|
|
|
|
|
|
|
|
|
|
|
|
Kent Beck在前言里说“这是一本关于‘如何编写别人能懂的代码’的书”，尽管他还谦虚地说这本书“不是模式书籍”，但实际上《实现模式》充分地展现了“模式”的本意：它提供了一整套“用代码表述意图”的模式语言，这套语言能让程序员在最短的时间内学会如何写出具有表现力的代码，并且自然而然地远离坏味道。
|
|
|
|
|
|
|
|
|
|
|
|
**从一开始就以合理的方式编程****，****从而使坏味道不要出现，我想这才是负责任的程序员应该采取的工作方式。**
|
|
|
|
|
|
|
|
|
|
|
|
当然，极限编程的各种实践，尤其是工程技术实践彼此紧密相关。例如自动化测试、持续集成、集体代码所有制的缺失，都会导致代码的坏味道更容易堆积。而从另一个角度来看，这些实践从任何一个切入，又都会自然地引导出其他相关的实践。
|
|
|
|
|
|
|
|
|
|
|
|
**一位“知行合一”的程序员最终会发现，极限编程是唯一合理且有效的软件开发方法**。最终，只有采用以可工作的软件为核心的软件开发方法，才能得到高质量的可工作的软件，这就是《敏捷宣言》第二句关于坏味道的终极答案。
|
|
|
|
|
|
|
|
|
|
|
|
## 郑老师说
|
|
|
|
|
|
|
|
|
|
|
|
好了，熊节老师的分享就到这里，我是郑晔。
|
|
|
|
|
|
|
|
|
|
|
|
熊节老师对于问题的分析总是这么一针见血。重构就是一个模式匹配的过程，识别出坏味道，运用对应的重构手法解决问题。坏味道是一切重构的起点，而识别坏味道不是靠个人审美，而要依赖通用的标准。
|
|
|
|
|
|
|
|
|
|
|
|
我的这个专栏就是把一些坏味道用更直接的代码形式展现在你面前，让你可以日常的工作中，不断地锻炼自己的代码嗅觉。
|
|
|
|
|
|
|
|
|
|
|
|
## 思考题
|
|
|
|
|
|
|
|
|
|
|
|
经过熊节老师的讲解，你是不是对重构和坏味道有了新的认识呢？欢迎在留言区分享你更新过的想法。
|
|
|
|
|
|
|
|
|
|
|
|
感谢阅读，我们下一讲再见。
|
|
|
|
|
|
|
