整洁之道 如何让代码更明确、简单、有力

 

 

　　这篇文章摘录自《代码整洁之道》第一章，这本书被看作是程序员必读的书籍之一。但好的书不只是交给你工具、技术，更多是思维过程，近乎禅学、至理，这本书符合这样的定义。本章技术元素最少，适合每一个领域的人阅读。

 

　　阅读本书有两种原因：第一，你是个程序员;第二，你想成为更好的程序员。很好。我们需要更好的程序员。

 

　　这是本有关编写好程序的书。它充斥着代码。我们要从各个方向来考察这些代码。从顶向下，从底往上，从里而外。读完后，就能知道许多关于代码的事了。而且，我们还能说出好代码和糟糕的代码之间的差异。我们将了解到如何写出好代码。我们也会知道，如何将糟糕的代码改成好代码。

 

　　1.1 要有代码

 

　　有人也许会以为，关于代码的书有点儿落后于时代-代码不再是问题;我们应当关注模型和需求。确实，有人说过我们正在临近代码的终结点。很快，代码就会自动产生出来，不需要再人工编写。程序员完全没用了，因为商务人士可以从规约直接生成程序。

 

　　扯淡!我们永远抛不掉代码，因为代码呈现了需求的细节。在某些层面上，这些细节无法被忽略或抽象，必须明确之。将需求明确到机器可以执行的细节程度，就是编程要做的事。而这种规约正是代码。

 

　　我期望语言的抽象程度继续提升。我也期望领域特定语言的数量继续增加。那会是好事一桩。但那终结不了代码。实际上，在较高层次上用领域特定语言撰写的规约也将是代码!它也得严谨、精确、规范和详细，好让机器理解和执行。

 

　　那帮以为代码终将消失的伙计，就像是巴望着发现一种无规范数学的数学家们一般。他们巴望着，总有一天能创造出某种机器，我们只要想想、嘴都不用张就能叫它依计行事。那机器要能透彻理解我们，只有这样，它才能把含糊不清的需求翻译为可完美执行的程序，精确满足需求。

 

　　这种事永远不会发生。即便是人类，倾其全部的直觉和创造力，也造不出满足客户模糊感觉的成功系统来。如果说需求规约原则教给了我们什么，那就是归置良好的需求就像代码一样正式，也能作为代码的可执行测试来使用。

 

　　记住，代码确然是我们最终用来表达需求的那种语言。我们可以创造各种与需求接近的语言。我们可以创造帮助把需求解析和汇整为正式结构的各种工具。然而，我们永远无法抛弃必要的精确性-所以代码永存。

 

　　1.2 糟糕的代码

 

　　最近我在读Kent Beck著Implementation Patterns(中译版《实现模式》) 一书的序言。他这样写道："……本书基于一种不太牢靠的前提：好代码的确重要……"这前提不牢靠?我反对!我认为这是该领域最强固、最受支持、最被强调的前提了(我想Kent也知道)。我们知道好代码重要，是因为其短缺实在困扰了我们太久。

 

　　20世纪80年代末，有家公司写了个很流行的杀手应用，许多专业人士都买来用。然后，发布周期开始拉长。缺陷总是不能修复。装载时间越来越久，崩溃的几率也越来越大。至今我还记得自己在某天沮丧地关掉那个程序，从此再不用它。在那之后不久，该公司就关门大吉了。

 

　　20年后，我见到那家公司的一位早期雇员，问他当年发生了什么事。他的回答叫我愈发恐惧起来。原来，当时他们赶着推出产品，代码写得乱七八糟。特性越加越多，代码也越来越烂，最后再也没法管理这些代码了。是糟糕的代码毁了这家公司。

 

　　你是否曾为糟糕的代码所深深困扰?如果你是位有点儿经验的程序员，定然多次遇到过这类困境。我们有专用来形容这事的词：沼泽(wading)。我们趟过代码的水域。我们穿过灌木密布、瀑布暗藏的沼泽地。我们拼命想找到出路，期望有点什么线索能启发我们到底发生了什么事;但目光所及，只是越来越多死气沉沉的代码。

 

　　你当然曾为糟糕的代码所困扰过。那么-为什么要写糟糕的代码呢?

 

　　是想快点完成吗?是要赶时间吗?有可能。或许你觉得自己要干好所需的时间不够;假使花时间清理代码，老板就会大发雷霆。或许你只是不耐烦再搞这套程序，期望早点结束。或许你看了看自己承诺要做的其他事，意识到得赶紧弄完手上的东西，好接着做下一件工作。这种事我们都干过。

 

　　我们都曾经瞟一眼自己亲手造成的混乱，决定弃之而不顾，走向新一天。我们都曾经看到自己的烂程序居然能运行，然后断言能运行的烂程序总比什么都没有强。我们都曾经说过有朝一日再回头清理。当然，在那些日子里，我们都没听过勒布朗(LeBlanc)法则：稍后等于永不(Later equals never)。

 

　　1.3 混乱的代价

 

　　只要你干过两三年编程，就有可能曾被某人的糟糕的代码绊倒过。如果你编程不止两三年，也有可能被这种代码拖过后腿。进度延缓的程度会很严重。有些团队在项目初期进展迅速，但有那么一两年的时间却慢如蜗行。对代码的每次修改都影响到其他两三处代码。修改无小事。每次添加或修改代码，都得对那堆扭纹柴了然于心，这样才能往上扔更多的扭纹柴。这团乱麻越来越大，再也无法理清，最后束手无策。

 

　　随着混乱的增加，团队生产力也持续下降，趋向于零。当生产力下降时，管理层就只有一件事可做了：增加更多人手到项目中，期望提升生产力。可是新人并不熟悉系统的设计。他们搞不清楚什么样的修改符合设计意图，什么样的修改违背设计意图。而且，他们以及团队中的其他人都背负着提升生产力的可怕压力。于是，他们制造更多的混乱，驱动生产力向零那端不断下降。

 

　　1.3.1 华丽新设计

 

　　最后，开发团队造反了，他们告诉管理层，再也无法在这令人生厌的代码基础上做开发。他们要求做全新的设计。管理层不愿意投入资源完全重启炉灶，但他们也不能否认生产力低得可怕。他们只好同意开发者的要求，授权去做一套看上去很美的华丽新设计。

 

　　于是就组建了一支新军。谁都想加入这个团队，因为它是张白纸。他们可以重新来过，搞出点真正漂亮的东西来。但只有最优秀、最聪明的家伙被选中。其余人等则继续维护现有系统。

 

　　现在有两支队伍在竞赛了。新团队必须搭建一套新系统，要能实现旧系统的所有功能。另外，还得跟上对旧系统的持续改动。在新系统功能足以抗衡旧系统之前，管理层不会替换掉旧系统。

 

　　竞赛可能会持续极长时间。我就见过延续了十年之久的。到了完成的时候，新团队的老成员早已不知去向，而现有成员则要求重新设计一套新系统，因为这套系统太烂了。

 

　　假使你经历过哪怕是一小段我谈到的这种事，那么你一定知道，花时间保持代码整洁不但有关效率，还有关生存。

　　1.3.2 态度

　　你是否遇到过某种严重到要花数个星期来做本来只需数小时即可完成的事的混乱状况?你是否见过本来只需做一行修改，结果却涉及上百个模块的情况?这种事太常见了。

 

　　怎么会发生这种事?为什么好代码会这么快就变质成糟糕的代码?理由多得很。我们抱怨需求变化背离了初期设计。我们哀叹进度太紧张，没法干好活。我们把问题归咎于那些愚蠢的经理、苛求的用户、没用的营销方式和那些电话消毒剂。不过，亲爱的呆伯特(Dilbert) ，我们是自作自受 。我们太不专业了。

 

　　这话可不太中听。怎么会是自作自受呢?难道不关需求的事?难道不关进度的事?难道不关那些蠢经理和没用的营销手段的事?难道他们就不该负点责吗?

 

　　不。经理和营销人员指望从我们这里得到必须的信息，然后才能做出承诺和保证;即便他们没开口问，我们也不该羞于告知自己的想法。用户指望我们验证需求是否都在系统中实现了。项目经理指望我们遵守进度。我们与项目的规划脱不了干系，对失败负有极大的责任;特别是当失败与糟糕的代码有关时尤为如此!

 

　　"且慢!"你说。"不听经理的，我就会被炒鱿鱼。"多半不会。多数经理想要知道实情，即便他们看起来不喜欢实情。多数经理想要好代码，即便他们总是痴缠于进度。他们会奋力卫护进度和需求;那是他们该干的。你则当以同等的热情卫护代码。

 

　　再说明白些，假使你是位医生，病人请求你在给他做手术前别洗手，因为那会花太多时间，你会照办吗 ?本该是病人说了算;但医生却绝对应该拒绝遵从。为什么?因为医生比病人更了解疾病和感染的风险。医生如果按病人说的办，就是一种不专业的态度(更别说是犯罪了)。

 

　　同理，程序员遵从不了解混乱风险的经理的意愿，也是不专业的做法。

 

　　1.3.3 迷题

 

　　程序员面临着一种基础价值谜题。有那么几年经验的开发者都知道，之前的混乱拖了自己的后腿。但开发者们背负期限的压力，只好制造混乱。简言之，他们没花时间让自己做得更快!

 

　　真正的专业人士明白，这道谜题的第二部分说错了。制造混乱无助于赶上期限。混乱只会立刻拖慢你，叫你错过期限。赶上期限的唯一方法-做得快的唯一方法 -就是始终尽可能保持代码整洁。

 

　　1.3.4 整洁代码的艺术

 

　　假设你相信混乱的代码是祸首，假设你接受做得快的唯一方法是保持代码整洁的说法，你一定会自问："我怎么才能写出整洁的代码?"不过，如果你不明白整洁对代码有何意义，尝试去写整洁代码就毫无所益!

 

　　坏消息是写整洁代码很像是绘画。多数人都知道一幅画是好还是坏。但能分辨优劣并不表示懂得绘画。能分辨整洁代码和肮脏代码，也不意味着会写整洁代码!

 

　　写整洁代码，需要遵循大量的小技巧，贯彻刻苦习得的"整洁感"。这种"代码感"就是关键所在。有些人生而有之。有些人费点劲才能得到。它不仅让我们看到代码的优劣，还予我们以借戒规之力化劣为优的攻略。

 

　　缺乏"代码感"的程序员，看混乱是混乱，无处着手。有"代码感"的程序员能从混乱中看出其他的可能与变化。"代码感"帮助程序员选出最好的方案，并指导程序员制订修改行动计划，按图索骥。

 

　　简言之，编写整洁代码的程序员就像是艺术家，他能用一系列变换把一块白板变作由优雅代码构成的系统。

 

　　1.3.5 什么是整洁代码

 

　　有多少程序员，就有多少定义。所以我只询问了一些非常知名且经验丰富的程序员。

 

　　Bjarne Stroustrup，C++语言发明者，C++ Programming Language(中译版《C++程序设计语言》)一书作者。

 

　　我喜欢优雅和高效的代码。代码逻辑应当直截了当，叫缺陷难以隐藏;尽量减少依赖关系，使之便于维护;依据某种分层战略完善错误处理代码;性能调至最优，省得引诱别人做没规矩的优化，搞出一堆混乱来。整洁的代码只做好一件事。

 

　　Bjarne用了"优雅"一词。说得好!我MacBook上的词典提供了如下定义：外表或举止上令人愉悦的优美和雅观;令人愉悦的精致和简单。注意对"愉悦"一词的强调。Bjarne显然认为整洁的代码读起来令人愉悦。读这种代码，就像见到手工精美的音乐盒或者设计精良的汽车一般，让你会心一笑。

 

　　Bjarne也提到效率-而且两次提及。这话出自C++发明者之口，或许并不出奇;不过我认为并非是在单纯追求速度。被浪费掉的运算周期并不雅观，并不令人愉悦。留意Bjarne怎么描述那种不雅观的结果。他用了"引诱"这个词。诚哉斯言。糟糕的代码引发混乱!别人修改糟糕的代码时，往往会越改越烂。

 

　　务实的Dave Thomas和Andy Hunt从另一角度阐述了这种情况。他们提到破窗理论 。窗户破损了的建筑让人觉得似乎无人照管。于是别人也再不关心。他们放任窗户继续破损。最终自己也参加破坏活动，在外墙上涂鸦，任垃圾堆积。一扇破损的窗户开辟了大厦走向倾颓的道路。

　　Bjarne也提到完善错误处理代码。往深处说就是在细节上花心思。敷衍了事的错误处理代码只是程序员忽视

细节的一种表现。此外还有内存泄漏，还有竞态条件代码。还有前后不一致的命名方式。结果就是凸现出整洁代码对细节的重视。

 

　　Bjarne以"整洁的代码只做好一件事"结束论断。毋庸置疑，软件设计的许多原则最终都会归结为这句警语。有那么多人发表过类似的言论。糟糕的代码想做太多事，它意图混乱、目的含混。整洁的代码力求集中。每个函数、每个类和每个模块都全神贯注于一事，完全不受四周细节的干扰和污染。

 

　　Grady Booch，Object Oriented Analysis and Design with Applications(中译版《面向对象分析与设计》)一书作者。

 

　　整洁的代码简单直接。整洁的代码如同优美的散文。整洁的代码从不隐藏设计者的意图，充满了干净利落的抽象和直截了当的控制语句。

 

　　Grady的观点与Bjarne的观点有类似之处，但他从可读性的角度来定义。我特别喜欢"整洁的代码如同优美的散文"这种看法。想想你读过的某本好书。回忆一下，那些文字是如何在脑中形成影像!就像是看了场电影，对吧?还不止!你还看到那些人物，听到那些声音，体验到那些喜怒哀乐。

 

　　阅读整洁的代码和阅读Lord of the Rings(中译版《指环王》)自然不同。不过，仍有可类比之处。如同一本好的小说般，整洁的代码应当明确地展现出要解决问题的张力。它应当将这种张力推至高潮，以某种显而易见的方案解决问题和张力，使读者发出"啊哈!本当如此!"的感叹。

 

　　窃以为Grady所谓"干净利落的抽象"(crisp abstraction)，乃是绝妙的矛盾修辞法。毕竟crisp几乎就是"具体"(concrete)的同义词。我MacBook上的词典这样定义crisp一词：果断决绝，就事论事，没有犹豫或不必要的细节。尽管有两种不同的定义，该词还是承载了有力的信息。代码应当讲述事实，不引人猜测。它只该包含必需之物。读者应当感受到我们的果断决绝。

 

　　"老大"Dave Thomas，OTI公司创始人，Eclipse战略教父。

 

　　整洁的代码应可由作者之外的开发者阅读和增补。它应当有单元测试和验收测试。它使用有意义的命名。它只提供一种而非多种做一件事的途径。它只有尽量少的依赖关系，而且要明确地定义和提供清晰、尽量少的API。代码应通过其字面表达含义，因为不同的语言导致并非所有必需信息均可通过代码自身清晰表达。

 

　　Dave老大在可读性上和Grady持相同观点，但有一个重要的不同之处。Dave断言，整洁的代码便于其他人加以增补。这看似显而易见，但亦不可过分强调。毕竟易读的代码和易修改的代码之间还是有区别的。

 

　　Dave将整洁系于测试之上!要在十年之前，这会让人大跌眼镜。但测试驱动开发(Test Driven Development)已在行业中造成了深远影响，成为基础规程之一。Dave说得对。没有测试的代码不干净。不管它有多优雅，不管有多可读、多易理解，微乎测试，其不洁亦可知也。

 

　　Dave两次提及"尽量少"。显然，他推崇小块的代码。实际上，从有软件起人们就在反复强调这一点。越小越好。

 

　　Dave也提到，代码应在字面上表达其含义。这一观点源自Knuth的"字面编程"(literate programming) 。结论就是应当用人类可读的方式来写代码。

 

　　Michael Feathers，Working Effectively with Legacy Code(中译版《修改代码的艺术》)一书作者。

 

　　我可以列出我留意到的整洁代码的所有特点，但其中有一条是根本性的。整洁的代码总是看起来像是某位特别在意它的人写的。几乎没有改进的余地。代码作者什么都想到了，如果你企图改进它，总会回到原点，赞叹某人留给你的代码-全心投入的某人留下的代码。

 

　　一言以蔽之：在意。这就是本书的题旨所在。或许该加个副标题，如何在意代码。

 

　　Michael一针见血。整洁代码就是作者着力照料的代码。有人曾花时间让它保持简单有序。他们适当地关注到了细节。他们在意过。

 

　　Ron Jeffries，Extreme Programming Installed(中译版《极限编程实施》)以及Extreme Programming Adventures in C#(中译版《C#极限编程探险》)作者。

 

　　Ron初入行就在战略空军司令部(Strategic Air Command)编写Fortran程序，此后几乎在每种机器上编写过每种语言的代码。他的言论值得咀嚼。

 

　　近年来，我开始研究贝克的简单代码规则，差不多也都琢磨透了。简单代码，依其重要顺序：

 

　　能通过所有测试;

 

　　没有重复代码;

 

　　体现系统中的全部设计理念;

 

　　包括尽量少的实体，比如类、方法、函数等。

 

　　在以上诸项中，我最在意代码重复。如果同一段代码反复出现，就表示某种想法未在代码中得到良好的体现。我尽力去找出到底那是什么，然后再尽力更清晰地表达出来。

 

　　在我看来，有意义的命名是体现表达力的一种方式，我往往会修改好几次才会定下名字来。借助Eclipse这样的现代编码工具，重命名代价极低，所以我无所顾忌。然而，表达力还不只体现在命名上。我也会检查对象或方法是否想做的事太多。如果对象功能太多，最好是切分为两个或多个对象。如果方法功能太多，我总是使用抽取手段(Extract Method)重构之，从而得到一个能较为清晰地说明自身功能的方法，以及另外数个说明如何实现这些功能的方法。

 

　　消除重复和提高表达力让我在整洁代码方面获益良多，只要铭记这两点，改进脏代码时就会大有不同。不过，我时常关注的另一规则就不太好解释了。

 

　　这么多年下来，我发现所有程序都由极为相似的元素构成。例如"在集合中查找某物"。不管是雇员记录数据库还是名-值对哈希表，或者某类条目的数组，我们都会发现自己想要从集合中找到某一特定条目。一旦出现这种情况，我通常会把实现手段封装到更抽象的方法或类中。这样做好处多多。

 

　　可以先用某种简单的手段，比如哈希表来实现这一功能，由于对搜索功能的引用指向了我那个小小的抽象，就能随需应变，修改实现手段。这样就既能快速前进，又能为未来的修改预留余地。

 

　　另外，该集合抽象常常提醒我留意"真正"在发生的事，避免随意实现集合行为，因为我真正需要的不过是某种简单的查找手段。

 

　　减少重复代码，提高表达力，提早构建简单抽象。这就是我写整洁代码的方法。

 

　　Ron以寥寥数段文字概括了本书的全部内容。不要重复代码，只做一件事，表达力，小规模抽象。该有的都有了。

 

　　Ward Cunningham，Wiki发明者，eXtreme Programming(极限编程)的创始人之一，Smalltalk语言和面向对象的思想领袖。所有在意代码者的教父。

 

　　如果每个例程都让你感到深合己意，那就是整洁代码。如果代码让编程语言看起来像是专为解决那个问题而存在，就可以称之为漂亮的代码。

 

　　这种说法很Ward。它教你听了之后就点头，然后继续听下去。如此在理，如此浅显，绝不故作高深。你大概以为此言深合己意吧。再走近点看看。

 

　　"……深合己意"。你最近一次看到深合己意的模块是什么时候?模块多半都繁复难解吧?难道没有触犯规则吗?你不是也曾挣扎着想抓住些从整个系统中散落而出的线索，编织进你在读的那个模块吗?你最近一次读到某段代码、并且如同对Ward的说法点头一般对这段代码点头，是什么时候的事了?

 

　　Ward期望你不会为整洁代码所震惊。你无需花太多力气。那代码就是深合你意。它明确、简单、有力。每个模块都为下一个模块做好准备。每个模块都告诉你下一个模块会是怎样的。整洁的程序好到你根本不会注意到它。设计者把它做得像一切其他设计般简单。

 

　　那Ward有关"美"的说法又如何呢?我们都曾面临语言不是为要解决的问题所设计的困境。但Ward的说法又把球踢回我们这边。他说，漂亮的代码让编程语言像是专为解决那个问题而存在!所以，让语言变得简单的责任就在我们身上了!当心，语言是冥顽不化的!是程序员让语言显得简单。

 

　　1.8 小结

 

　　艺术书并不保证你读过之后能成为艺术家，只能告诉你其他艺术家用过的工具、技术和思维过程。本书同样也不担保让你成为好程序员。它不担保能给你"代码感"。它所能做的，只是展示好程序员的思维过程，还有他们使用的技巧、技术和工具。

 

　　和艺术书一样，本书也充满了细节。代码会很多。你会看到好代码，也会看到糟糕的代码。你会看到糟糕的代码如何转化为好代码。你会看到启发、规条和技巧的列表。你会看到一个又一个例子。但最终结果取决于你自己。