1寫(xiě)代碼很簡(jiǎn)單，但寫(xiě)好代碼很難

編程曾經(jīng)是一項(xiàng)門(mén)檻很高的專業(yè)技能。從前，一個(gè)普通人想學(xué)編程，最常見(jiàn)的做法就是通過(guò)教材和書(shū)本學(xué)習(xí)。不過(guò)大部分編程專業(yè)書(shū)，十分艱深晦澀，對(duì)于初學(xué)者來(lái)說(shuō)很不友好。因此不少人在嘗到編程的樂(lè)趣前，就早早地半途而廢。

但如今，學(xué)編程正在變得越來(lái)越容易。學(xué)習(xí)不再像以前那樣，只能硬啃書(shū)本，而是多了許多新途徑。觀看教學(xué)視頻、參加 Codecademy 的交互式課程，甚至直接在 CodeCombat 通過(guò)玩游戲來(lái)學(xué)編程，每個(gè)人都能找到適合自己的學(xué)習(xí)方式。

“媽，我真沒(méi)在玩游戲，我在學(xué)編程呢！你看屏幕右邊！”

此外，編程語(yǔ)言也在變得越來(lái)越易用。經(jīng)典的 C 和 Java 不再是大多數(shù)初學(xué)者的首選，許多更簡(jiǎn)單、更易上手的動(dòng)態(tài)類型語(yǔ)言如今大受歡迎，與之相關(guān)的 IDE 等工具也變得越來(lái)越完善。這些因素進(jìn)一步降低了編程的學(xué)習(xí)門(mén)檻。

總而言之，編程早已褪去了它的神秘面紗，從只有少數(shù)人才能掌握的神秘技能，變成了一門(mén)人人皆可學(xué)習(xí)的普通手藝。

但更低的學(xué)習(xí)門(mén)檻、更友好的編程語(yǔ)言，并不意味著人人都能寫(xiě)出一手好代碼。如果你已經(jīng)工作，參與過(guò)一些項(xiàng)目，那我很想問(wèn)你一個(gè)問(wèn)題：”你日常接觸的這些項(xiàng)目的代碼質(zhì)量如何？是好代碼多，還是爛代碼多？”

不知你會(huì)怎么回答，我先來(lái)說(shuō)說(shuō)我的答案。

好代碼還是很少

2010 年，我跳槽到了一家總部位于北京五道口的大型互聯(lián)網(wǎng)公司。

加入這家公司前，我只在十人規(guī)模的小公司待過(guò)，因此，我對(duì)新公司在各方面都有著很高的期待，尤其是軟件質(zhì)量方面。當(dāng)時(shí)，我心里想的大概是這樣：“這可是支撐了有著千萬(wàn)用戶量的產(chǎn)品的‘大’項(xiàng)目，代碼質(zhì)量跟之前那些比，肯定有質(zhì)的飛躍吧！”

等到在新公司工作了一周后，我才發(fā)現(xiàn)自己實(shí)在是錯(cuò)得離譜。所謂“大”項(xiàng)目的代碼質(zhì)量同我的預(yù)期相去甚遠(yuǎn)。打開(kāi) IDE，數(shù)百行的函數(shù)和神秘的數(shù)字字面量比比皆是，開(kāi)發(fā)任何一個(gè)小需求都難如登天。

后來(lái)，在待過(guò)更多公司，接觸了更多軟件項(xiàng)目后，我總結(jié)出一個(gè)道理：不論公司多大、項(xiàng)目多牛，在實(shí)際工作中遇見(jiàn)好代碼，仍然是小概率事件。

好代碼有哪些要素？

話說(shuō)回來(lái)，到底怎樣的代碼才算是好代碼？在這方面，Martin Fowler 有一句話常被大家引用：

“Any fool can write code that a computer can understand. Good programmers write code that humans can understand.”

“任何傻瓜都能寫(xiě)出計(jì)算機(jī)能理解的代碼。優(yōu)秀程序員寫(xiě)人類能理解的代碼?！?/p>

我認(rèn)為它可以作為評(píng)價(jià)好代碼的原點(diǎn)：好代碼一定是可讀、易讀，且容易理解的。寫(xiě)出好代碼的第一原則，就是把人類讀者放在第一位。

除了可讀性以外，評(píng)價(jià)代碼好壞還有許多其他維度：

貼合編程語(yǔ)言：是否使用了當(dāng)前編程語(yǔ)言的推薦寫(xiě)法？語(yǔ)言特性和語(yǔ)法糖，使用程度是否恰到好處？

貼合編程語(yǔ)言：是否使用了當(dāng)前編程語(yǔ)言的推薦寫(xiě)法？語(yǔ)言特性和語(yǔ)法糖，使用程度是否恰到好處？

易于修改：代碼設(shè)計(jì)是否考慮了未來(lái)的需求變更，當(dāng)變化發(fā)生時(shí)，代碼是否容易隨之修改？

API 設(shè)計(jì)合理：API 設(shè)計(jì)是否合理，易于使用？好的 API 在簡(jiǎn)單場(chǎng)景下使用方便，在高級(jí)場(chǎng)景下又可以隨需求擴(kuò)展。

性能夠用：代碼性能是否滿足當(dāng)前業(yè)務(wù)需求，同時(shí)為未來(lái)保留了一定提升空間？

避免過(guò)度設(shè)計(jì)：代碼是否存在過(guò)度設(shè)計(jì)、過(guò)早優(yōu)化的毛?。?/p>

…

總而言之，對(duì)于任何層級(jí)的程序員來(lái)說(shuō)，好代碼都不是什么唾手可得的東西。要寫(xiě)出好代碼，需要在許多維度上反復(fù)權(quán)衡、精心設(shè)計(jì)，最后再加以持續(xù)打磨。

既然如此，假如想盡快掌握寫(xiě)代碼這門(mén)手藝，有捷徑嗎？

寫(xiě)好代碼的捷徑

在許多層面上，我認(rèn)為編程和寫(xiě)作非常相似。二者都是使用文本和符號(hào)來(lái)表達(dá)思想，只是方式略有不同。

談到寫(xiě)作，我想問(wèn)一個(gè)關(guān)于作家的問(wèn)題：“你聽(tīng)說(shuō)過(guò)不讀書(shū)的作家嗎？你有沒(méi)有聽(tīng)到過(guò)某位作家說(shuō)，他從來(lái)不讀其他人的作品，只讀自己的東西？”。我猜答案應(yīng)該是否定的吧。

如果你去查閱相關(guān)資料，你會(huì)發(fā)現(xiàn)許多職業(yè)作家的日常生活，就是閱讀和寫(xiě)作兩件事在不斷循環(huán)。他們每天會(huì)花大量時(shí)間閱讀各類文字，然后再寫(xiě)作。

同樣是“文字工作者”，程序員們就很少重視閱讀。但要想快速提升編程能力，閱讀正是不可或缺的重要一環(huán)。除了日常工作接觸到的項(xiàng)目以外，我們應(yīng)該更多地閱讀那些經(jīng)典軟件項(xiàng)目，從中學(xué)習(xí) API 設(shè)計(jì)、模塊架構(gòu)和代碼編寫(xiě)的技巧。

不光代碼和技術(shù)文檔，最好再定期讀一些計(jì)算機(jī)方面的專業(yè)書(shū)，保持閱讀書(shū)籍的習(xí)慣。在這方面，我認(rèn)為 Jeff Atwood 在 15 年前寫(xiě)的文章 "Programmers Don't Read Books -- But You Should（都說(shuō)程序員不讀書(shū)——但你應(yīng)該讀）"，如今讀來(lái)仍不過(guò)時(shí)。

提升編程能力的捷徑，就藏在“閱讀 <-> 編程”這個(gè)無(wú)盡循環(huán)里。

“一個(gè)好的程序員應(yīng)該做什么？”

2編程的精髓是“創(chuàng)造”

在程序員的日常工作中，有很多事情會(huì)讓人充滿成就感，甚至情不自禁地感嘆“編程真美好”。比方說(shuō)，修復(fù)了一個(gè)極難定位的 Bug，用新算法將代碼性能提升了一倍，等等。但在所有的這類事情當(dāng)中，沒(méi)有任何一件，能和“親手創(chuàng)造出一件東西”相比。

當(dāng)你在編程時(shí)，創(chuàng)造新事物的機(jī)會(huì)實(shí)際上隨處可見(jiàn)。因?yàn)椴⒎侵挥邪l(fā)布一個(gè)新軟件，才稱得上是“創(chuàng)造”。寫(xiě)一個(gè)可復(fù)用的工具函數(shù)、設(shè)計(jì)一套清晰的數(shù)據(jù)模型，全都可以歸入“創(chuàng)造”的范疇。

身為程序員，保持對(duì)“創(chuàng)造”的熱情至關(guān)重要。因?yàn)樗梢詭臀覀儯?/p>

更高效地學(xué)習(xí)：學(xué)習(xí)一門(mén)新技術(shù)，最高效的方式就是用它開(kāi)發(fā)一個(gè)真實(shí)項(xiàng)目，在創(chuàng)造的過(guò)程中學(xué)習(xí)，效果最好。

有機(jī)會(huì)邂逅了不起的東西：許多改變世界的開(kāi)源軟件，最初都是作者純粹出于興趣所創(chuàng)造，比如 Linus Torvalds 和 Linux，Guido van Rossum 和 Python。

1989 年的圣誕假期，荷蘭人 Guido van Rossum 敲下了 Python 語(yǔ)言的最初幾行代碼，Python 最初僅被期望作為 ABC 語(yǔ)言的繼承者，但后來(lái)“吞噬”了全世界

雖然“創(chuàng)造”好處多多，程序員們也有大把機(jī)會(huì)去做，但許多人常常缺少一種身為“創(chuàng)造者”的覺(jué)悟。就像那個(gè)廣為流傳的小故事所說(shuō)：一位哲學(xué)家詢問(wèn)正在砌磚的工人，有人清楚地知道自己是在建造一座大教堂，有人卻認(rèn)為自己只是在砌磚。很多程序員正是“只見(jiàn)磚塊，不見(jiàn)教堂”。

將自己定位成創(chuàng)造者后，看待事物的方式就會(huì)發(fā)生天翻地覆的變化。舉個(gè)例子，同樣是給 API 增加報(bào)錯(cuò)提示文字，創(chuàng)造者們就能跳出“快速完成需求就好”的思維陷阱，向前一步，追問(wèn)自己一些更重要的問(wèn)題：“我想為用戶創(chuàng)造什么樣的產(chǎn)品體驗(yàn)？怎樣的報(bào)錯(cuò)文字，更能幫助我達(dá)成該目標(biāo)？”

就像任何一個(gè)有用的編程模式一樣，“創(chuàng)造者思維”也能成為你的職業(yè)生涯的一道巨大推進(jìn)力。因此，現(xiàn)在就試著問(wèn)自己一個(gè)問(wèn)題吧——“我的下一份創(chuàng)造會(huì)是什么？”

3打造高效試錯(cuò)的環(huán)境至關(guān)重要

我曾參與開(kāi)發(fā)過(guò)一個(gè)互聯(lián)網(wǎng)產(chǎn)品，它設(shè)計(jì)精美、功能豐富，每天都有大量用戶使用。

但就是這么一個(gè)從市場(chǎng)角度看頗為成功的產(chǎn)品，工程質(zhì)量卻非常糟糕。如果你打開(kāi)它的后端項(xiàng)目，把所有目錄翻個(gè)底朝天，都找不到任何一行單元測(cè)試代碼，其他自動(dòng)化測(cè)試流程也是無(wú)從談起。而業(yè)務(wù)邏輯偏偏又十分復(fù)雜，最后，項(xiàng)目代碼間的意料耦合多如牛毛，開(kāi)發(fā)一個(gè)新特性很容易把舊功能給搞掛。

“在忙啥呢？” “試著修復(fù)我之前修一個(gè)問(wèn)題時(shí)搞出來(lái)的問(wèn)題，那問(wèn)題是我之前解決另一個(gè)問(wèn)題搞出來(lái)的，而那個(gè)問(wèn)題又是我……”

因此，項(xiàng)目每次發(fā)布時(shí)，開(kāi)發(fā)和產(chǎn)品同學(xué)全都得嚴(yán)陣以待，氛圍十分緊張。整個(gè)發(fā)布過(guò)程也很刺激，緊急回滾時(shí)有發(fā)生。一個(gè)人在這樣的環(huán)境中工作，技術(shù)成長(zhǎng)拋開(kāi)不談，心理素質(zhì)肯定能得到極大鍛煉。

編程原本是一件充滿樂(lè)趣的工作，但為這樣的項(xiàng)目編程，樂(lè)趣根本無(wú)從談起。究竟是什么奪走了編程的樂(lè)趣？

理想的編程體驗(yàn)≈“刷題”

LeetCode 是一個(gè)著名的編程學(xué)習(xí)網(wǎng)站，上面提供了許多覆蓋各個(gè)難度的編程題，大部分與算法相關(guān)。用戶可以選擇自己感興趣的題目，直接在瀏覽器上編寫(xiě)代碼（支持十幾種編程語(yǔ)言）并執(zhí)行。如果通過(guò)了全部的測(cè)試用例，則算作解答成功。

在 LeetCode 上做題

在 LeetCode 刷題很像在玩游戲，富有挑戰(zhàn)性，同時(shí)也很有趣。整個(gè)做題過(guò)程，實(shí)際完美展現(xiàn)了一種理想化的編程體驗(yàn)：

關(guān)注點(diǎn)分離：每道題目都是一個(gè)獨(dú)立個(gè)體，同一時(shí)間內(nèi)，開(kāi)發(fā)者可以完全沉浸在一道題目中；

快速獲得精準(zhǔn)反饋：開(kāi)發(fā)者每次調(diào)整代碼后，能通過(guò)自動(dòng)化測(cè)試快速獲得結(jié)果反饋；

零成本試錯(cuò)：寫(xiě)出的代碼語(yǔ)法有錯(cuò)誤、邏輯有問(wèn)題，沒(méi)有任何不良后果，心理負(fù)擔(dān)小。

不過(guò)，屏幕前的你很可能覺(jué)得我在說(shuō)些廢話。

“不然呢？解算法題、寫(xiě)小腳本，不就是這樣的體驗(yàn)嗎？有啥特別值得說(shuō)的？”你很可能會(huì)繼續(xù)補(bǔ)充道，“你知道我們公司的項(xiàng)目有多復(fù)雜嗎？規(guī)模超大，模塊巨多，你懂我意思嗎？每天服務(wù) ××× 萬(wàn)人，光數(shù)據(jù)庫(kù)就好幾套，消息隊(duì)列都有三種，開(kāi)發(fā)起來(lái)當(dāng)然要麻煩一點(diǎn)咯！”

確實(shí)，全世界的軟件千差萬(wàn)別，開(kāi)發(fā)起來(lái)不可能都像在 LeetCode 上刷題一樣輕松愉快。但這并不意味著，我們不應(yīng)該努力改善自己身處的編程環(huán)境，哪怕只有一點(diǎn)點(diǎn)。

要通過(guò)改善環(huán)境來(lái)提升編程體驗(yàn)，可用的理念和工具包括：

模塊化思想：妥善設(shè)計(jì)項(xiàng)目中的每一個(gè)模塊，降低耦合，提升正交性

設(shè)計(jì)原則：微觀層面上，應(yīng)用那些經(jīng)典的設(shè)計(jì)原則和模式，比如“SOLID”原則

自動(dòng)化測(cè)試：編寫(xiě)規(guī)范的單元測(cè)試，必要時(shí)使用 Mock 技術(shù)，用自動(dòng)化測(cè)試覆蓋業(yè)務(wù)關(guān)鍵路徑

縮短反饋回路：切換編譯速度更快的工具，優(yōu)化單測(cè)性能，竭盡全力縮短從“改完代碼”到“獲得反饋”的等待時(shí)間

微服務(wù)架構(gòu)：必要時(shí)，將大單體拆分為多個(gè)職責(zé)各異的微服務(wù)，分散復(fù)雜度

……

關(guān)注編程環(huán)境，刻意創(chuàng)造出允許高效試錯(cuò)的“代碼樂(lè)園”，讓工作像刷題一樣輕松愉快。是經(jīng)驗(yàn)豐富的程序員能為自身團(tuán)隊(duì)做出的最好貢獻(xiàn)之一。

4避開(kāi)代碼完美主義陷阱

在代碼質(zhì)量上精益求精是好事，但也要注意別掉進(jìn)完美主義的陷阱。因?yàn)榫幊滩皇撬囆g(shù)創(chuàng)作，不鼓勵(lì)人們無(wú)限度地追求極致。作家大可花上數(shù)年打磨一本傳世之作，但程序員在代碼上鉆牛角尖就很有問(wèn)題。

世間沒(méi)有完美的代碼。大多數(shù)時(shí)候，你的代碼只要能滿足當(dāng)前需求，又為未來(lái)擴(kuò)展留了一些空間就夠了。有那么幾次，我在簡(jiǎn)歷上看到候選人給自己打著“代碼強(qiáng)迫癥”標(biāo)簽。隔著屏幕，我雖能感受到 TA 對(duì)代碼質(zhì)量的那份重視，但在我心底，其實(shí)更期望 TA 早已將完美主義陷阱遠(yuǎn)遠(yuǎn)甩在了后頭。

5技術(shù)很重要，但“人”也許更重要

在軟件開(kāi)發(fā)領(lǐng)域，“單一職責(zé)原則”（全稱為 Single responsibility principle，后簡(jiǎn)稱為 SRP）是一條非常著名的設(shè)計(jì)原則。它的定義很簡(jiǎn)單，一句話就可以概括：“每個(gè)軟件模塊應(yīng)該只有一個(gè)被修改的理由”。

單一職責(zé)原則：能做到，并不意味著你就該這么做

要掌握 SRP 原則，關(guān)鍵在于搞清楚“被修改的理由”為何物。很顯然，程序是沒(méi)有生命的，它自身不能也不需要主動(dòng)去改變。任何修改程序的理由，都來(lái)自與之相關(guān)的人，人是導(dǎo)致修改的“罪魁禍?zhǔn)住薄?/p>

舉個(gè)簡(jiǎn)單的例子?？纯聪旅孢@兩個(gè)類，其中哪一個(gè)違反了 SRP 原則？

一個(gè)字典數(shù)據(jù)類，支持兩類操作：存數(shù)據(jù)、取數(shù)據(jù)；

一個(gè)員工資料類，支持兩類操作：更新個(gè)人信息、渲染一張用戶資料卡片圖。

在大多數(shù)人眼里，第一個(gè)例子沒(méi)問(wèn)題，但第二個(gè)例子卻明顯違反了 SRP 原則。要得出該結(jié)論，好像無(wú)需任何嚴(yán)格的分析和證明，運(yùn)用一丁點(diǎn)直覺(jué)即可。但假如做一些正經(jīng)分析，第二個(gè)例子的可疑之處，在于能為其輕松找出兩個(gè)不同的修改理由：

管理員認(rèn)為資料中的“個(gè)人電話”字段不能有非法號(hào)碼，需增加簡(jiǎn)單的校驗(yàn)邏輯；

某員工認(rèn)為資料卡片圖上的“名字”部分太小，希望加大字體。

”It is people who request changes. And you don’t want to confuse those people, or yourself, by mixing together the code that many different people care about for different reasons.” ——“The Single Responsibility Principle”

“是人在要求軟件變更。你絕不想把那些不同人出于不同原因所關(guān)心的代碼混在一起，這樣只會(huì)把他們和你自己搞糊涂?！薄皢我宦氊?zé)原則”

理解 SRP 原則的關(guān)鍵，在于先理解人以及人在軟件開(kāi)發(fā)中所扮演的角色。

再舉一個(gè)例子。微服務(wù)架構(gòu)是近些年很火的一個(gè)技術(shù)話題。但許多人在討論它時(shí)，往往只關(guān)注技術(shù)本身，卻忽視了微服務(wù)架構(gòu)與人之間的關(guān)系。

將微服務(wù)架構(gòu)風(fēng)格與其他東西區(qū)分開(kāi)的關(guān)鍵，在于將大單體拆分為獨(dú)立的微服務(wù)后，不同模塊間的邊界可以變得更清晰。跟數(shù)百人的團(tuán)隊(duì)一同維護(hù)著一個(gè)大單體比起來(lái)，許多小組織各自維護(hù)著獨(dú)立的微服務(wù)，明顯擁有更高的運(yùn)作效率。

如果缺少了特定的組織規(guī)模（也就是“人”）作為前提，空談微服務(wù)的各種技術(shù)優(yōu)勢(shì)和那些花活，純屬本末倒置。

技術(shù)當(dāng)然很重要。身為技術(shù)人員，那一張張瑰麗的架構(gòu)圖和獨(dú)具匠心的代碼細(xì)節(jié)，天然吸引著我們的注意力。但是，也請(qǐng)千萬(wàn)不要對(duì)軟件開(kāi)發(fā)里的另一個(gè)重要因素“人”視而不見(jiàn)。必要時(shí)，轉(zhuǎn)換一下看事情的角度（從“技術(shù)”轉(zhuǎn)向“人”），那樣對(duì)你大有裨益。

6求知若渴是好事，但也要注意方法

如今人人都在說(shuō)“終身學(xué)習(xí)”，而程序員是一個(gè)尤其需要終身學(xué)習(xí)的職業(yè)。因?yàn)橛?jì)算機(jī)技術(shù)的迭代更新非常快，某個(gè)三年前流行的框架或編程語(yǔ)言，很可能一個(gè)月前已經(jīng)過(guò)時(shí)。

一分鐘之內(nèi)會(huì)發(fā)生什么事情？Netflix 觀看時(shí)間增長(zhǎng) 70,000 小時(shí)；Snapchat 上有三百萬(wàn)視頻被觀看；Google 新增兩百四十萬(wàn)次搜索；一個(gè) JS 新框架被發(fā)明（這條不是真的


審核編輯黃宇