《代碼整潔之道》總結和筆記

前言

《代碼整潔之道》在業內有很高的知名度，被諸多前輩推薦給後來者閱讀。本書以按部就班改造一個小程序的方式，演示了一個程序可能的各類設計（在代碼層面）。手把手教你該怎麼設計代碼，爲什麼要這樣設計，這樣設計的好處是什麼。經過一週的閱讀，總結了以下要點。

一 函數

全部的編程都是從HellWorld這個小函數開始的，學會設計函數很是重要

1. 函數要短。短才方便閱讀、維護和設計。(每一個人都經歷過讀不懂本身代碼的尷尬)

2. 函數只作一件事。依照單一職責原則設計函數。一個函數能夠:流程控制，邏輯判斷，改變變量狀態，以及作運算，或者調用多個下一抽象級的函數。

3. 函數分解成多個抽象層級設計，高層函數只調用下次層函數，呈樹狀圖，層層封裝。

4. 函數不該該有標識參數(除了做爲API的函數)，這意味着函數有至少兩種執行方式，違反了第2條原則。並且明顯能拆成多個小函數。

5. 函數參數越少越好有，多個參數應該封裝成一個總體傳入的。若是邏輯上不是一個總體，則函數確定能被拆成多個小函數而後被分別調用。第4條標識參數能夠封裝進總體傳入函數，而不是直接做爲函數的參數

6. 函數真的最好只作一件事，不要爲了一時方便順手加幾行代碼。如登陸驗證時，函數用來驗證username和password，在驗證以後順便給用戶初始化些其餘東西。會致使這個函數在其餘時候沒法驗證用戶信息。

7. 底層函數不該該改變參數狀態，若是想改變某類的狀態，就把該函數加入該類，讓它本身調用函數。如：把改變類x的狀態的函數調用addFooter(x)，改成x.addFooter()。

8. 函數不要返回錯誤碼，這須要你有錯誤碼的枚舉類，而且違反了開放封閉原則（你須要加入新錯誤碼來擴展新錯誤），直接拋出異常就行了。（能夠經過繼承父異常來擴展）。可是實際上錯誤碼的應用不比異常少，並且異常也會致使代碼的臃腫。

9. 函數名稱應該描述清楚函數做用，避免頻繁去看文檔，這對於短小的函數來講不難辦到，若是很難命名可能須要思考函數是否有依照以上原則設計(你一個函數可能作了不少事情)。而且名稱的命名應該不容易與其餘函數名稱造成混淆。如：add()在calculator中意思是加，而在List中就不該該用add表示插入集合了，應該用insert或append。簡單來講就是一個概念對應一個詞，而且始終如一。

二 格式

每一個人都有本身的編碼風格，書中總結了一些Java及其餘語言的建議

1. 好的格式應該由小且精的代碼片斷（函數）組成

2. 封包代碼，導包代碼，成員變量，函數方法。都用空行隔開，造成分開的代碼塊

3. 函數按調用順序從上到下排列，類變量在頂端聲明，方法變量在使用前聲明

4. 一行代碼不超過100個,同一行的計算能夠按前後順序用空格隔開，如：
   100 * 732 / (2+3) * (5-1)
   小括號內的運算全都擠在了一塊兒，其餘運算都有空格隔開，很容易看出運算順序
5. 縮進表明了一種包含關係。Java沒有強制要求，可是python就是用縮進表示包含。

6. 說了這麼多最後總結道：老大規定用啥格式就用啥格式

三 註釋

其實註釋寫了後，看的最多的仍是本身

1. 好代碼只須要少許註釋，代碼就能表達意圖——回到以前的內容，這要求咱們寫小且精的函數。（但這不是你不寫註釋的理由）
2. 好的註釋應該是這樣的。如：對抽象意圖或者深遠意義的解釋（如我這個函數爲啥用這個方法實現）；闡述長且難讀的函數（這種難讀不是由於代碼寫得爛，而是業務邏輯複雜）；警示一些關鍵重要的部分（這些部分通常是函數會改變某些數據實體）；TODO註釋提醒並告知將來要作的事；學着公共API的JAVADOC寫就是好註釋（雖然也有少數爛註釋）；
3. 爛的註釋每每是這樣的。如：多餘的註釋（簡單函數強行加上註釋，讀源碼會比註釋更快）；誤導的註釋（註釋原本就是錯的，可能源自你更新了代碼沒更新註釋——小函數特別可能出現這個問題）；註釋掉的代碼（你爲什麼不刪了代碼？）；廢話太多的註釋（語文是體育老師教的）。

四 類

書中對於函數的設計其實和類的設計思想是相似的，因此類應該功能單一且小巧，越小耦合性越低，最後用門面模式組合起來向外提供API就行了

五 系統

系統總體結構的設計

1. 把系統的總體構造和業務使用分開。不要讓構造影響使用，也不要讓程序的運行反過來影響構造。這也是Spring這麼應用普遍的緣由之一，Spring Core就是個類容器。
2. 把業務邏輯和檢查或日誌方案分離，否則糾纏在一塊兒的代碼會很難看懂和修改。Spring AOP也解決了這個問題。

六 測試

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

1. 測試函數（方法）也應該短小（若是函數本來夠小的話測試函數天然會小）
2. 每一個類最好都測試下，測試時間會比之後debug時間少。從底層函數一點點測上去，之後debug能迅速定位。
3. 測試類應該保存下來，方便每次修改後進行測試