摘 ?要

最近寫了不少代碼踱蛀，review了不少代碼窿给，也做了不少重構(gòu)贵白，總之是對(duì)著爛代碼工作了幾周。為了抒發(fā)一下這幾周里好幾次到達(dá)崩潰邊緣的情緒崩泡，我決定寫一篇文章談一談爛代碼的那些事戒洼。 這里是上篇，談一談爛代碼產(chǎn)生的原因和現(xiàn)象允华。

寫爛代碼很容易

剛?cè)氤绦騿T這行的時(shí)候經(jīng)常聽到一個(gè)觀點(diǎn)：你要把精力放在ABCD（需求文檔/功能設(shè)計(jì)/架構(gòu)設(shè)計(jì)/理解原理）上圈浇，寫代碼只是把想法翻譯成編程語言而已，是一個(gè)沒什么技術(shù)含量的事情靴寂。

當(dāng)時(shí)的我在聽到這種觀點(diǎn)時(shí)會(huì)有一種近似于高冷的不屑：你們就是一群傻X磷蜀，根本不懂代碼質(zhì)量的重要性，這么下去遲早有一天會(huì)踩坑百炬，呸褐隆。

可是幾個(gè)月之后，他們似乎也沒怎么踩坑剖踊。而隨著編程技術(shù)一直在不斷發(fā)展庶弃，帶來了更多的我以前認(rèn)為是傻X的人加入到程序員這個(gè)行業(yè)中來。

語言越來越高級(jí)德澈、封裝越來越完善歇攻，各種技術(shù)都在幫助程序員提高生產(chǎn)代碼的效率，依靠層層封裝梆造，程序員真的不需要了解一丁點(diǎn)技術(shù)細(xì)節(jié)缴守，只要把需求里的內(nèi)容逐行翻譯出來就可以了。

很多程序員不知道要怎么組織代碼镇辉、怎么提升運(yùn)行效率屡穗、底層是基于什么原理，他們寫出來的是在我心目中爛成一坨翔一樣的代碼忽肛。

但是那一坨翔一樣代碼竟然他媽的能正常工作村砂。

即使我認(rèn)為他們寫的代碼是坨翔，但是從不接觸代碼的人的視角來看（比如說你的boss）屹逛，代碼編譯過了磅网，測試過了迫吐，上線運(yùn)行了一個(gè)月都沒出問題，你還想要奢求什么？

所以耙厚，即使不情愿衡楞，也必須承認(rèn)薄疚，時(shí)至今日访诱，寫代碼這件事本身沒有那么難了。

爛代碼終究是爛代碼

但是偶爾有那么幾次，寫爛代碼的人離職了之后诈悍，事情似乎又變得不一樣了祸轮。

想要修改功能時(shí)卻發(fā)現(xiàn)程序里充斥著各種無法理解的邏輯、改完之后莫名其妙的bug一個(gè)接一個(gè)侥钳，接手這個(gè)項(xiàng)目的人開始漫無目的的加班适袜，并且原本一個(gè)挺樂觀開朗的人漸漸的開始喜歡問候別人祖宗了。

我總結(jié)了幾類爛代碼：

意義不明

能力差的程序員容易寫出意義不明的代碼舷夺，他們不知道自己究竟在做什么苦酱。

就像這樣：

對(duì)于這類程序員，我一般建議他們轉(zhuǎn)行给猾。

不說人話

不說人話是新手最經(jīng)常出現(xiàn)的問題疫萤，直接的表現(xiàn)就是寫了一段很簡單的代碼，其他人卻看不懂敢伸。

比如下面這段：

很多程序員喜歡簡單的東西：簡單的函數(shù)名扯饶、簡單的變量名、代碼里翻來覆去只用那么幾個(gè)單詞命名池颈；能縮寫就縮寫尾序、能省略就省略、能合并就合并躯砰。這類人寫出來的代碼里充斥著各種g/s/gos/of/mss之類的全世界沒人懂的縮寫每币，或者一長串不知道在做什么的連續(xù)調(diào)用。

還有很多程序員喜歡復(fù)雜弃揽，各種宏定義脯爪、位運(yùn)算之類寫的天花亂墜则北，生怕代碼讓別人一下子看懂了會(huì)顯得自己水平不夠矿微。

簡單的說，他們的代碼是寫給機(jī)器的尚揣，不是給人看的涌矢。

不恰當(dāng)?shù)慕M織

不恰當(dāng)?shù)慕M織是高級(jí)一些的爛代碼，程序員在寫過一些代碼之后快骗，有了基本的代碼風(fēng)格娜庇，但是對(duì)于規(guī)模大一些的工程的掌控能力不夠，不知道代碼應(yīng)該如何解耦方篮、分層和組織名秀。

這種反模式的現(xiàn)象是經(jīng)常會(huì)看到一段代碼在工程里拷來拷去；某個(gè)文件里放了一大坨堆砌起來的代碼藕溅；一個(gè)函數(shù)堆了幾百上千行匕得；或者一個(gè)簡單的功能七拐八繞的調(diào)了幾十個(gè)函數(shù)，在某個(gè)難以發(fā)現(xiàn)的猥瑣的小角落里默默的調(diào)用了某些關(guān)鍵邏輯。

這類代碼大多復(fù)雜度高汁掠，難以修改略吨，經(jīng)常一改就崩；而另一方面考阱，創(chuàng)造了這些代碼的人傾向于修改代碼翠忠，畏懼創(chuàng)造代碼，他們寧愿讓原本復(fù)雜的代碼一步步變得更復(fù)雜乞榨，也不愿意重新組織代碼秽之。當(dāng)你面對(duì)一個(gè)幾千行的類吃既，問為什么不把某某邏輯提取出來的時(shí)候政溃，他們會(huì)說：

“但是，那樣就多了一個(gè)類了呀态秧《”

假設(shè)和缺少抽象

相對(duì)于前面的例子，假設(shè)這種反模式出現(xiàn)的場景更頻繁申鱼，花樣更多愤诱，始作俑者也更難以自己意識(shí)到問題。比如：

文件路徑變更的時(shí)候捐友，會(huì)把代碼改成這樣：

需要加載的內(nèi)容更豐富的時(shí)候淫半，會(huì)再變成這樣：

之后可能會(huì)再變成這樣：

這類程序員往往是項(xiàng)目組里開發(fā)效率比較高的人，但是大量的業(yè)務(wù)開發(fā)工作導(dǎo)致他們不會(huì)做多余的思考匣砖，他們的口頭禪是：“我每天要做XX個(gè)需求”或者“先做完需求再考慮其他的吧”科吭。

這種反模式表現(xiàn)出來的后果往往是代碼很難復(fù)用，面對(duì)deadline的時(shí)候猴鲫，程序員迫切的想要把需求落實(shí)成代碼对人，而這往往也會(huì)是個(gè)循環(huán)：寫代碼的時(shí)候來不及考慮復(fù)用，代碼難復(fù)用導(dǎo)致之后的需求還要繼續(xù)寫大量的代碼拂共。

一點(diǎn)點(diǎn)積累起來的大量的代碼又帶來了組織和風(fēng)格一致性等問題牺弄，最后形成了一個(gè)新功能基本靠拷的遺留系統(tǒng)。

還有嗎

爛代碼還有很多種類型宜狐，沿著功能-性能-可讀-可測試-可擴(kuò)展這條路線走下去势告，還能看到很多匪夷所思的例子。

那么什么是爛代碼抚恒？個(gè)人認(rèn)為咱台，爛代碼包含了幾個(gè)層次：

如果只是一個(gè)人維護(hù)的代碼，滿足功能和性能要求倒也足夠了俭驮。

如果在一個(gè)團(tuán)隊(duì)里工作回溺，那就必須易于理解和測試，讓其它人員有能力修改各自的代碼。

同時(shí)馅而，越是處于系統(tǒng)底層的代碼祥诽，擴(kuò)展性也越重要。

所以瓮恭，當(dāng)一個(gè)團(tuán)隊(duì)里的底層代碼難以閱讀雄坪、耦合了上層的邏輯導(dǎo)致難以測試、或者對(duì)使用場景做了過多的假設(shè)導(dǎo)致難以復(fù)用時(shí)屯蹦，雖然完成了功能维哈，它依然是坨翔一樣的代碼。

夠用的代碼

而相對(duì)的登澜，如果一個(gè)工程的代碼難以閱讀阔挠，能不能說這個(gè)是爛代碼？很難下定義脑蠕，可能算不上好购撼，但是能說它爛嗎？如果這個(gè)工程自始至終只有一個(gè)人維護(hù)谴仙，那個(gè)人也維護(hù)的很好迂求，那它似乎就成了“夠用的代碼”。

很多工程剛開始可能只是一個(gè)人負(fù)責(zé)的小項(xiàng)目晃跺，大家關(guān)心的重點(diǎn)只是代碼能不能順利的實(shí)現(xiàn)功能揩局、按時(shí)完工。

過上一段時(shí)間掀虎，其他人參與時(shí)才發(fā)現(xiàn)代碼寫的有問題凌盯，看不懂，不敢動(dòng)烹玉。需求方又開始催著上線了驰怎，怎么辦？只好小心翼翼的只改邏輯而不動(dòng)結(jié)構(gòu)春霍，然后在注釋里寫上這么實(shí)現(xiàn)很ugly砸西，以后明白內(nèi)部邏輯了再重構(gòu)。

再過上一段時(shí)間址儒，有個(gè)相似的需求，想要復(fù)用里面的邏輯衅疙，這時(shí)才意識(shí)到代碼里做了各種特定場景的專用邏輯莲趣，復(fù)用非常麻煩。為了趕進(jìn)度只好拷代碼然后改一改饱溢。問題解決了喧伞，問題也加倍了。

幾乎所有的爛代碼都是從“夠用的代碼”演化來的，代碼沒變潘鲫，使用代碼的場景發(fā)生變了翁逞，原本夠用的代碼不符合新的場景，那么它就成了爛代碼溉仑。

重構(gòu)不是萬能藥

程序員最喜歡跟程序員說的謊話之一就是：現(xiàn)在進(jìn)度比較緊挖函，等X個(gè)月之后項(xiàng)目進(jìn)度寬松一些再去做重構(gòu)。

不能否認(rèn)在某些（極其有限的）場景下重構(gòu)是解決問題的手段之一浊竟，但是寫了不少代碼之后發(fā)現(xiàn)怨喘，重構(gòu)往往是程序開發(fā)過程中最復(fù)雜的工作≌穸ǎ花一個(gè)月寫的爛代碼必怜，要花更長的時(shí)間、更高的風(fēng)險(xiǎn)去重構(gòu)后频。

曾經(jīng)經(jīng)歷過幾次忍無可忍的大規(guī)模重構(gòu)梳庆，每一次重構(gòu)之前都是找齊了組里的高手，開了無數(shù)次分析會(huì)卑惜，把組內(nèi)需求全部暫停之后才敢開工靠益，而重構(gòu)過程中往往哀嚎遍野，幾乎每天都會(huì)出上很多意料之外的問題残揉，上線時(shí)也幾乎必然會(huì)出幾個(gè)問題胧后。

從技術(shù)上來說，重構(gòu)復(fù)雜代碼時(shí)抱环，要做三件事：理解舊代碼壳快、分解舊代碼、構(gòu)建新代碼镇草。而待重構(gòu)的舊代碼往往難以理解眶痰；模塊之間過度耦合導(dǎo)致牽一發(fā)而動(dòng)全身，不易控制影響范圍梯啤；舊代碼不易測試導(dǎo)致無法保證新代碼的正確性竖伯。

這里還有一個(gè)核心問題，重構(gòu)的復(fù)雜度跟代碼的復(fù)雜度不是線性相關(guān)的因宇。比如有1000行爛代碼七婴，重構(gòu)要花1個(gè)小時(shí)，那么5000行爛代碼的重構(gòu)可能要花2察滑、3天打厘。要對(duì)一個(gè)失去控制的工程做重構(gòu)，往往還不如重寫更有效率贺辰。

而拋開具體的重構(gòu)方式户盯，從受益上來說嵌施，重構(gòu)也是一件很麻煩的事情：它很難帶來直接受益，也很難量化莽鸭。這里有個(gè)很有意思的現(xiàn)象吗伤，基本關(guān)于重構(gòu)的書籍無一例外的都會(huì)有獨(dú)立的章節(jié)介紹“如何向boss說明重構(gòu)的必要性”。

重構(gòu)之后能提升多少效率硫眨？能降低多少風(fēng)險(xiǎn)足淆？很難答上來，爛代碼本身就不是一個(gè)可以簡單的標(biāo)準(zhǔn)化的東西捺球。

舉個(gè)例子缸浦，一個(gè)工程的代碼可讀性很差，那么它會(huì)影響多少開發(fā)效率氮兵？

你可以說：之前改一個(gè)模塊要3天裂逐，重構(gòu)之后1天就可以了。但是怎么應(yīng)對(duì)“不就是做個(gè)數(shù)據(jù)庫操作嗎為什么要3天”這類問題泣栈？爛代碼“爛”的因素有不確定性卜高、開發(fā)效率也因人而異，想要證明這個(gè)東西“確實(shí)”會(huì)增加兩天開發(fā)時(shí)間南片，往往反而會(huì)變成“我看了3天才看懂這個(gè)函數(shù)是做什么的”或者“我做這么簡單的修改要花3天”這種神經(jīng)病才會(huì)去證明的命題掺涛。

而另一面，許多技術(shù)負(fù)責(zé)人也意識(shí)到了代碼質(zhì)量和重構(gòu)的必要性疼进，“那就重構(gòu)嘛”薪缆，或者“如果看到問題了，那就重構(gòu)”伞广。上一個(gè)問題解決了拣帽，但實(shí)際上關(guān)于重構(gòu)的代價(jià)和收益仍然是一筆糊涂賬，在沒有分配給你更多資源嚼锄、沒有明確的目標(biāo)减拭、沒有具體方法的情況下，很難想象除了有代碼潔癖的人還有誰會(huì)去執(zhí)行這種莫名其妙的任務(wù)区丑。

于是往往就會(huì)形成這種局面：

不寫代碼的人認(rèn)為應(yīng)該重構(gòu)拧粪，重構(gòu)很簡單，無論新人還是老人都有責(zé)任做重構(gòu)沧侥。

寫代碼老手認(rèn)為應(yīng)該遲早應(yīng)該重構(gòu)可霎，重構(gòu)很難，現(xiàn)在湊合用正什，這事別落在我頭上啥纸。

寫代碼的新手認(rèn)為不出bug就謝天謝地了，我也不知道怎么重構(gòu)婴氮。

寫好代碼很難

與寫出爛代碼不同的是斯棒，想寫出好代碼有很多前提：

理解要開發(fā)的功能需求。

了解程序的運(yùn)行原理主经。

做出合理的抽象荣暮。

組織復(fù)雜的邏輯。

對(duì)自己開發(fā)效率的正確估算罩驻。

持續(xù)不斷的練習(xí)穗酥。

寫出好代碼的方法論很多，但我認(rèn)為寫出好代碼的核心反而是聽起來非常low的“持續(xù)不斷的練習(xí)”惠遏。這里就不展開了砾跃，留到下篇再說。

很多程序員在寫了幾年代碼之后并沒有什么長進(jìn)节吮，代碼仍然爛的讓人不忍直視抽高，原因有兩個(gè)主要方面：

環(huán)境是很重要的因素之一，在爛代碼的熏陶下很難理解什么是好代碼透绩，知道的人大部分也會(huì)選擇隨波逐流翘骂。

還有個(gè)人性格之類的說不清道不明的主觀因素，寫出爛代碼的程序員反而都是一些很好相處的人帚豪，他們往往熱愛公司團(tuán)結(jié)同事平易近人工作任勞任怨–只是代碼很爛而已碳竟。

而工作幾年之后的人很難再說服他們?nèi)ヌ岣叽a質(zhì)量，你只會(huì)反復(fù)不斷的聽到：“那又有什么用呢狸臣？”或者“以前就是這么做的坝ㄎΑ？”之類的說法烛亦。

那么從源頭入手诈泼，提高招人時(shí)對(duì)代碼的質(zhì)量的要求怎么樣？

前一陣面試的時(shí)候增加了白板編程此洲、最近又增加了上機(jī)編程的題目厂汗。發(fā)現(xiàn)了一個(gè)現(xiàn)象：一個(gè)人工作了幾年、做過很多項(xiàng)目呜师、帶過團(tuán)隊(duì)娶桦、發(fā)了一些文章，不一定能代表他代碼寫的好汁汗；反之衷畦，一個(gè)人代碼寫的好，其它方面的能力一般不會(huì)太差知牌。

舉個(gè)例子祈争，最近喜歡用“寫一個(gè)代碼行數(shù)統(tǒng)計(jì)工具”作為面試的上機(jī)編程題目。很多人看到題目之后第一反映是角寸，這道題太簡單了菩混，這不就是寫寫代碼嘛忿墅。

從實(shí)際效果來看，這道題識(shí)別度卻還不錯(cuò)沮峡。

首先疚脐，題目足夠簡單，即使沒有看過《面試寶典》之類書的人也不會(huì)吃虧邢疙。而題目的擴(kuò)展性很好棍弄，即使提前知道題目，配合不同的條件疟游，可以變成不同的題目呼畸。比如要求按文件類型統(tǒng)計(jì)行數(shù)、或者要求提高統(tǒng)計(jì)效率颁虐、或者統(tǒng)計(jì)的同時(shí)輸出某些單詞出現(xiàn)的次數(shù)蛮原，等等。

從考察點(diǎn)來看聪廉，首先是基本的樹的遍歷算法瞬痘；其次有一定代碼量，可以看出程序員對(duì)代碼的組織能力板熊、對(duì)問題的抽象能力框全；上機(jī)編碼可以很簡單的看出應(yīng)聘者是不是很久沒寫程序了；還包括對(duì)于程序易用性和性能的理解干签。

最重要的是津辩，最后的結(jié)果是一個(gè)完整的程序，我可以按照日常工作的標(biāo)準(zhǔn)去評(píng)價(jià)程序員的能力容劳，而不是從十幾行的函數(shù)里意淫這個(gè)人在日常工作中大概會(huì)有什么表現(xiàn)喘沿。

但即使這樣，也很難拍著胸脯說竭贩，這個(gè)人寫的代碼質(zhì)量沒問題蚜印。畢竟面試只是代表他有寫出好代碼的能力，而不是他將來會(huì)寫出好代碼留量。

悲觀的結(jié)語

說了那么多窄赋，結(jié)論其實(shí)只有兩條，作為程序員：

不要奢望其他人會(huì)寫出高質(zhì)量的代碼

不要以為自己寫出來的是高質(zhì)量的代碼