整潔代碼經典實例

目錄
序 1
前言 3
第1 章 整潔代碼 9
1.1 什么是代碼壞味道？ .9
1.2 重構是什么？ .10
1.3 什么是經典實例？ 10
1.4 為什么要寫整潔的代碼？ 11
1.5 可讀性、性能,或者兩者兼而有之. 11
1.6 軟件類型 11
1.7 機器生成的代碼 12
1.8 本書中的命名考慮 12
1.9 設計模式13
1.10 編程語言范式 13
1.11 對象與類的比較 13
1.12 可變性 .14
第2 章 建立原則 15
2.0 引言 .15
2.1 為什么它是一個模型？ .16
2.2 為什么它是抽象的？ 16
2.3 為什么它是可編程的？ .16
2.4 為什么它是部分的？ 17
2.5 為什么它是解釋性的？ .17
2.6 為什么它與現(xiàn)實有關？ .18
2.7 推斷規(guī)則18
2.8 唯一的軟件設計原則 18
第3 章 貧血模型 25
3.0 引言 .25
3.1 將貧血對象轉換為豐富對象 26
3.2 識別你的對象的本質 28
3.3 移除對象中的setter .30
3.4 移除貧血代碼生成器 32
3.5 移除自動屬性 .34
3.6 移除DTO .35
3.7 完善空構造函數(shù) 39
3.8 移除getter 40
3.9 防止對象隨意調用 44
3.10 移除動態(tài)屬性 45
第4 章 原始偏執(zhí) 49
4.0 引言 .49
4.1 創(chuàng)建小對象 50
4.2 實例化原始數(shù)據(jù) 52
4.3 實例化關聯(lián)數(shù)組 53
4.4 移除濫用字符串 55
4.5 實例化時間戳 .57
4.6 實例化子集為對象 58
4.7 實例化字符串驗證 59
4.8 移除不必要的屬性 62
4.9 創(chuàng)建日期區(qū)間 .64
第5 章 可變性 67
5.0 引言 .67
5.1 將變量改為常量 69
5.2 聲明變量為可變變量 70
5.3 禁止改變本質 .72
5.4 避免可變的常量數(shù)組 74
5.5 移除延遲初始化 76
5.6 凍結可變常量 .78
5.7 移除副作用 81
5.8 防止提升82
第6 章 聲明式代碼 85
6.0 引言 .85
6.1 縮小重用變量的范圍 86
6.2 移除空行87
6.3 移除帶版本的方法 89
6.4 移除雙重否定 .90
6.5 改變錯位的責任 91
6.6 替換顯式迭代 .93
6.7 記錄設計決策 .94
6.8 用常量替換魔法數(shù)字 95
6.9 分離“是什么”和“怎么做” 97
6.10 文檔化正則表達式 .98
6.11 重寫Yoda 條件 99
6.12 移除滑稽方法 100
6.13 避免回調地獄 101
6.14 生成良好的錯誤消息 .104
6.15 避免魔法修正 106
第7 章 命名 . 109
7.0 引言 109
7.1 擴展縮寫.109
7.2 重命名和拆分Helpers 和Utils 112
7.3 重命名MyObjects . 115
7.4 重命名結果變量 . 116
7.5 重命名以類型命名的變量 . 118
7.6 重命名長名稱 119
7.7 重命名抽象名稱 .120
7.8 更正拼寫錯誤 122
7.9 從屬性中移除類名 .122
7.10 移除類和接口的首字母 124
7.11 重命名base/do 函數(shù) 125
7.12 將復數(shù)類轉換為單數(shù) .127
7.13 從名稱中移除“Collection” .128
7.14 移除類名中的“Impl”前綴/ 后綴 .129
7.15 根據(jù)角色重命名參數(shù) .130
7.16 移除冗余的參數(shù)名稱 .131
7.17 移除名稱中的不必要上下文 133
7.18 避免數(shù)據(jù)命名 134
第8 章 注釋 . 137
8.0 引言 137
8.1 刪除被注釋的代碼 .138
8.2 刪除過時的注釋 .140
8.3 刪除邏輯注釋 141
8.4 刪除Getter 注釋 .143
8.5 將注釋轉換為函數(shù)名稱 144
8.6 刪除方法內的注釋 .145
8.7 用測試替換注釋 148
第9 章 標準 . 151
9.0 引言 151
9.1 遵循代碼規(guī)范 151
9.2 統(tǒng)一縮進方式 154
9.3 統(tǒng)一命名規(guī)范 156
9.4 用英文編寫代碼 .157
9.5 統(tǒng)一參數(shù)順序 159
9.6 修復另外的問題 .160
第10 章 復雜性 163
10.0 引言 163
10.1 移除重復代碼 163
10.2 移除設置/ 配置和功能切換 166
10.3 將狀態(tài)作為屬性更改 .167
10.4 移除代碼中的特殊設計 170
10.5 打破多個Promises 172
10.6 打破長鏈的協(xié)作 173
10.7 將方法提取到對象中 .175
10.8 關注數(shù)組構造函數(shù) 177
10.9 移除幽靈對象 179
第11 章 膨脹者 181
11.0 引言 181
11.1 分解過長的方法 181
11.2 減少過多參數(shù) 183
11.3 減少多余變量 185
11.4 移除過多的括號 188
11.5 移除過多的方法 189
11.6 分解過多的屬性 190
11.7 減少導入列表 192
11.8 拆分“與”功能 193
11.9 拆分臃腫的接口 195
第12 章 YAGNI 199
12.0 引言 199
12.1 移除死代碼 .200
12.2 使用代碼代替圖表 201
12.3 重構只有一個子類的類 203
12.4 移除只使用一次的接口 205
12.5 移除設計模式的濫用 .207
12.6 替換業(yè)務集合 208
第13 章 快速失敗 211
13.0 引言 211
13.1 變量重新賦值的重構 . 211
13.2 強制前提條件 213
13.3 使用更嚴格的參數(shù) 216
13.4 移除開關語句中的默認情況 217
13.5 避免在遍歷時修改集合 219
13.6 重新定義哈希和相等性 220
13.7 無功能性變化的重構 .222
第14 章 條件語句 225
14.0 引言 225
14.1 用多態(tài)替換偶然的if 語句 226
14.2 為事件重命名標志變量 234
14.3 實例化布爾變量 235
14.4 替換Switch/Case/elseif 語句 .237
14.5 使用集合替換硬編碼的if 條件 .239
14.6 將布爾值改為短路條件 241
14.7 添加隱式else .242
14.8 重寫條件箭頭代碼 243
14.9 避免使用短路技巧 245
14.10 重寫嵌套的箭頭代碼 247
14.11 避免返回布爾值進行條件檢查 249
14.12 更改布爾值的比較方式 .251
14.13 從長三元表達式中提取 .252
14.14 將非多態(tài)函數(shù)轉換為多態(tài)函數(shù) 254
14.15 改變相等比較 .256
14.16 使硬編碼的業(yè)務條件具體化 257
14.17 移除不必要的布爾值 258
14.18 重寫嵌套三元條件 259
第15 章 空值 263
15.0 簡介 263
15.1 創(chuàng)建空對象 .263
15.2 移除可選鏈路 267
15.3 將可選屬性轉換為集合 270
15.4 使用真實對象作為空對象272
15.5 不使用空對象表示未知位置 275
第16 章 過早優(yōu)化 279
16.0 引言 279
16.1 避免對象上的標識符 .280
16.2 移除過早的優(yōu)化 283
16.3 移除位運算的過早優(yōu)化 285
16.4 減少過度泛化 286
16.5 改變結構優(yōu)化 287
16.6 移除錨定船只 289
16.7 從領域對象中提取緩存 290
16.8 基于實現(xiàn)的回調事件的移除 293
16.9 移除構造函數(shù)中的查詢 294
16.10 從析構函數(shù)中移除代碼 .295
第17 章 耦合 299
17.0 引言 299
17.1 顯式化隱藏假設 299
17.2 替換單例模式 301
17.3 打破上帝對象 304
17.4 打破分歧性變更 307
17.5 將9999 特殊標志值轉換為正常值 .309
17.6 移除散彈代碼 311
17.7 移除可選參數(shù) 313
17.8 防止特性依戀 315
17.9 移除中間人 .317
17.10 將默認參數(shù)移到末尾 319
17.11 避免連鎖反應 .321
17.12 移除業(yè)務對象上的意外方法 323
17.13 從用戶界面中移除業(yè)務代碼 324
17.14 改變類之間的耦合 328
17.15 重構數(shù)據(jù)團 330
17.16 打破不恰當?shù)挠H密關系 .332
17.17 轉換可互換對象.334
第18 章 全局變量 337
18.0 引言 337
18.1 實例化全局函數(shù) 337
18.2 實例化靜態(tài)函數(shù) 339
18.3 用結構化代碼替換GoTo .340
18.4 移除全局類 .341
18.5 改變全局日期創(chuàng)建 344
第19 章 層次結構 347
19.0 引言 347
19.1 打破深層繼承 347
19.2 打破悠悠球層次結構 .350
19.3 打破子分類以重用代碼 352
19.4 用行為替換“is-a”關系 .355
19.5 移除嵌套類 .357
19.6 重命名孤立類 359
19.7 使具體類成為最終類 .360
19.8 顯式定義類的繼承關系 362
19.9 遷移空類 364
19.10 推遲過早的分類.366
19.11 移除受保護的屬性 368
19.12 完成空實現(xiàn) 370
第20 章 測試 373
20.0 引言 373
20.1 測試私有方法 374
20.2 為斷言添加描述 376
20.3 將 assertTrue 遷移到特定斷言 377
20.4 用真實對象替換模擬對象 379
20.5 優(yōu)化通用斷言 382
20.6 移除不穩(wěn)定的測試 383
20.7 更改浮點數(shù)斷言 385
20.8 將測試數(shù)據(jù)改為真實數(shù)據(jù)386
20.9 保護違反封裝的測試 .389
20.10 移除不相關的測試信息 .391
20.11 在每個合并請求中添加覆蓋率 393
20.12 根據(jù)日期重寫測試 394
20.13 學習一種新的編程語言 .396
第21 章 技術債務 399
21.0 引言 399
21.1 移除依賴于生產環(huán)境的代碼 400
21.2 移除缺陷跟蹤器 402
21.3 移除警告/ 嚴格模式關閉 403
21.4 預防和移除 ToDo 和 FixMe 405
第22 章 異常 407
22.0 引言 407
22.1 刪除空的異常塊 407
22.2 刪除不必要的異常 409
22.3 重寫預期情況下的異常 411
22.4 重寫嵌套的try/catch 塊 412
22.5 用異常替換返回代碼 .414
22.6 重寫異常箭頭代碼 416
22.7 隱藏終端用戶的低級錯誤418
22.8 縮小異常范圍 419
第23 章 元編程 423
23.0 簡介 423
23.1 移除元編程用法 424
23.2 實例化匿名函數(shù) 428
23.3 移除預處理器 430
23.4 移除動態(tài)方法 431
第24 章 類型 435
24.0 引言 435
24.1 移除類型檢查 435
24.2 處理真值 437
24.3 將浮點數(shù)改為小數(shù) 441
第25 章 安全性 443
25.0 引言 443
25.1 輸入過濾 443
25.2 更改順序ID 445
25.3 移除包依賴 .447
25.4 替換惡意正則表達式 .449
25.5 保護對象反序列化 450
術語表 453