産品特色
編輯推薦
細節之中自有天地,整潔成就卓越代碼。
盡管糟糕的代碼也能運行,但如果代碼不整潔,會使整個開發團隊泥足深陷,寫得不好的代碼每年都要耗費難以計數的時間和資源。然而這種情況並非無法避免。
軟件專傢RoberfC.Marlin在《代碼整潔之道》中為你呈現齣瞭革命性的視野。Martin攜同ObjectMetltor公司的同事,從他們有關整潔代碼的敏捷實踐中提煉齣軟件技藝的價值觀,以饗讀者,讓你成為更傑齣的程序員——隻要你著手研讀《代碼整潔之道》。
閱讀《代碼整潔之道》需要你做些什麼呢?你將閱讀代碼——大量代碼。《代碼整潔之道》促使你思考代碼中何謂正確,何謂錯誤。更重要的是,《代碼整潔之道》將促使你重新評估自己的專業價值觀,以及對自己技藝的承諾。
從《代碼整潔之道》中可以學到:好代碼和糟糕的代碼之間的區彆:如何編寫好代碼,如何將糟糕的代碼轉化為好代碼:如何創建好名稱、好函數、好對象和好類;如何格式化代碼以實現其可讀性的優化:如何在不妨礙代碼邏輯的前提下充分實現錯誤處理;如何進行單元測試和測試驅動開發。
內容簡介
軟件質量,不但依賴於架構及項目管理,而且與代碼質量緊密相關。這一點,無論是敏捷開發流派還是傳統開發流派,都不得不承認。《代碼整潔之道》提齣一種觀念:代碼質量與其整潔度成正比。乾淨的代碼,既在質量上較為可靠,也為後期維護、升級奠定瞭良好基礎。作為編程領域的佼佼者,《代碼整潔之道》作者給齣瞭一係列行之有效的整潔代碼操作實踐。這些實踐在《代碼整潔之道》中體現為一條條規則(或稱“啓示”),並輔以來自現實項目的正、反兩麵的範例。隻要遵循這些規則,就能編寫齣乾淨的代碼,從而有效提升代碼質量。
《代碼整潔之道》閱讀對象為一切有誌於改善代碼質量的程序員及技術經理。書中介紹的規則均來自作者多年的實踐經驗,涵蓋從命名到重構的多個編程方麵,雖為一“傢”之言,然誠有可資藉鑒的價值。
作者簡介
Robert C. Martin,是軟件工程領域的大師級人物,是《敏捷軟件開發:原則、模式與實踐》、《敏捷軟件開發:原則、模式與實踐(C#版)》(郵電)、《極限編程實踐》(郵電)等國內引進的暢銷書的作者,其中原著榮獲美國《軟件開發》第13屆震憾(Jolt)大奬,Martin的敏捷係列書是軟件工程界書籍。本書是他的又一力作。
Martin在書中對代碼具有革命性的解讀
闡述瞭整潔代碼的佳敏捷實踐的方法
書中介紹規則均來自Martin多年的經驗,擁有很高的藉鑒價值
韓磊,互聯網産品與運營專傢,技術書籍著譯者。曾在全球的IT中文社區CSDN及《程序員》雜誌任副總經理、總編輯等職。現居廣州。譯著有《夢斷代碼》和《C#編程風格》。與劉韌閤著《網絡媒體教程》,與戴飛閤譯《BeginningC#Objects中文版:概念到代碼》。
內頁插圖
目錄
第1章 整潔代碼 1
1.1 要有代碼 2
1.2 糟糕的代碼 2
1.3 混亂的代價 3
1.3.1 華麗新設計 4
1.3.2 態度 4
1.3.3 迷題 5
1.3.4 整潔代碼的藝術 5
1.3.5 什麼是整潔代碼 6
1.4 思想流派 10
1.5 我們是作者 11
1.6 童子軍軍規 12
1.7 前傳與原則 12
1.8 小結 12
1.9 文獻 13
第2章 有意義的命名 15
2.1 介紹 15
2.2 名副其實 16
2.3 避免誤導 17
2.4 做有意義的區分 18
2.5 使用讀得齣來的名稱 19
2.6 使用可搜索的名稱 20
2.7 避免使用編碼 21
2.7.1 匈牙利語標記法 21
2.7.2 成員前綴 21
2.7.3 接口和實現 22
2.8 避免思維映射 22
2.9 類名 23
2.10 方法名 23
2.11 彆扮可愛 23
2.12 每個概念對應一個詞 24
2.13 彆用雙關語 24
2.14 使用解決方案領域名稱 25
2.15 使用源自所涉問題領域的名稱 25
2.16 添加有意義的語境 25
2.17 不要添加沒用的語境 27
2.18 最後的話 27
第3章 函數 29
3.1 短小 32
3.2 隻做一件事 33
3.3 每個函數一個抽象層級 34
3.4 switch語句 35
3.5 使用描述性的名稱 36
3.6 函數參數 37
3.6.1 一元函數的普遍形式 38
3.6.2 標識參數 38
3.6.3 二元函數 38
3.6.4 三元函數 39
3.6.5 參數對象 39
3.6.6 參數列錶 40
3.6.7 動詞與關鍵字 40
3.7 無副作用 40
3.8 分隔指令與詢問 42
3.9 使用異常替代返迴錯誤碼 42
3.9.1 抽離Try/Catch代碼塊 43
3.9.2 錯誤處理就是一件事 44
3.9.3 Error.java依賴磁鐵 44
3.10 彆重復自己 44
3.11 結構化編程 45
3.12 如何寫齣這樣的函數 45
3.13 小結 45
3.14 SetupTeardownIncluder程序 46
3.15 文獻 48
第4章 注釋 49
4.1 注釋不能美化糟糕的代碼 50
4.2 用代碼來闡述 51
4.3 好注釋 51
4.3.1 法律信息 51
4.3.2 提供信息的注釋 51
4.3.3 對意圖的解釋 52
4.3.4 闡釋 53
4.3.5 警示 53
4.3.6 TODO注釋 54
4.3.7 放大 54
4.3.8 公共API中的Javadoc 55
4.4 壞注釋 55
4.4.1 喃喃自語 55
4.4.2 多餘的注釋 56
4.4.3 誤導性注釋 58
4.4.4 循規式注釋 58
4.4.5 日誌式注釋 59
4.4.6 廢話注釋 59
4.4.7 可怕的廢話 61
4.4.8 能用函數或變量時就彆用注釋 62
4.4.9 位置標記 62
4.4.10 括號後麵的注釋 62
4.4.11 歸屬與署名 63
4.4.12 注釋掉的代碼 63
4.4.13 HTML注釋 64
4.4.14 非本地信息 64
4.4.15 信息過多 65
4.4.16 不明顯的聯係 65
4.4.17 函數頭 66
4.4.18 非公共代碼中的Javadoc 66
4.4.19 範例 66
4.5 文獻 69
第5章 格式 71
5.1 格式的目的 72
5.2 垂直格式 72
5.2.1 嚮報紙學習 73
5.2.2 概念間垂直方嚮上的區隔 73
5.2.3 垂直方嚮上的靠近 74
5.2.4 垂直距離 75
5.2.5 垂直順序 79
5.3 橫嚮格式 79
5.3.1 水平方嚮上的區隔與靠近 80
5.3.2 水平對齊 81
5.3.3 縮進 82
5.3.4 空範圍 84
5.4 團隊規則 84
5.5 鮑勃大叔的格式規則 85
第6章 對象和數據結構 87
6.1 數據抽象 87
6.2 數據、對象的反對稱性 89
6.3 得墨忒耳律 91
6.3.1 火車失事 91
6.3.2 混雜 92
6.3.3 隱藏結構 92
6.4 數據傳送對象 93
6.5 小結 94
6.6 文獻 94
第7章 錯誤處理 95
7.1 使用異常而非返迴碼 96
7.2 先寫Try-Catch-Finally語句 97
7.3 使用不可控異常 98
7.4 給齣異常發生的環境說明 99
7.5 依調用者需要定義異常類 99
7.6 定義常規流程 100
7.7 彆返迴null值 101
7.8 彆傳遞null值 102
7.9 小結 103
7.10 文獻 104
第8章 邊界 105
8.1 使用第三方代碼 106
8.2 瀏覽和學習邊界 107
8.3 學習log4j 108
8.4 學習性測試的好處不隻是免費 110
8.5 使用尚不存在的代碼 110
8.6 整潔的邊界 111
8.7 文獻 112
第9章 單元測試 113
9.1 TDD三定律 114
9.2 保持測試整潔 115
9.3 整潔的測試 116
9.3.1 麵嚮特定領域的測試語言 118
9.3.2 雙重標準 119
9.4 每個測試一個斷言 121
9.5 F.I.R.S.T. 122
9.6 小結 123
9.7 文獻 124
第10章 類 125
10.1 類的組織 126
10.2 類應該短小 126
10.2.1 單一權責原則 128
10.2.2 內聚 129
10.2.3 保持內聚性就會得到許多短小的類 130
10.3 為瞭修改而組織 136
10.4 文獻 139
第11章 係統 141
11.1 如何建造一個城市 142
11.2 將係統的構造與使用分開 142
11.2.1 分解main 143
11.2.2 工廠 143
11.2.3 依賴注入 144
11.3 擴容 145
11.4 Java代理 148
11.5 純Java AOP框架 150
11.6 AspectJ的方麵 152
11.7 測試驅動係統架構 153
11.8 優化決策 154
11.9 明智使用添加瞭可論證價值的標準 154
11.10 係統需要領域特定語言 154
11.11 小結 155
11.12 文獻 155
第12章 迭進 157
12.1 通過迭進設計達到整潔目的 157
12.2 簡單設計規則1:運行所有測試 158
12.3 簡單設計規則2~4:重構 158
12.4 不可重復 159
12.5 錶達力 161
12.6 盡可能少的類和方法 162
12.7 小結 162
12.8 文獻 162
第13章 並發編程 163
13.1 為什麼要並發 164
13.2 挑戰 165
13.3 並發防禦原則 166
13.3.1 單一權責原則 166
13.3.2 推論:限製數據作用域 166
13.3.3 推論:使用數據復本 167
13.3.4 推論:綫程應盡可能地獨立 167
13.4 瞭解Java庫 167
13.5 瞭解執行模型 168
13.5.1 生産者-消費者模型 169
13.5.2 讀者-作者模型 169
13.5.3 宴席哲學傢 169
13.6 警惕同步方法之間的依賴 169
13.7 保持同步區域微小 170
13.8 很難編寫正確的關閉代碼 170
13.9 測試綫程代碼 171
13.9.1 將僞失敗看作可能的綫程問題 171
13.9.2 先使非綫程代碼可工作 171
13.9.3 編寫可插拔的綫程代碼 172
13.9.4 編寫可調整的綫程代碼 172
13.9.5 運行多於處理器數量的綫程 172
13.9.6 在不同平颱上運行 172
13.9.7 裝置試錯代碼 173
13.9.8 硬編碼 173
13.9.9 自動化 174
13.10 小結 175
13.11 文獻 175
第14章 逐步改進 176
14.1 Args的實現 177
14.2 Args:草稿 183
14.2.1 所以我暫停瞭 195
14.2.2 漸進 195
14.3 字符串參數 197
14.4 小結 234
第15章 JUnit內幕 235
15.1 JUnit框架 236
15.2 小結 249
第16章 重構SerialDate 251
16.1 首先,讓它能工作 252
16.2 讓它做對 254
16.3 小結 266
16.4 文獻 267
第17章 味道與啓發 269
17.1 注釋 270
17.2 環境 271
17.3 函數 271
17.4 一般性問題 272
17.5 Java 288
17.6 名稱 291
17.7 測試 294
17.8 小結 295
17.9 文獻 296
附錄A 並發編程II 297
A.1 客戶端/服務器的例子 297
A.1.1 服務器 297
A.1.2 添加綫程代碼 298
A.1.3 觀察服務器端 299
A.1.4 小結 301
A.2 執行的可能路徑 301
A.2.1 路徑數量 302
A.2.2 深入挖掘 303
A.2.3 小結 305
A.3 瞭解類庫 305
A.3.1 Executor框架 305
A.3.2 非鎖定的解決方案 306
A.3.3 非綫程安全類 307
A.4 方法之間的依賴可能破壞並發代碼 308
A.4.1 容忍錯誤 309
A.4.2 基於客戶代碼的鎖定 309
A.4.3 基於服務端的鎖定 311
A.5 提升吞吐量 312
A.5.1 單綫程條件下的吞吐量 313
A.5.2 多綫程條件下的吞吐量 313
A.6 死鎖 314
A.6.1 互斥 315
A.6.2 上鎖及等待 315
A.6.3 無搶先機製 315
A.6.4 循環等待 315
A.6.5 不互斥 316
A.6.6 不上鎖及等待 316
A.6.7 滿足搶先機製 317
A.6.8 不做循環等待 317
A.7 測試多綫程代碼 317
A.8 測試綫程代碼的工具支持 320
A.9 小結 320
A.10 教程:完整代碼範例 321
A.10.1 客戶端/服務器非綫程代碼 321
A.10.2 使用綫程的客戶端/服務器代碼 324
附錄B org.jfree.date.SerialDate 327
結束語 389
精彩書摘
這也意味著函數不應該大到足以容納嵌套結構。所以,函數的縮進層級不該多於一層或兩層。當然,這樣的函數易於閱讀和理解。代碼清單3-1顯然想做好幾件事。它創建緩衝區、獲取頁麵、搜索繼承下來的頁麵、渲染路徑、添加神秘的字符串、生成HTML,如此等等。代碼清單3-1手忙腳亂。而代碼清單3-3則隻做一件簡單的事。它將設置和拆解包納到測試頁麵中。
過去30年以來,以下建議以不同形式一再齣現:函數應該做一件事。做好這件事。隻做這一件事。
問題在於很難知道那件該做的事是什麼。
代碼清單3.3隻做瞭一件事,對吧?其實也很容易看作是三件事:(1)判斷是否為測試頁麵;(2)如果是,則容納進設置和分拆步驟;(3)渲染成HTML。如果函數隻是做瞭該函數名下同一抽象層上的步驟,則函數還是隻做瞭一件事。
編寫函數畢竟是為瞭把大一些的概念(換言之,函數的名稱)拆分為另一抽象層上的一係列步驟。
代碼清單3.1明顯包括瞭處於多個不同抽象層級的步驟。顯然,它所做的不止一件事。即便是代碼清單3-2也有兩個抽象層,這已被我們將其縮短的能力所證明。然而,很難再將代碼清單3.3做有意義的縮短。可以將if語句拆齣來做一個名為include Setup And Teardonws Ifrestpage的函數,但那隻是重新詮釋代碼,並未改變抽象層級。
所以,要判斷函數是否不止做瞭一件事,還有一個方法,就是看是否能再拆齣一個函數,該函數不僅隻是單純地重新詮釋其實現。
前言/序言
樂嚼(Ga.J01)是在丹麥最受歡迎的糖果品種之一,它濃鬱的甘草味道,完美地彌補瞭此地潮濕且時常寒冷的天氣。對於我們這些丹麥人,樂嚼的妙處還在於包裝盒頂上印製的哲言慧語。今早我買瞭一包兩件裝,在其包裝盒上發現這句丹麥諺語:“小處誠實非小事。”這句話正好是我想在這裏說的。以小見大。本書寫到瞭一些價值殊勝的小主題。
神在細節之中,建築師(路德維希·密斯·範·德·羅)如是說。這句話引發瞭有關軟件開發、特彆是敏捷軟件開發中架構所處地位的若乾爭論。鮑勃(Bob)2和我時常發現自己沉湎於此類對話中。沒錯,LudwigmiesVanderRohe的確專注於效用和基於宏偉架構之上的永恒建築形式。然而,他也為自己設計的每所房屋挑選每個門把手。為什麼?因為小處見大。
就TDD3話題展開目前仍在繼續的“辯論”時,鮑勃和我認識到,我們均同意軟件架構在開發中占據重要地位,但就其確切意義而言,我們之間還有分歧。然而,這種矛與盾孰利的討論相對而言並不重要,因為在項目開始之時,我們理所當然應該讓專業人士投入些許時間去思考及規劃。20世紀90年代末期有關僅以測試和代碼驅動設計的概念已一去不返。相對於任何宏偉願景,對細節的關注甚至是更為關鍵的專業性基礎。首先,開發者通過小型實踐獲得可用於大型實踐的技能和信用度。其次,宏大建築中最細小的部分,比如關不緊的門、有點兒沒鋪平的地闆,甚至是淩亂的桌麵,都會將整個大局的魅力毀滅殆盡。這就是整潔代碼之所係。
架構隻是軟件開發用到的藉喻之一,主要用在那種等同於建築師交付毛坯房一般交付初始軟件産品的場閤。在Serum和敏捷(Agile)的日子裏,人們關注的是快速將産品推嚮市場。我們要求工廠全速運轉、生産軟件。這就是人類工廠:懂思考、會感受的編碼人,他們由産品備忘或用戶故事開始創造産品。來自製造業的藉喻在這種場閤大行其道。例如,Serum就從裝配綫式的日本汽車生産方式中獲益良多。
《卓越代碼煉金術:讓你的程序像藝術品一樣流暢優雅》 在瞬息萬變的軟件開發浪潮中,代碼的質量如同航船的龍骨,直接決定瞭其能否乘風破浪,抵達成功的彼岸。我們常常沉浸於實現功能、解決bug的忙碌之中,卻忽視瞭代碼本身作為一種“作品”的內在價值。一段清晰、易懂、可維護的代碼,不僅能讓團隊協作更加順暢,更能顯著提升開發效率,降低維護成本,甚至激發創新靈感。本書正是為你揭示那條通往卓越代碼的隱秘路徑,將你從“寫能跑的代碼”提升至“寫優雅的代碼”的境界,讓你成為一名真正的軟件工藝大師。 為什麼你的代碼需要“優雅”? 想象一下,當你接過一份新項目,麵對一堆晦澀難懂、邏輯纏繞的代碼時,內心湧起的將是怎樣的無奈?修改一個微小的bug,卻可能牽一發而動全身,引發更多意想不到的問題。隨著項目規模的增長,這種“技術債”的纍積,最終會扼殺項目的生命力,讓團隊陷入無休止的維護泥潭。 “優雅的代碼”並非遙不可及的抽象概念,它是一種切實可行的編程哲學,一種將軟件開發視為精湛手藝的職業態度。它意味著代碼不僅能正常工作,更能以一種自然、直觀、賞心悅目的方式錶達其意圖。它具備以下特質: 可讀性極高: 即使是初次接觸代碼的開發者,也能迅速理解其邏輯和功能,仿佛在閱讀一本故事書,而不是在破解一份密碼。 易於修改和擴展: 當業務需求發生變化時,修改或添加新功能的過程將變得輕鬆而安全,避免瞭“牽一發而動全身”的恐懼。 低維護成本: 減少瞭因代碼復雜性、耦閤性過高而産生的bug,大大降低瞭團隊在維護上的時間和精力投入。 高度的內聚性與低耦閤性: 各個模塊之間職責清晰,相互獨立,隻做該做的事,不乾涉其他部分。 清晰的意圖錶達: 代碼本身就能夠清晰地傳達其設計者的意圖,減少瞭對額外注釋的依賴。 測試友好: 易於編寫單元測試和集成測試,確保代碼的健壯性和可靠性。 本書將帶領你深入探究這些特質的實現方法,為你提供一套係統性的實踐指南,幫助你構建真正經得起時間考驗的軟件。 本書將為你帶來什麼? 本書並非空泛的理論宣講,而是一本充滿實際指導和案例分析的“操作手冊”。我們將從最基礎的代碼元素開始,層層深入,為你揭示構建卓越代碼的每一個關鍵環節。 第一篇:代碼的本質與原則 何謂“潔淨代碼”? 我們將從源頭齣發,探討“潔淨代碼”的核心定義,它不僅僅是“寫對的代碼”,更是“寫得好”的代碼。理解代碼的“情緒”與“健康度”,為後續的優化打下堅實基礎。 編碼的四大支柱: 變量、函數、注釋、格式化。你可能認為這些是再熟悉不過的元素,但它們卻是構建所有代碼的基石。本書將顛覆你對這些基礎概念的認知,教你如何運用它們來寫齣清晰、準確、富有錶現力的代碼。 命名藝術: 告彆那些含糊不清、令人費解的變量名和函數名。學習如何賦予每一個名稱以清晰的含義,讓代碼本身成為一種描述。我們將探討命名的各種策略,從描述性命名到約定俗成的命名,讓你成為一個命名大師。 函數的設計哲學: 函數是代碼的基本構建塊,一個好的函數應該做什麼?如何纔能做到“隻做一件事”?我們將深入探討函數簽名、參數數量、函數長度、職責單一性等核心原則,教你如何設計齣短小精悍、易於理解和測試的函數。 注釋的智慧: 什麼時候需要注釋?什麼樣的注釋纔是有效的?我們將強調“代碼自文檔化”的重要性,以及如何用注釋來解釋“為什麼”而不是“做什麼”。學習如何寫齣那些真正能提升代碼理解度的注釋,而不是那些可有可無的“廢話”。 格式化的力量: 統一、清晰的代碼格式是團隊協作的潤滑劑。我們將探討代碼布局、縮進、空行等細節,以及它們如何影響代碼的可讀性,並提供一些實用的格式化工具和技巧。 第二篇:結構之美:模塊化與設計模式的精髓 類的設計之道: 類是麵嚮對象編程的核心。我們將探討類的職責、封裝、繼承、多態等概念,以及如何設計齣低耦閤、高內聚的類。學習如何避免“上帝類”,如何通過組閤優於繼承,讓你的類體係更加靈活和健壯。 模塊化的威力: 如何將龐大的係統分解成易於管理、相互獨立的模塊?我們將探討模塊的邊界、接口設計、依賴管理等,以及如何構建一個清晰、可擴展的模塊化架構。 設計模式的實戰應用: 設計模式是前人智慧的結晶,它們是解決常見軟件設計問題的成熟方案。本書將精選那些最常用、最核心的設計模式,通過生動的案例,為你解析它們的原理、適用場景以及如何將其靈活地運用到你的項目中,從而提升代碼的可維護性、可擴展性和可重用性。我們將重點關注那些真正能帶來價值的設計模式,避免陷入“過度設計”的誤區。 第三篇:代碼的健壯性與測試驅動開發 錯誤處理的藝術: 異常處理是保證程序健壯性的關鍵。我們將探討如何有效地捕獲和處理異常,如何設計齣清晰的錯誤處理策略,以及如何避免常見的異常處理陷阱。 測試驅動開發(TDD)的實踐: 測試不僅僅是驗證代碼的功能,更是指導代碼設計的強大工具。我們將深入講解TDD的紅綠重構循環,以及如何通過編寫先行測試來驅動代碼的開發,從而寫齣更具魯棒性、更易於測試的代碼。學習如何編寫高質量的單元測試,確保你的代碼質量。 代碼重構的藝術: 重構是提升代碼質量、消除技術債的持續過程。我們將講解各種有效的重構技術,以及何時進行重構,如何安全地進行重構,讓你的代碼在不斷演進中保持優雅。 第四篇:高效協作與代碼文化 代碼評審的力量: 代碼評審是團隊協作中不可或缺的一環。我們將探討如何進行有效的代碼評審,如何提供建設性的反饋,以及如何從他人的代碼中學習。 建立卓越的代碼文化: 最終,卓越的代碼源於一種卓越的團隊文化。本書將探討如何在團隊中倡導並踐行潔淨代碼的理念,如何通過持續學習和改進,共同打造一個高效、愉悅的開發環境。 誰適閤閱讀本書? 無論你是初涉編程的學徒,還是經驗豐富的資深開發者,亦或是項目經理、技術負責人,本書都將為你提供寶貴的啓示和實用的技巧。 初級開發者: 幫助你打下堅實的代碼基礎,避免走彎路,從一開始就養成良好的編程習慣。 中級開發者: 助你突破瓶頸,提升代碼質量,掌握更高級的設計和重構技巧,成為團隊中的技術骨乾。 資深開發者: 為你帶來新的視角和深入的思考,幫助你將卓越代碼的理念融入日常開發,引領團隊走嚮更高的技術水準。 項目經理/技術負責人: 幫助你理解代碼質量對項目成功的重要性,從而更好地指導團隊,優化開發流程。 本書的承諾: 本書承諾提供一套切實可行的、可立即應用的實踐方法。我們將通過大量生動、貼近實際的案例,讓你在理解理論的同時,能夠立刻將所學應用到你的工作中。本書並非教你“速成”,而是引領你踏上一條通往“精湛”的長期之路。 準備好開啓你的卓越代碼之旅瞭嗎? 翻開本書,你將不僅僅是學習編寫代碼,更是學習如何像一位真正的工匠一樣,用心雕琢你的數字藝術品。讓我們一起,用卓越的代碼,書寫更美好的軟件未來!