最近在看Bob大叔的《代碼整潔之道》，收益頗多，有些怕忘記，然更多則是做記錄時(shí)，會(huì)理解的更加深刻，力求描述清楚，需要對(duì)知識(shí)更深的理解，遂在此做筆記。共同探討，共同學(xué)習(xí)。

一 簡(jiǎn)潔設(shè)計(jì)原則

Bob大叔借鑒過(guò)多位行業(yè)大牛說(shuō)過(guò)的話，總結(jié)出構(gòu)建簡(jiǎn)潔之道：

運(yùn)行所有測(cè)試

重構(gòu)：消除重復(fù)，保證表達(dá)力，盡可能減少類和方法的數(shù)量。

不可重復(fù)

表達(dá)了程序員的意圖

盡可能減少類和方法的數(shù)量

以上規(guī)則按照重要程度排列

二 命名必須有有意義

包含有variable、method、parameter、class、package，甚至是jar文件，war文件，ear文件。那么該怎么命名呢，有很多的規(guī)則

名副其實(shí)：選一個(gè)好名字，也許會(huì)花費(fèi)很多的時(shí)間，但省下來(lái)的時(shí)間比花掉的多，我們讀和寫的比例是遠(yuǎn)遠(yuǎn)大于5：1的。

避免誤導(dǎo)：必須避免留下掩藏代碼本意的錯(cuò)誤線索。

做有意義的區(qū)分：應(yīng)以讀者能鑒別不同之處的方式來(lái)區(qū)分，比如DTO、VO、PO等，讀者一眼便知其來(lái)源。

使用讀的出來(lái)的名稱。

盡量使用可搜索的名稱。例：int WORK_DAYS_PER_WEEK=5;

避免使用前綴，前綴無(wú)意義。

避免思維映射：不應(yīng)讓讀者把你的名稱翻譯為他們熟知的名稱。

類名優(yōu)化：避免使用Data、Info這樣的類名。類名不應(yīng)是動(dòng)詞。

方法名：方法名應(yīng)為動(dòng)詞或動(dòng)詞短語(yǔ)。如：deletePage、save。

每個(gè)概念對(duì)應(yīng)一個(gè)詞：我理解和DDD中的業(yè)務(wù)術(shù)語(yǔ)有點(diǎn)類似，對(duì)于同樣的名稱要有同樣的認(rèn)知。

別用雙關(guān)語(yǔ)

使用解決方案領(lǐng)域名稱：ArrayList在java中一定是所有程序員都知道的。

使用源自所涉及問(wèn)題領(lǐng)域的名稱。

添加有意義的語(yǔ)境。

三 函數(shù)（method）

參考類，juc中的ReentrantLock.java，我看完所有的代碼，發(fā)現(xiàn)最長(zhǎng)的一個(gè)method是15行，大多是1到5行代碼就搞定。

短小

只做一件事：判斷函數(shù)是否只做一件事，就是看是否還能再拆出一個(gè)函數(shù)

每個(gè)函數(shù)一個(gè)抽象層級(jí)：這一條比較難理解，就比如將大象裝進(jìn)冰箱一樣，可以分為3個(gè)步驟開(kāi)門->裝大象->關(guān)門。而在裝大象之前需要進(jìn)行判斷冰箱的大小和大象的大小以及冰箱中是否有其他東西，那么3大步驟是一個(gè)層級(jí)的，其他的是第二層級(jí)，還可能有第三層級(jí)。簡(jiǎn)而言之，就是分層。

switch語(yǔ)句：盡量少用，switch語(yǔ)句本身就是用來(lái)處理多件事的，而用抽象工廠可能會(huì)更好一點(diǎn)。

使用描述性的名稱

參數(shù)：零參數(shù)最好，其次是一，再次是二，應(yīng)盡量避免三。

無(wú)副作用：不要把另外一件事隱藏到這個(gè)函數(shù)中，避免函數(shù)做不在名稱描述中的第二件事。

分隔指令與詢問(wèn)：函數(shù)要么做什么事，要么回答什么事，但二者不可兼得。

使用異常替代返回錯(cuò)誤碼

Don’t repeat yourself

結(jié)構(gòu)化編程：每個(gè)函數(shù)都應(yīng)該只有一個(gè)入口，一個(gè)出口。

四 注釋

注釋的恰當(dāng)用法是彌補(bǔ)我們?cè)谟么a表達(dá)意圖時(shí)遭遇的失敗。代碼可以表達(dá)清楚的事情，就不要用注釋。除非你要寫復(fù)雜的并發(fā)代碼，或者是通用框架類，否則一般的業(yè)務(wù)代碼就盡量不要用到注釋。代碼可以被修改，但別人基本不會(huì)修改你寫的注釋，這會(huì)使得注釋具有誤導(dǎo)性。真實(shí)只有一處地方有：代碼。代碼會(huì)告訴你它做的事情，唯一準(zhǔn)確的信息來(lái)源。
注釋掉的代碼直接刪除，無(wú)需留著，源代碼控制工具(git,svn)會(huì)幫我們記錄這一切的。

五 格式

我們大多數(shù)人使用的開(kāi)發(fā)工具（eclipse和idea），已經(jīng)自帶了格式化規(guī)范。在代碼寫完之后，使用快捷鍵格式化一下即可。
函數(shù)如果有調(diào)用的關(guān)系，則盡量把他們放在一起，而且調(diào)用者應(yīng)該盡可能放在被調(diào)用者上邊。
這里需要提一下的就是代碼規(guī)范規(guī)則，目前國(guó)內(nèi)Java行業(yè)標(biāo)準(zhǔn)有阿里開(kāi)源的開(kāi)發(fā)規(guī)范，已經(jīng)被很多的公司采用，使用阿里規(guī)范作為標(biāo)準(zhǔn)也是不錯(cuò)的。

六 對(duì)象和數(shù)據(jù)結(jié)構(gòu)

對(duì)于面向?qū)ο缶幊虂?lái)說(shuō)，這一章的內(nèi)容其實(shí)意義不是特別大，因?yàn)榛镜囊?guī)則現(xiàn)在已經(jīng)定義好了。只是Bob大叔當(dāng)時(shí)的代碼理念可能還沒(méi)有像現(xiàn)在這么全面。唯一需要說(shuō)的就是迪米特法則（Law of Demeter），這個(gè)我會(huì)在附錄中列舉出來(lái)。

七 錯(cuò)誤處理

使用異常而非返回碼

先寫try/catch/finally語(yǔ)句

使用不可控異常，一層層向上拋出

給出異常發(fā)生的環(huán)境說(shuō)明，在拋出異常時(shí)，記錄下堆棧信息。

依調(diào)用者需要定義異常類

自定義異常類

別返回null值

別傳遞null值

八 邊界

在和第三方的接口進(jìn)行交互的時(shí)候，極力推薦將應(yīng)該讓別人知道的方法放出來(lái)，而其他對(duì)別人無(wú)用的接口則封裝起來(lái)。
對(duì)第三方的代碼編寫一些測(cè)試，以便新版本發(fā)布后，還可以繼續(xù)使用。
假定一些dummy數(shù)據(jù)來(lái)作為第三方數(shù)據(jù)的來(lái)源。
對(duì)于第三方的接口，我們可以用Adapter模式來(lái)做一些適配。

九 測(cè)試

測(cè)試這一章基本放棄了，因?yàn)槲覀児静蛔⒅販y(cè)試，也沒(méi)有寫過(guò)單元測(cè)試。但規(guī)則還是一樣的。

十 類

類應(yīng)該盡量設(shè)計(jì)的短小一些。這里會(huì)涉及到3個(gè)原則，單一職責(zé)原則、開(kāi)閉原則和依賴倒置原則。

十一 如何建造一個(gè)城市

將系統(tǒng)的構(gòu)造和使用分開(kāi)

擴(kuò)容

java代理（AOP）

優(yōu)化決策

明智使用添加了可論證價(jià)值的標(biāo)準(zhǔn)

系統(tǒng)需要使用特定語(yǔ)言

十二 迭進(jìn)

通過(guò)迭進(jìn)設(shè)計(jì)達(dá)到整潔目的

重構(gòu)

不可重復(fù)

保證表達(dá)力

盡可能少的類和方法

十三 并發(fā)編程

并發(fā)編程用的較少，不發(fā)表意見(jiàn)。建議掌握java.util.concurrent、java.util.concurrent.atomic和java.utils.concurrent.locks包。

十四到十六

這三章是3個(gè)真實(shí)的案例，通過(guò)代碼實(shí)踐了一些思想。可對(duì)照著十七章的一起分析。

十七 味道與啟發(fā)

17.1 注釋

不恰當(dāng)?shù)男畔?/li>

廢棄的注釋

冗余的注釋

糟糕的注釋

注釋掉的代碼

17.2 環(huán)境

需要多少步才能實(shí)現(xiàn)的構(gòu)建

需要多少步才能做到的測(cè)試

17.3 函數(shù)

過(guò)多的參數(shù)

輸出參數(shù)

標(biāo)識(shí)參數(shù)

死函數(shù)

17.4 一般性問(wèn)題

一個(gè)源文件中存在多種語(yǔ)言

明顯的行為未被實(shí)現(xiàn)

不正確的邊界行為

忽視安全

重復(fù)

在錯(cuò)誤的抽象層級(jí)上的代碼

基類依賴于派生類

信息過(guò)多

死代碼

垂直分割

前后不一致

混淆視聽(tīng)

人為耦合

特性依戀

選擇算子參數(shù)

晦澀的意圖

位置錯(cuò)誤的權(quán)責(zé)

不恰當(dāng)?shù)撵o態(tài)方法

使用解釋性變量

函數(shù)名稱應(yīng)該表達(dá)其行為

理解算法

把邏輯依賴改為物理依賴

用多態(tài)替代if/else或switch/case

遵循標(biāo)準(zhǔn)約定

用命名常量替代魔術(shù)數(shù)

準(zhǔn)確

結(jié)構(gòu)甚于約定

封裝條件

避免否定性條件

函數(shù)只做一件事

掩蔽時(shí)序耦合

別隨意

封裝邊界條件

函數(shù)應(yīng)該只在一個(gè)抽象層級(jí)上

在較高層放置可配置數(shù)據(jù)

避免傳遞瀏覽

17.5 Java

通過(guò)使用通配符來(lái)避免過(guò)長(zhǎng)的導(dǎo)入清單

不要繼承常量

常量和枚舉

17.6 名稱

采用描述性名稱

名稱應(yīng)與抽象層級(jí)相符

盡可能使用標(biāo)準(zhǔn)命名法

無(wú)歧義的名稱

為較大作用范圍選用較長(zhǎng)名稱

避免編碼

名稱應(yīng)該說(shuō)明副作用

17.7 測(cè)試

測(cè)試不足

使用覆蓋率工具

別略過(guò)小測(cè)試

被忽略的測(cè)試就是對(duì)不確定事物的疑問(wèn)

測(cè)試邊界條件

全面測(cè)試相近的缺陷

測(cè)試失敗的模式有啟發(fā)性

測(cè)試覆蓋率的模式有啟發(fā)性

測(cè)試應(yīng)該快速

附錄

1. 開(kāi)閉原則：open-close principle

一個(gè)軟件實(shí)體諸如類或模塊或函數(shù)應(yīng)該對(duì)擴(kuò)展開(kāi)放，對(duì)修改關(guān)閉。用抽象構(gòu)建框架，用實(shí)現(xiàn)擴(kuò)展細(xì)節(jié)。

優(yōu)點(diǎn)：提高軟件系統(tǒng)的可復(fù)用性以及可維護(hù)性。

2. 依賴倒置原則：Dependence Inversion Principle

程序要依賴于抽象接口，不要依賴于具體實(shí)現(xiàn)。簡(jiǎn)單的說(shuō)就是要求對(duì)抽象進(jìn)行編程，不要對(duì)實(shí)現(xiàn)進(jìn)行編程，這樣就降低了客戶與實(shí)現(xiàn)模塊間的耦合。

3. 單一職責(zé)原則：Single Responsibility Principle

不要存在多于一個(gè)導(dǎo)致類變更的原因

一個(gè)類，接口，方法只負(fù)責(zé)一項(xiàng)職責(zé)

優(yōu)點(diǎn)：降低類的復(fù)雜度，提高類的可讀性，提高系統(tǒng)的可維護(hù)性，降低變更引起的風(fēng)險(xiǎn)。

4. 接口隔離原則：Interface Segregation Principle

客戶端不應(yīng)該依賴它不需要的接口。一個(gè)類對(duì)另一個(gè)類的依賴應(yīng)該建立在最小的接口上。

使用多個(gè)專門的接口比使用單一的總接口要好。

一個(gè)類對(duì)另外一個(gè)類的依賴性應(yīng)當(dāng)是建立在最小的接口上的。

優(yōu)點(diǎn)：1.避免接口污染；2.提高靈活性；3.提供定制服務(wù)；4.實(shí)現(xiàn)高內(nèi)聚

5. 迪米特法則：Law Of Demeter

一個(gè)對(duì)象應(yīng)該對(duì)其他對(duì)象保持最少的了解。又叫最少知道法則。

盡量降低類與類之間的耦合。

優(yōu)點(diǎn)：降低類之間的耦合。

6. 里氏替換原則：Liskov Substitution Principle LSP

里氏替換原則(LSP)是面向?qū)ο笤O(shè)計(jì)的基本原則之一。 里氏替換原則中說(shuō)，任何基類可以出現(xiàn)的地方，子類一定可以出現(xiàn)。 LSP是繼承復(fù)用的基石，只有當(dāng)衍生類可以替換掉基類，軟件單位的功能不受到影響時(shí)，基類才能真正被復(fù)用，而衍生類也能夠在基類的基礎(chǔ)上增加新的行為

優(yōu)點(diǎn)：1.約束繼承泛濫，開(kāi)閉原則的一種體現(xiàn)。

2.加強(qiáng)程序的健壯性，同時(shí)變更時(shí)也可以做到非常好的兼容性，提高程序的維護(hù)性，擴(kuò)展性。降低需求變更時(shí)引入的風(fēng)險(xiǎn)。

7. 合成復(fù)用原則：Composite Reuse Principle CRP

它要求在軟件復(fù)用時(shí)，要盡量先使用組合或者聚合等關(guān)聯(lián)關(guān)系來(lái)實(shí)現(xiàn)，其次才考慮使用繼承關(guān)系來(lái)實(shí)現(xiàn)。

優(yōu)點(diǎn)：

它維持了類的封裝性。因?yàn)槌煞謱?duì)象的內(nèi)部細(xì)節(jié)是新對(duì)象看不見(jiàn)的，所以這種復(fù)用又稱為“黑箱”復(fù)用。

新舊類之間的耦合度低。這種復(fù)用所需的依賴較少，新對(duì)象存取成分對(duì)象的唯一方法是通過(guò)成分對(duì)象的接口。

復(fù)用的靈活性高。這種復(fù)用可以在運(yùn)行時(shí)動(dòng)態(tài)進(jìn)行，新對(duì)象可以動(dòng)態(tài)地引用與成分對(duì)象類型相同的對(duì)象。

總結(jié)

以上是生活随笔為你收集整理的《代码整洁之道》读后感的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。