前言

《代碼整潔之道》在業(yè)內(nèi)有很高的知名度，被諸多前輩推薦給后來者閱讀。本書以循序漸進(jìn)改造一個(gè)小程序的方式，演示了一個(gè)程序可能的各種設(shè)計(jì)（在代碼層面）。手把手教你該怎么設(shè)計(jì)代碼，為何要這樣設(shè)計(jì)，這樣設(shè)計(jì)的好處是什么。通過一周的閱讀，總結(jié)了如下要點(diǎn)。

一 函數(shù)

所有的編程都是從HellWorld這個(gè)小函數(shù)開始的，學(xué)會(huì)設(shè)計(jì)函數(shù)非常重要

1. 函數(shù)要短。短才方便閱讀、維護(hù)和設(shè)計(jì)。(每個(gè)人都經(jīng)歷過讀不懂自己代碼的尷尬)
2. 函數(shù)只做一件事。依照單一職責(zé)原則設(shè)計(jì)函數(shù)。一個(gè)函數(shù)可以:流程控制，邏輯判斷，改變變量狀態(tài)，以及做運(yùn)算，或者調(diào)用多個(gè)下一抽象級的函數(shù)。
3. 函數(shù)分解成多個(gè)抽象層級設(shè)計(jì)，高層函數(shù)只調(diào)用下次層函數(shù)，呈樹狀圖，層層封裝。
4. 函數(shù)不應(yīng)該有標(biāo)識參數(shù)(除了作為API的函數(shù))，這意味著函數(shù)有至少兩種執(zhí)行方式，違反了第2條原則。而且明顯能拆成多個(gè)小函數(shù)。
5. 函數(shù)參數(shù)越少越好有，多個(gè)參數(shù)應(yīng)該封裝成一個(gè)整體傳入的。如果邏輯上不是一個(gè)整體，則函數(shù)肯定能被拆成多個(gè)小函數(shù)然后被分別調(diào)用。第4條標(biāo)識參數(shù)可以封裝進(jìn)整體傳入函數(shù)，而不是直接作為函數(shù)的參數(shù)
6. 函數(shù)真的最好只做一件事，不要為了一時(shí)方便順手加幾行代碼。如登錄驗(yàn)證時(shí)，函數(shù)用來驗(yàn)證username和password，在驗(yàn)證之后順便給用戶初始化些其他東西。會(huì)導(dǎo)致這個(gè)函數(shù)在其他時(shí)候無法驗(yàn)證用戶信息。
7. 底層函數(shù)不應(yīng)該改變參數(shù)狀態(tài)，如果想改變某類的狀態(tài)，就把該函數(shù)加入該類，讓它自己調(diào)用函數(shù)。如：把改變類x的狀態(tài)的函數(shù)調(diào)用addFooter(x)，改為x.addFooter()。
8. 函數(shù)不要返回錯(cuò)誤碼，這需要你有錯(cuò)誤碼的枚舉類，并且違反了開放封閉原則（你需要加入新錯(cuò)誤碼來擴(kuò)展新錯(cuò)誤），直接拋出異常就好了。（可以通過繼承父異常來擴(kuò)展）。但是實(shí)際上錯(cuò)誤碼的應(yīng)用不比異常少，而且異常也會(huì)導(dǎo)致代碼的臃腫。
9. 函數(shù)名稱應(yīng)該描述清楚函數(shù)作用，避免頻繁去看文檔，這對于短小的函數(shù)來說不難辦到，如果很難命名可能需要思考函數(shù)是否有依照以上原則設(shè)計(jì)(你一個(gè)函數(shù)可能做了很多事情)。并且名稱的命名應(yīng)該不容易與其他函數(shù)名稱形成混淆。如：add()在calculator中意思是加，而在List中就不應(yīng)該用add表示插入集合了，應(yīng)該用insert或append。簡單來說就是一個(gè)概念對應(yīng)一個(gè)詞，并且始終如一。

二 格式

每個(gè)人都有自己的編碼風(fēng)格，書中總結(jié)了一些Java及其他語言的建議

1. 好的格式應(yīng)該由小且精的代碼片段（函數(shù)）組成
2. 封包代碼，導(dǎo)包代碼，成員變量，函數(shù)方法。都用空行隔開，形成分開的代碼塊
3. 函數(shù)按調(diào)用順序從上到下排列，類變量在頂端聲明，方法變量在使用前聲明
4. 一行代碼不超過100個(gè),同一行的計(jì)算可以按先后順序用空格隔開，如：
5. 100 * 732 / (2+3) * (5-1)
6. 小括號內(nèi)的運(yùn)算全都擠在了一起，其他運(yùn)算都有空格隔開，很容易看出運(yùn)算順序
7. 縮進(jìn)代表了一種包含關(guān)系。Java沒有強(qiáng)制要求，但是python就是用縮進(jìn)表示包含。
8. 說了這么多最后總結(jié)道：老大規(guī)定用啥格式就用啥格式

三 注釋

其實(shí)注釋寫了后，看的最多的還是自己

1. 好代碼只需要少量注釋，代碼就能表達(dá)意圖——回到之前的內(nèi)容，這要求我們寫小且精的函數(shù)。（但這不是你不寫注釋的理由）
2. 好的注釋應(yīng)該是這樣的。如：對抽象意圖或者深遠(yuǎn)意義的解釋（如我這個(gè)函數(shù)為啥用這個(gè)方法實(shí)現(xiàn)）；闡述長且難讀的函數(shù)（這種難讀不是因?yàn)榇a寫得爛，而是業(yè)務(wù)邏輯復(fù)雜）；警示一些關(guān)鍵重要的部分（這些部分一般是函數(shù)會(huì)改變某些數(shù)據(jù)實(shí)體）；TODO注釋提醒并告知未來要做的事；學(xué)著公共API的JAVADOC寫就是好注釋（雖然也有少數(shù)爛注釋）；
3. 爛的注釋往往是這樣的。如：多余的注釋（簡單函數(shù)強(qiáng)行加上注釋，讀源碼會(huì)比注釋更快）；誤導(dǎo)的注釋（注釋本來就是錯(cuò)的，可能源自你更新了代碼沒更新注釋——小函數(shù)特別可能出現(xiàn)這個(gè)問題）；注釋掉的代碼（你為何不刪了代碼？）；廢話太多的注釋（語文是體育老師教的）。

四 類

書中對于函數(shù)的設(shè)計(jì)其實(shí)和類的設(shè)計(jì)思想是類似的，所以類應(yīng)該功能單一且小巧，越小耦合性越低，最后用門面模式組合起來向外提供API就好了

五 系統(tǒng)

系統(tǒng)整體結(jié)構(gòu)的設(shè)計(jì)

1. 把系統(tǒng)的整體構(gòu)造和業(yè)務(wù)使用分開。不要讓構(gòu)造影響使用，也不要讓程序的運(yùn)行反過來影響構(gòu)造。這也是Spring這么應(yīng)用廣泛的原因之一，Spring Core就是個(gè)類容器。
2. 把業(yè)務(wù)邏輯和檢查或日志方案分離，不然糾纏在一起的代碼會(huì)很難看懂和修改。Spring AOP也解決了這個(gè)問題。

六 測試

測試不僅僅是測試小姐姐的事情

1. 測試函數(shù)（方法）也應(yīng)該短?。ㄈ绻瘮?shù)原本夠小的話測試函數(shù)自然會(huì)?。?/li>
2. 每個(gè)類最好都測試下，測試時(shí)間會(huì)比以后debug時(shí)間少。從底層函數(shù)一點(diǎn)點(diǎn)測上去，以后debug能迅速定位。
3. 測試類應(yīng)該保存下來，方便每次修改后進(jìn)行測試