摘要：看完代碼整潔之道之后我受益匪淺，但等到自己實踐時卻很難按照書中給的建議編寫出整潔的代碼。意味著新人除了了解代碼邏輯之外，還需要學習這種編碼語言。代碼在演化，注釋卻不總是隨之變動。區隔與靠近空格強調左右兩邊的分割。

看完《代碼整潔之道》之后我受益匪淺，但等到自己實踐時卻很難按照書中給的建議編寫出整潔的代碼。一方面是規則太多，記不住，另一方面書上引用了大量示例代碼對這些規則進行佐證，在我記不住時亦不方便查閱。于是我把書中的規則摘了出來并加以一定的解釋，閑暇時候多過幾遍，希望這些規則時刻警示我，成為我的習慣。

想看此書卻還沒開始的人也可以從這篇筆記出發，對筆記中列出的規則有疑問再翻書找答案，相信會比直接啃書來的快一些。

ps: 未必要嚴格遵循書中的規則，代碼不是八股文。

"一組賬號"別用accountList表示，List對程序員有特殊含義，可以用accountGroup、bunchOfAccounts、甚至是accounts

不使用區別較小的名稱，ZYXControllerForEfficientHandlingOfStrings和ZYXControllerForEfficientStorageOfStrings難以辨別

不使用小寫l、大寫O作變量名，看起來像常量1、0

不以數字系列命名(a1、a2、a3)，按照真實含義命名

Product/ProductInfo/ProductData 意思無區別，只統一用一個

別寫冗余的名字，變量名別帶variable、表名別帶table

單字母名稱和數字常量很難在上下文中找出。名稱長短應與其作用域大小相對應，越是頻繁出現的變量名稱得越容易搜索(越長)

把類型和作用域編碼進名稱里增加了解碼負擔。意味著新人除了了解代碼邏輯之外，還需要學習這種編碼語言。

別使用匈牙利語標記法(格式：[Prefix]-BaseTag-Name 其中BaseTag是數據類型的縮寫，Name是變量名字)，純屬多余

不必用"m_"前綴來表明成員變量

接口和實現別在名稱中編碼。接口名IShapeFactory的前導"I"是廢話。如果接口和實現必須選一個編碼，寧可選實現，ShapeFactoryImp都比對接口名稱編碼來的好

類名應當是名詞或名詞短語，方法名應當是動詞或動詞短語

fetch、retrieve、get約定一個一直用即可

add方法一般語義是：根據兩個值獲得一個新的值。如果要把單個值加入到某個集合，用insert或append命名更好，這里用add就是雙關語了。

很少有名稱能自我說明，需要用良好命名的類、函數、或者命名空間來放置名稱，給讀者提供語境，如果做不到的話，給名稱添加前綴就是最后一招了。

if/else/while語句的代碼塊應該只有一行，該行應該是一個函數調用語句。

函數的縮進層級不應該多于一層或兩層。

如果函數只是做了該函數名下同一抽象層上的步驟，則函數只做了一件事。

要判斷函數是否不止做了一件事，就是要看是否能再拆出一個函數。

把switch埋在較低的抽象層級，一般可以放在抽象工廠底下，用于創建多態對象。

函數越短小、功能越集中，就越便于取個好名字。

別害怕長名稱，長而具有描述性的名稱，要比短而令人費解的名稱好，要比描述性的長注釋好。

別害怕花時間取名字。

參數越少越好，0參數最好，盡量避免用三個以上參數

參數越多，編寫組合參數的測試用例就越困難

別用標識參數，向函數傳入bool值是不好的，這意味著函數不止做一件事。可以將此函數拆成兩個。

如果函數需要兩個、三個或者三個以上參數，就說明其中一些參數應該封裝成類了。

將參數的順序編碼進函數名，減輕記憶參數順序的負擔，例如,assertExpectedEqualsActual(expected, actual)

檢查密碼并且初始化session的方法 命名為checkPasswordAndInitializeSession而非checkPassword，即使違反單一職責原則也不要有副作用

避免使用"輸出參數"，如果函數必須修改某種狀態，就修改所屬對象的狀態吧

if(set("username", "unclebob")) { ... } 的含義模糊不清。應該改為:

if (attributeExists("username")) { 
    setAttribute("username", "unclebob");
    ...
}

返回錯誤碼會要求調用者立刻處理錯誤，從而引起深層次的嵌套結構:

if (deletePate(page) == E_OK) {
    if (xxx() == E_OK) {
        if (yyy() == E_OK) {
            log();
        } else {
            log();
        }
    } else {
        log();
    }
} else {
    log();
}

使用異常機制:

try {
    deletePage();
    xxx();
    yyy();
} catch (Exception e) {
    log(e->getMessage());
}

try/catch代碼塊丑陋不堪，所以最好把try和catch代碼塊的主體抽離出來，多帶帶形成函數

try {
    do();
} catch (Exception e) {
    handle();
}

函數只做一件事，錯誤處理就是一件事。如果關鍵字try在某個函數中存在，它就該是函數的第一個單詞，而且catch代碼塊后面也不該有其他內容。

定義錯誤碼的class需要添加新的錯誤碼時，所有用到錯誤碼class的其他class都得重新編譯和部署。但如果使用異常而非錯誤碼，新異常可以從異常class派生出來，無需重新編譯或部署。這也是開放閉合原則(對擴展開放，對修改封閉)的范例。

重復是軟件中一切邪惡的根源。當算法改變時需要修改多處地方

只要函數保持短小，偶爾出現的return、break、continue語句沒有壞處，甚至還比單入單出原則更具有表達力。goto只有在大函數里才有道理，應該盡量避免使用。

并不需要一開始就按照這些規則寫函數，沒人做得到。想些什么就寫什么，然后再打磨這些代碼，按照這些規則組裝函數。

若編程語言足夠有表現力，我們就不需要注釋。

注釋總是一種失敗。

代碼在演化，注釋卻不總是隨之變動。

不準確的注釋比沒注釋壞的多。

創建一個與注釋所言同一事物的函數即可

// check to see if the employee is eligible for full benefits
if ((employee.falgs & HOURLY_FLAG) && (employee.age > 65))

應替換為

if (employee.isEligibleForFullBenefits())

法律信息

提供基本信息，如解釋某個抽象方法的返回值

對意圖的解釋，反應了作者某個決定后面的意圖

闡釋。把某些晦澀的參數或者返回值的意義翻譯成可讀的形式(更好的方法是讓它們自身變得足夠清晰，但是類似標準庫的代碼我們無法修改):

if (b.compareTo(a) == 1) //b > a

警示。// don"t run unless you have some time to kill

TODO注釋

放大 一些看似不合理之物 的重要性

自言自語

多余的注釋。把邏輯在注釋里寫一遍不能比代碼提供更多信息，讀它不比讀代碼簡單。一目了然的成員變量別加注釋，顯得很多余。

誤導性注釋

遵循規矩的注釋。每個函數都加注釋、每個變量都加注釋是愚蠢的。

日志式注釋。有了代碼版本控制工具，不必在文件開頭維護修改時間、修改人這類日志式的注釋

能用函數或者變量表示就別用注釋:

// does the module from the global list  
// depend on the subsystem we are part of?
if (smodule.getDependSubsystems().contains(subSysMod.getSubSystem())

可以改為

ArrayList moduleDependees = smodule.getDependSubsystems();
String ourSubSystem = subSysMod.getSubSystem();
if (moduleDependees.contains(ourSubSystem))

位置標記。標記多了會被我們忽略掉:
///////////////////// Actions //////////////////////////

右括號注釋

try {
    while () {
        if () {
            ...
        } // if
        ...
    } // while
    ...
} // try

如果你想標記右括號，其實應該做的是縮短函數

署名 /* add by rick */ 源代碼控制工具會記住你，署名注釋跟不上代碼的演變。

注釋掉的代碼。會導致看到這段代碼其他人不敢刪除

信息過多。別在注釋中添加有趣的歷史話題或者無關的細節

沒解釋清楚的注釋。注釋的作用是解釋未能自行解釋的代碼，如果注釋本身還需要解釋就太遺憾了。

短函數的函數頭注釋。為短函數選個好名字比函數頭注釋要好。

非公共API函數的javadoc/phpdoc注釋。

短文件比長文件更易于理解。平均200行，最多不超過500行的單個文件可以構造出色的系統

區隔: 封包聲明、導入聲明、每個函數之間，都用空白行分隔開，空白行下面標識著新的獨立概念

靠近: 緊密相關的代碼應該互相靠近，例如一個類里的屬性之間別用空白行隔開

變量聲明應盡可能靠近其使用位置：循環中的控制變量應該總是在循環語句中聲明。

成員變量應該放在類的頂部聲明，不要四處放置

如果某個函數調用了另外一個，就應該把它們放在一起。我們希望底層細節最后展現出來，不用沉溺于細節，所以調用者盡可能放在被調用者之上。

執行同一基礎任務的幾個函數應該放在一起。

一行代碼不必死守80字符的上限，偶爾到達100字符不超過120字符即可。

區隔與靠近: 空格強調左右兩邊的分割。賦值運算符兩邊加空格，函數名與左圓括號之間不加空格，乘法運算符在與加減法運算符組合時不用加空格(a*b - c)

不必水平對齊。例如聲明一堆成員變量時，各行不用每一個單詞都對齊。

短小的if、while、函數里最好也不要違反縮進規則，不要這樣:
if (xx == yy) z = 1;

對象:暴露行為(接口),隱藏數據(私有變量)
數據結構:沒有明顯的行為(接口),暴露數據。如DTO(Data Transfer Objects)、Entity

使用數據結構便于在不改動現在數據結構的前提下添加新函數；使用對象便于在不改動既有函數的前提下添加新類。

使用數據結構難以添加新數據結構，因為必須修改所有函數；使用對象難以添加新函數，因為必須修改所有類。

萬物皆對象只是個傳說，有時候我們也會在簡單數據結構上做一些過程式的操作。

模塊不應該了解它所操作對象的內部情形

class C的方法f只應該調用以下對象的方法:

C

在方法f里創建的對象

作為參數傳遞給方法f的對象

C持有的對象

方法不應調用 由任何函數返回的對象 的方法。下面的代碼違反了demeter定律:
final String outputDir = ctxt.getOptions().getScratchDir().getAbsolutePath();

一個簡單例子是，人可以命令一條狗行走（walk），但是不應該直接指揮狗的腿行走，應該由狗去指揮控制它的腿如何行走。

異常處理很重要，但如果異常處理四處分散在代碼中 導致邏輯模糊不清，它就是錯的。

如果使用錯誤碼，調用者必須在函數返回時立刻處理錯誤，但這很容易被我們忘記。

錯誤碼通常會導致嵌套if else

當編寫可能會拋異常的代碼時，先寫好try-catch再往里堆邏輯

同一個try里catch多個不同exception，但是catch處理的事(打日志等)是一致的，可以考慮用函數打包一下這個異常處理，針對不同異常僅需throw成同一個異常而不做任何處理，在外層catch時統一處理(打日志等)。如果僅想捕獲一部分異常而放過其他異常，就使用不同的函數打包這個異常處理。

try {
    MealExpendses expenses = expenseRepotDAO.getMeals(employee.getID());
    m_total += expenses.getTotal();// 如果消耗了餐食，計入總額
} catch (MealExpensesNotFound e) {
    m_total += getMealPeDiem();// 如果沒消耗，將員工補貼計入總額
}

異常打斷了業務邏輯。可以在getMeals()里不拋異常，而是在沒消耗餐食的時候返回一個特殊的MealExpense對象(PerdiemMealExpense)，復寫getTotal()方法。

MealExpendses expenses = expenseRepotDAO.getMeals(employee.getID());
m_total += expenses.getTotal();

publc class PerDiemMealExpenses implements MealExpenses {
    public int getTotal() {
        //return xxx; //返回員工補貼
    }
}

返回null值只要一處沒檢查null，應用程序就會失敗

當想返回null值的時候，可以試試拋出異常，或者返回特例模式的對象。

在方法中傳遞null值是一種糟糕的做法，應該盡量避免。

在方法里用if或assert過濾null值參數，但是還是會出現運行時錯誤，沒有良好的辦法對付調動者意外傳入的null值，恰當的做法就是禁止傳入null值。

將第三方代碼干凈利落地整合進自己的代碼中

First Law: You may not write production code until you have written a failing unit test.

Second Law: You may not write more of a unit test than is sufficient to fail, and not compiling is failing.

Third Law: You may not write more production code than is sufficient to pass the currently failing test.

臟測試等同于沒測試，測試代碼越臟 生產代碼越難修改。

測試代碼和生產代碼一樣重要。

整潔的測試代碼最應具有的要素是：整潔性。測試代碼中不要有大量重復代碼的調用。

每個測試函數有且僅有一個斷言語句。

每個測試函數中只測試一個概念。

fast: 測試代碼應該能夠快速運行，因為我們需要頻繁運行它。

independent: 測試應該相互獨立，某個測試不應該依賴上一個測試的結果，測試可以以任何順序進行。

repeatable: 測試應可以在任何環境中通過

self-validating: 測試應該有bool值輸出，不應通過查看日志來確認測試結果，不應手工對比兩個文本文件確認測試結果。

timely: 及時編寫測試代碼。單元測試應該在生產代碼之前編寫，否則生產代碼會變得難以測試。

公共靜態常量

私有靜態變量

私有實體變量

公共函數

私有工具函數

對于函數我們計算代碼行數衡量大小，對于類我們使用權責來衡量。

類的名稱應當描述其權責。類的命名是判斷類長度的第一個手段，如果無法為某個類命以準確的名稱，這個類就太長了。類名包含模糊的詞匯，如Processor、Manager、Super，這種現象就說明有不恰當的*權責聚集情況。

單一權責原則: 類或者模塊應該有一個權責——只有一條修改的理由(A class should have only one reason to change.)。

系統應該由許多短小的類而不是少量巨大的類組成。

類應該只有少量的實體變量，如果一個類中每個實體變量都被每個方法所使用，則說明該類具有最大的內聚性。創建最大化的內聚類不太現實，但是應該以高內聚為目標，內聚性越高說明類中的方法和變量互相依賴、互相結合形成一個邏輯整體。

保持內聚性就會得到許多短小的類。如果你想把一個大函數的某一小部分拆解成多帶帶的函數，拆解出的函數使用了大函數中的4個變量，不必將4個變量作為參數傳遞到新函數里，僅需將這4個變量提升為大函數所在類的實體變量，但是這么做卻因為實體變量的增多而喪失了類的內聚性，更好多做法是讓這4個變量拆出來，擁有自己的類。將大函數拆解成小函數往往是將類拆分為小類的時機。

類應當對擴展開放，對修改封閉(開放閉合原則)

在理想系統中，我們通過擴展系統而非修改現有代碼來添加新特性。

將全部構造過程搬遷到main或者被稱之為main的模塊中，涉及系統其余部分時，假設所有對象都已經正確構造。

有時應用程序也需要負責確定何時創建對象，我們可以使用抽象工廠模式讓應用自行控制何時創建對象，但構造能力在工廠實現類里，與使用部分分開。

依賴注入(DI)，控制反轉(IoC)是分離構造與使用的強大機制。

四條規矩幫助你創建優良的設計

緊耦合的代碼難以編寫測試，測試寫的越多，就越會遵循依賴注入之類的規則，使代碼加減少耦合。

測試消除了對清理代碼就會破壞代碼的恐懼。

兩個方法提取共性到新方法中，新方法分解到另外的類里，從而提升其可見性。

模板方法模式是消除重復的通用技巧

// 原始邏輯
public class VacationPolicy() {
    public void accrueUSDivisionVacation() {
        //do x;
        //do US y;
        //do z;
    }
    public void accrueEUDivisionVacation() {
        //do x;
        //do EU y;
        //do z;
    }
}

// 模板方法模式重構之后
abstract public class VacationPolicy {
    public void accrueVacation() {
        x();
        y();
        z();
    }
    private void x() {
        //do x;
    }
    abstract protected void y() {
    
    }
    private void z() {
        //do z;
    }
}
public class USVacationPolicy extends VacationPolicy {
    protected void y() {
        //do US y;
    }
}
public class EUVacationPolicy extends VacationPolicy {
    protected void y() {
        //do EU y;
    }
}

作者把代碼寫的越清晰，其他人理解代碼就越快。

太多時候我們深入于要解決的問題中，寫出能工作的代碼之后，就轉移到下一個問題上，沒有下足功夫調整代碼讓后來者易于閱讀。多少尊重一下我們的手藝，花一點點時間在每個函數和類上。

為了保持類和函數的短小，我們可能會早出太多細小的類和方法。

類和方法數量太多，有時是由毫無意義的教條主義導致的。

遵循單一職責原則。分離并發代碼與非并發代碼

限制臨界區數量、限制對共享數據的訪問。

避免使用共享數據，使用對象的副本。

線程盡可能地獨立，不與其他線程共享數據。