有多少程序員，就有多少定義。所以我們只詢(xún)問(wèn)了一些非常知名且經(jīng)驗(yàn)豐富的程序員。
▲▲▲ Bjarne Stroustrup，C++語(yǔ)言發(fā)明者，C++ Programming Language（中譯版《C++程序設(shè)計(jì)語(yǔ)言》）一書(shū)作者。
我喜歡優(yōu)雅和高效的代碼。代碼邏輯應(yīng)當(dāng)直截了當(dāng)，叫缺陷難以隱藏；盡量減少依賴(lài)關(guān)系，使之便于維護(hù)；依據(jù)某種分層戰(zhàn)略完善錯(cuò)誤處理代碼；性能調(diào)至最優(yōu)，省得引誘別人做沒(méi)規(guī)矩的優(yōu)化，搞出一堆混亂來(lái)。整潔的代碼只做好一件事。
Bjarne 用了“優(yōu)雅”一詞。說(shuō)得好！我 MacBook 上的詞典提供了如下定義：外表或舉止上令人愉悅的優(yōu)美和雅觀；令人愉悅的精致和簡(jiǎn)單。注意對(duì)“愉悅”一詞的強(qiáng)調(diào)。Bjarne 顯然認(rèn)為整潔的代碼讀起來(lái)令人愉悅。讀這種代碼，就像見(jiàn)到手工精美的音樂(lè)盒或者設(shè)計(jì)精良的汽車(chē)一般，讓你會(huì)心一笑。
Bjarne 也提到效率——而且兩次提及。這話(huà)出自 C++ 發(fā)明者之口，或許并不出奇；不過(guò)我認(rèn)為并非是在單純追求速度。被浪費(fèi)掉的運(yùn)算周期并不雅觀，并不令人愉悅。留意 Bjarne 怎么描述那種不雅觀的結(jié)果。他用了“引誘”這個(gè)詞。誠(chéng)哉斯言。糟糕的代碼引發(fā)混亂！別人修改糟糕的代碼時(shí)，往往會(huì)越改越爛。
務(wù)實(shí)的 Dave Thomas 和 Andy Hunt 從另一角度闡述了這種情況。他們提到破窗理論。窗戶(hù)破損了的建筑讓人覺(jué)得似乎無(wú)人照管。于是別人也再不關(guān)心。他們放任窗戶(hù)繼續(xù)破損。最終自己也參加破壞活動(dòng)，在外墻上涂鴉，任垃圾堆積。一扇破損的窗戶(hù)開(kāi)辟了大廈走向傾頹的道路。
Bjarne 也提到完善錯(cuò)誤處理代碼。往深處說(shuō)就是在細(xì)節(jié)上花心思。敷衍了事的錯(cuò)誤處理代碼只是程序員忽視細(xì)節(jié)的一種表現(xiàn)。此外還有內(nèi)存泄漏，還有競(jìng)態(tài)條件代碼。還有前后不一致的命名方式。結(jié)果就是凸現(xiàn)出整潔代碼對(duì)細(xì)節(jié)的重視。
Bjarne 以“整潔的代碼只做好一件事”結(jié)束論斷。毋庸置疑，軟件設(shè)計(jì)的許多原則最終都會(huì)歸結(jié)為這句警語(yǔ)。有那么多人發(fā)表過(guò)類(lèi)似的言論。糟糕的代碼想做太多事，它意 圖混亂、目的含混。整潔的代碼力求集中。每個(gè)函數(shù)、每個(gè)類(lèi)和每個(gè)模塊都全神貫注于一事，完全不受四周細(xì)節(jié)的干擾和污染。
▲▲▲ Grady Booch，Object Oriented Analysis and Design with Applications（中譯版《面向?qū)ο蠓治雠c設(shè)計(jì)》）一書(shū)作者。
整潔的代碼簡(jiǎn)單直接。整潔的代碼如同優(yōu)美的散文。整潔的代碼從不隱藏設(shè)計(jì)者的意圖，充滿(mǎn)了干凈利落的抽象和直截了當(dāng)?shù)目刂普Z(yǔ)句。
Grady 的觀點(diǎn)與 Bjarne 的觀點(diǎn)有類(lèi)似之處，但他從可讀性的角度來(lái)定義。我特別喜歡“整潔的代碼如同優(yōu)美的散文”這種看法。想想你讀過(guò)的某本好書(shū)?；貞浺幌拢切┪淖质侨绾卧谀X中 形成影像！就像是看了場(chǎng)電影，對(duì)吧？還不止！你還看到那些人物，聽(tīng)到那些聲音，體驗(yàn)到那些喜怒哀樂(lè)。
閱讀整潔的代碼和閱讀 Lord of the Rings（中譯版《指環(huán)王》）自然不同。不過(guò)，仍有可類(lèi)比之處。如同一本好的小說(shuō)般，整潔的代碼應(yīng)當(dāng)明確地展現(xiàn)出要解決問(wèn)題的張力。它應(yīng)當(dāng)將這種張力推 至高潮，以某種顯而易見(jiàn)的方案解決問(wèn)題和張力，使讀者發(fā)出“啊哈！本當(dāng)如此！”的感嘆。
竊以為 Grady 所謂“干凈利落的抽象”（crisp abstraction），乃是絕妙的矛盾修辭法。畢竟 crisp 幾乎就是“具體”（concrete）的同義詞。我 MacBook 上的詞典這樣定義 crisp 一詞：果斷決絕，就事論事，沒(méi)有猶豫或不必要的細(xì)節(jié)。盡管有兩種不同的定義，該詞還是承載了有力的信息。代碼應(yīng)當(dāng)講述事實(shí)，不引人猜測(cè)。它只該包含必需之物。讀者應(yīng)當(dāng)感受到我們的果斷決絕。
▲▲▲ “老大”Dave Thomas，OTI 公司創(chuàng)始人，Eclipse 戰(zhàn)略教父。
整潔的代碼應(yīng)可由作者之外的開(kāi)發(fā)者閱讀和增補(bǔ)。它應(yīng)當(dāng)有單元測(cè)試和驗(yàn)收測(cè)試。它使用有意義的命名。它只提供一種而非多種做一件事的途徑。它只有盡量少的依賴(lài)關(guān)系，而且要明確地定義和提供清晰、盡量少的 API。代碼應(yīng)通過(guò)其字面表達(dá)含義，因?yàn)椴煌恼Z(yǔ)言導(dǎo)致并非所有必需信息均可通過(guò)代碼自身清晰表達(dá)。
Dave 老大在可讀性上和 Grady 持相同觀點(diǎn)，但有一個(gè)重要的不同之處。Dave 斷言，整潔的代碼便于其他人加以增補(bǔ)。這看似顯而易見(jiàn)，但亦不可過(guò)分強(qiáng)調(diào)。畢竟易讀的代碼和易修改的代碼之間還是有區(qū)別的。
Dave 將整潔系于測(cè)試之上！要在十年之前，這會(huì)讓人大跌眼鏡。但測(cè)試驅(qū)動(dòng)開(kāi)發(fā)（Test Driven Development）已在行業(yè)中造成了深遠(yuǎn)影響，成為基礎(chǔ)規(guī)程之一。Dave 說(shuō)得對(duì)。沒(méi)有測(cè)試的代碼不干凈。不管它有多優(yōu)雅，不管有多可讀、多易理解，微乎測(cè)試，其不潔亦可知也。
Dave兩次提及“盡量少”。顯然，他推崇小塊的代碼。實(shí)際上，從有軟件起人們就在反復(fù)強(qiáng)調(diào)這一點(diǎn)。越小越好。
Dave也提到，代碼應(yīng)在字面上表達(dá)其含義。這一觀點(diǎn)源自Knuth的“字面編程”（literate programming）。結(jié)論就是應(yīng)當(dāng)用人類(lèi)可讀的方式來(lái)寫(xiě)代碼。
▲▲▲ Michael Feathers，Working Effectively with Legacy Code（中譯版《修改代碼的藝術(shù)》）一書(shū)作者。
我可以列出我留意到的整潔代碼的所有特點(diǎn)，但其中有一條是根本性的。整潔的代碼總是看起來(lái)像是某位特別在意它的人寫(xiě)的。幾乎沒(méi)有改進(jìn)的余地。代碼作者什么都想到了，如果你企圖改進(jìn)它，總會(huì)回到原點(diǎn)，贊嘆某人留給你的代碼——全心投入的某人留下的代碼。
一言以蔽之：在意。這就是本書(shū)的題旨所在?；蛟S該加個(gè)副標(biāo)題，如何在意代碼。
Michael 一針見(jiàn)血。整潔代碼就是作者著力照料的代碼。有人曾花時(shí)間讓它保持簡(jiǎn)單有序。他們適當(dāng)?shù)仃P(guān)注到了細(xì)節(jié)。他們?cè)谝膺^(guò)。
▲▲▲ Ron Jeffries，Extreme Programming Installed（中譯版《極限編程實(shí)施》）以及 Extreme Programming Adventures in C#（中譯版《C#極限編程探險(xiǎn)》）作者。
Ron 初入行就在戰(zhàn)略空軍司令部（Strategic Air Command）編寫(xiě) Fortran 程序，此后幾乎在每種機(jī)器上編寫(xiě)過(guò)每種語(yǔ)言的代碼。他的言論值得咀嚼。
近年來(lái)，我開(kāi)始研究貝克的簡(jiǎn)單代碼規(guī)則，差不多也都琢磨透了。簡(jiǎn)單代碼，依其重要順序：
能通過(guò)所有測(cè)試；
沒(méi)有重復(fù)代碼；
體現(xiàn)系統(tǒng)中的全部設(shè)計(jì)理念；
包括盡量少的實(shí)體，比如類(lèi)、方法、函數(shù)等。
在以上諸項(xiàng)中，我最在意代碼重復(fù)。如果同一段代碼反復(fù)出現(xiàn)，就表示某種想法未在代碼中得到良好的體現(xiàn)。我盡力去找出到底那是什么，然后再盡力更清晰地表達(dá)出來(lái)。
在 我看來(lái)，有意義的命名是體現(xiàn)表達(dá)力的一種方式，我往往會(huì)修改好幾次才會(huì)定下名字來(lái)。借助 Eclipse 這樣的現(xiàn)代編碼工具，重命名代價(jià)極低，所以我無(wú)所顧忌。然而，表達(dá)力還不只體現(xiàn)在命名上。我也會(huì)檢查對(duì)象或方法是否想做的事太多。如果對(duì)象功能太多，最好 是切分為兩個(gè)或多個(gè)對(duì)象。如果方法功能太多，我總是使用抽取手段（Extract Method）重構(gòu)之，從而得到一個(gè)能較為清晰地說(shuō)明自身功能的方法，以及另外數(shù)個(gè)說(shuō)明如何實(shí)現(xiàn)這些功能的方法。
消除重復(fù)和提高表達(dá)力讓我在整潔代碼方面獲益良多，只要銘記這兩點(diǎn)，改進(jìn)臟代碼時(shí)就會(huì)大有不同。不過(guò)，我時(shí)常關(guān)注的另一規(guī)則就不太好解釋了。
這么多年下來(lái)，我發(fā)現(xiàn)所有程序都由極為相似的元素構(gòu)成。例如“在集合中查找某物”。不管是雇員記錄數(shù)據(jù)庫(kù)還是名-值對(duì)哈希表，或者某類(lèi)條目的數(shù) 組，我們都會(huì)發(fā)現(xiàn)自己想要從集合中找到某一特定條目。一旦出現(xiàn)這種情況，我通常會(huì)把實(shí)現(xiàn)手段封裝到更抽象的方法或類(lèi)中。這樣做好處多多。
可以先用某種簡(jiǎn)單的手段，比如哈希表來(lái)實(shí)現(xiàn)這一功能，由于對(duì)搜索功能的引用指向了我那個(gè)小小的抽象，就能隨需應(yīng)變，修改實(shí)現(xiàn)手段。這樣就既能快速前進(jìn)，又能為未來(lái)的修改預(yù)留余地。
另外，該集合抽象常常提醒我留意“真正”在發(fā)生的事，避免隨意實(shí)現(xiàn)集合行為，因?yàn)槲艺嬲枰牟贿^(guò)是某種簡(jiǎn)單的查找手段。
減少重復(fù)代碼，提高表達(dá)力，提早構(gòu)建簡(jiǎn)單抽象。這就是我寫(xiě)整潔代碼的方法。
Ron 以寥寥數(shù)段文字概括了本書(shū)的全部?jī)?nèi)容。不要重復(fù)代碼，只做一件事，表達(dá)力，小規(guī)模抽象。該有的都有了。
▲▲▲ Ward Cunningham，Wiki 發(fā)明者，eXtreme Programming（極限編程）的創(chuàng)始人之一，Smalltalk 語(yǔ)言和面向?qū)ο蟮乃枷腩I(lǐng)袖。所有在意代碼者的教父。
如果每個(gè)例程都讓你感到深合己意，那就是整潔代碼。如果代碼讓編程語(yǔ)言看起來(lái)像是專(zhuān)為解決那個(gè)問(wèn)題而存在，就可以稱(chēng)之為漂亮的代碼。
這種說(shuō)法很 Ward。它教你聽(tīng)了之后就點(diǎn)頭，然后繼續(xù)聽(tīng)下去。如此在理，如此淺顯，絕不故作高深。你大概以為此言深合己意吧。再走近點(diǎn)看看。
“…… 深合己意”。你最近一次看到深合己意的模塊是什么時(shí)候？模塊多半都繁復(fù)難解吧？難道沒(méi)有觸犯規(guī)則嗎？你不是也曾掙扎著想抓住些從整個(gè)系統(tǒng) 中散落而出的線(xiàn)索，編織進(jìn)你在讀的那個(gè)模塊嗎？你最近一次讀到某段代碼、并且如同對(duì) Ward 的說(shuō)法點(diǎn)頭一般對(duì)這段代碼點(diǎn)頭，是什么時(shí)候的事了？
Ward 期望你不會(huì)為整潔代碼所震驚。你無(wú)需花太多力氣。那代碼就是深合你意。它明確、簡(jiǎn)單、有力。每個(gè)模塊都為下一個(gè)模塊做好準(zhǔn)備。每個(gè)模塊都告訴你下一個(gè)模塊會(huì)是怎樣的。整潔的程序好到你根本不會(huì)注意到它。設(shè)計(jì)者把它做得像一切其他設(shè)計(jì)般簡(jiǎn)單。
那 Ward 有關(guān)“美”的說(shuō)法又如何呢？我們都曾面臨語(yǔ)言不是為要解決的問(wèn)題所設(shè)計(jì)的困境。但 Ward 的說(shuō)法又把球踢回我們這邊。他說(shuō)，漂亮的代碼讓編程語(yǔ)言像是專(zhuān)為解決那個(gè)問(wèn)題而存在！所以，讓語(yǔ)言變得簡(jiǎn)單的責(zé)任就在我們身上了！當(dāng)心，語(yǔ)言是冥頑不化的！是程序員讓語(yǔ)言顯得簡(jiǎn)單。
