框架設計指南：構建可復用 .NET庫的約定、慣例與模式, 3/e

本書從最基本的設計原則和準則出發，全方位介紹了設計框架的最佳實踐，是微軟工程師從.NET Framework開發伊始到現如今的.NET這二十來年間寶貴經驗的總結。 與第2版發布時的2008年相比，今天的軟件開發範式用翻天覆地來形容也不為過，容器化、雲服務、跨平臺、DevOps等，都對今天的軟件開發者和框架設計者提出了更高的要求。本書對第2版的內容進行了全面的更新，以適應當下發展的潮流。本書雖然是面向.NET平臺上的框架設計的，但對其他平臺的框架設計同樣具有非凡的借鑒價值。通過閱讀本書，讀者可以瞭解到如何設計出一個對使用者而言簡單、易用且具有一致性的優秀框架。

導論 1
1.1 設計精良的框架的特質 2
1.1.1 設計精良的框架是簡單的 2
1.1.2 設計精良的框架設計成本高昂 3
1.1.3 設計精良的框架充滿權衡 4
1.1.4 設計精良的框架會借鑒過往經驗 5
1.1.5 設計精良的框架旨在不斷發展 5
1.1.6 設計精良的框架是完整統一的 6
1.1.7 設計精良的框架是一致的 6
2 框架設計基礎 7
2.1 漸進式框架 9
2.2 框架設計基本原則 12
2.2.1 場景驅動設計原則 12
2.2.2 低門檻原則 18
2.2.3 對象模型自文檔化原則 22
2.2.4 分層架構原則 27
總結 29
3 命名準則 30
3.1 大小寫約定 30
3.1.1 標識符的大小寫規則 31
3.1.2 大寫首字母縮寫詞 33
3.1.3 大寫復合詞和常見術語 36
3.1.4 大小寫敏感 38
3.2 通用命名約定 38
3.2.1 詞匯選擇 39
3.2.2 使用簡寫和首字母縮寫詞 41
3.2.3 避免使用特定於編程語言的名稱 41
3.2.4 命名現有 API 的新版本 43
3.3 程序集、DLL 和包的命名 45
3.4 命名空間的命名 47
3.4.1 命名空間和類型名稱的沖突 48
3.5 類、結構體和接口的命名 50
3.5.1 泛型參數的命名 52
3.5.2 通用類型的命名 52
3.5.3 枚舉的命名 53
3.6 類型成員的命名 55
3.6.1 方法的命名 55
3.6.2 屬性的命名 55
3.6.3 事件的命名 57
3.6.4 字段的命名 58
3.7 命名參數 59
3.7.1 命名運算符重載參數 59
3.8 命名資源 60
總結 60
4 類型設計準則 61
4.1 類型和命名空間 63
4.2 在類和結構體之間選擇 66
4.3 在類和接口之間選擇 68
4.4 抽象類設計 75
4.5 靜態類設計 76
4.6 接口設計 77
4.7 結構體設計 79
4.8 枚舉設計 83
4.8.1 設計標記枚舉 89
4.8.2 添加枚舉值 92
4.9 嵌套類型 93
4.10 類型和程序集元數據 95
4.11 強類型字符串 97
總結 100
5 成員設計 101
5.1 一般成員設計準則 101
5.1.1 成員重載 101
5.1.2 顯式實現接口成員 111
5.1.3 在屬性和方法之間選擇 114
5.2 屬性設計 119
5.2.1 索引屬性設計 120
5.2.2 屬性變更通知事件 123
5.3 構造函數設計 124
5.3.1 類型構造函數準則 130
5.4 事件設計 132
5.5 字段設計 136
5.6 擴展方法 139
5.7 運算符重載 146
5.7.1 重載 operator== 149
5.7.2 轉換運算符 149
5.7.3 比較運算符 151
5.8 參數設計 152
5.8.1 在枚舉參數和布爾參數之間選擇 154
5.8.2 參數驗證 156
5.8.3 參數傳遞 159
5.8.4 參數數量可變的成員 162
5.8.5 指針參數 165
5.9 在成員簽名中使用元組 166
總結 171
6 可擴展性設計 172
6.1 可擴展性機制 172
6.1.1 非密封類 172
6.1.2 受保護的成員 174
6.1.3 事件和回調 175
6.1.4 虛成員 180
6.1.5 抽象（抽象類和接口） 181
6.2 基類 183
6.3 密封 185
總結 187
7 異常 188
7.1 拋出異常 192
7.2 選擇拋出正確的異常類型 196
7.2.1 錯誤消息設計 199
7.2.2 異常處理 200
7.2.3 包裝異常 205
7.3 使用標準異常類型 206
7.3.1 Exception和SystemException 206
7.3.2 ApplicationException 207
7.3.3 InvalidOperationException 207
7.3.4 ArgumentException、ArgumentNullException 和 ArgumentOutOfRangeException 207
7.3.5 NullReferenceException、IndexOutOfRangeException 和 AccessViolationException 208
7.3.6 StackOverflowException 208
7.3.7 OutOfMemoryException 209
7.3.8 ComException、SEHException和ExecutionEngineException 210
7.3.9 OperationCanceledException 和 TaskCanceledException 210
7.3.10 FormatException 210
7.3.11 PlatformNotSupportedException 211
7.4 設計自定義異常 211
7.5 異常和性能 212
7.5.1 測試者-執行者模式 212
7.5.2 Try模式 213
總結 216
8 使用準則 217
8.1 數組 217
8.2 特性 220
8.3 集合 223
8.3.1 集合參數 224
8.3.2 集合屬性和返回值 225
8.3.3 在數組和集合之間選擇 229
8.3.4 實現自定義集合 230
8.4 DateTime 和 DateTimeOffset 231
8.5 ICloneable 233
8.6 IComparable＜T＞ 和 IEquatable＜T＞ 234
8.7 IDisposable 236
8.8 Nullable＜T＞ 236
8.9 Object 237
8.9.1 Object.Equals 237
8.9.2 Object.GetHashCode 238
8.9.3 Object.ToString 240
8.10 序列化 241
8.11 Uri 243
8.11.1 System.Uri 的實現準則 244
8.12 System.Xml 的使用 245
8.13 相等運算符 246
8.13.1 值類型上的相等運算符 248
8.13.2 引用類型上的相等運算符 248
9 通用設計模式 249
9.1 聚合組件 249
9.1.1 面向組件的設計 251
9.1.2 因子類型 253
9.1.3 聚合組件準則 254
9.2 異步模式 256
9.2.1 選擇異步模式 256
9.2.2 基於任務的異步模式 258
9.2.3 異步方法的返回類型 263
9.2.4 為現有的同步方法製作一個異步變體 265
9.2.5 異步模式一致性的實現準則 268
9.2.6 經典異步模式 272
9.2.7 基於事件的異步模式 273
9.2.8 IAsyncDisposable 273
9.2.9 IAsyncEnumerable＜T＞ 273
9.2.10 await foreach 的使用準則 274
9.3 依賴屬性 276
9.3.1 依賴屬性設計 277
9.3.2 附加屬性的設計 279
9.3.3 依賴屬性校驗 280
9.3.4 依賴屬性變更通知 280
9.3.5 依賴屬性中的值強制 281
9.4 Dispose 模式 282
9.4.1 基本Dispose模式 284
9.4.2 可終結類型 290
9.4.3 限定作用域的操作 293
9.4.4 IAsyncDisposable 296
9.5 工廠 299
9.6 LINQ 支持 303
9.6.1 LINQ 概覽 303
9.6.2 實現 LINQ 支持的方法 304
9.7 可選功能模式 309
9.8 協變和逆變 312
9.8.1 逆變 315
9.8.2 協變 316
9.8.3 模擬協變模式 319
9.9 模板方法 321
9.10 超時 323
9.11 XAML 可讀類型 324
9.12 操作緩沖 326
9.12.1 數據轉換操作 338
9.12.2 向緩沖區中寫入固定大小或預定大小的數據 343
9.12.3 使用 Try-Write 模式向緩沖區中寫入數據 344
9.12.4 部分寫入緩沖區和OperationStatus 348
9.13 最後 353
附錄A C#編碼風格約定 354
A.1 通用風格約定 355
A.1.1 花括號的使用 355
A.1.2 空格的使用 357
A.1.3 縮進的使用 358
A.1.4 垂直空白 360
A.1.5 成員修飾符 361
A.1.6 其他 362
A.2 命名約定 367
A.3 註釋 368
A.4 文件組織 369
附錄B 過時的準則 371
B.3 命名準則中的過時準則 371
B.3.8 命名資源 371
B.4 類型設計準則中的過時準則 372
B.4.1 類型和命名空間 372
B.5 成員設計準則中的過時準則 374
B.5.4 事件的設計 374
B.7 異常設計準則中的過時準則 375
B.7.4 設計自定義異常 375
B.8 常見類型使用準則中的過時準則 376
B.8.10 序列化 376
B.9 通用設計模式中的過時準則 383
B.9.2 異步模式 383
B.9.4 Dispose 模式 394
附錄C API規範示例 398
附錄D 不兼容變更 403
D.1 修改程序集 404
D.1.1 改變程序集的名稱（） 404
D.2 添加命名空間 405
D.2.1 添加與現有類型沖突的命名空間（） 405
D.3 修改命名空間 405
D.3.1 修改命名空間的名稱或改變大小寫（） 405
D.4 移動類型 405
D.4.1 通過 [TypeForwardedTo] 移動類型（） 405
D.4.2 不通過 [TypeForwardedTo] 移動類型（） 406
D.5 刪除類型 406
D.5.1 刪除類型（） 406
D.6 修改類型 407
D.6.1 密封一個非密封的類型（） 407
D.6.2 解封一個密封類型（） 407
D.6.3 改變類型名稱的大小寫（） 407
D.6.4 改變類型名稱（） 407
D.6.5 改變類型的命名空間（） 408
D.6.6 為結構體添加 readonly 修飾符（） 408
D.6.7 從結構體中移除 readonly 修飾符（） 408
D.6.8 為現有接口添加基接口（） 408
D.6.9 為同一個泛型接口添加第二個聲明（） 409
D.6.10 將類變更為結構體（） 409
D.6.11 將結構體變更為類（） 410
D.6.12 將 struct 變更為 ref struct（） 410
D.6.13 將 ref struct 變更為（非ref）struct（） 410
D.7 添加成員 411
D.7.1 通過 new 修飾符掩蓋基類成員（） 411
D.7.2 添加抽象成員（） 411
D.7.3 為非密封類型添加成員（） 411
D.7.4 為非密封類型添加覆寫成員（） 412
D.7.5 為結構體添加第一個引用類型字段（） 412
D.7.6 為接口添加成員（） 412
D.8 移動成員 413
D.8.1 將成員移動到基類中（） 413
D.8.2 將成員移動到基接口中（） 413
D.8.3 將成員移動到派生類型中（） 413
D.9 刪除成員 413
D.9.1 從非密封類型中刪除終結器（） 413
D.9.2 從密封類型中刪除終結器（） 414
D.9.3 刪除非覆寫成員（） 414
D.9.4 刪除虛擬成員的override（） 414
D.9.5 刪除抽象成員的override（） 414
D.9.6 刪除或重命名可序列化類型的私有字段（?） 415
D.10 重載成員 415
D.10.1 為成員添加第一個重載（） 415
D.10.2 為引用類型參數添加可選參數重載（?） 416
D.11 更改成員簽名 416
D.11.1 重命名方法的參數（） 416
D.11.2 添加或刪除方法的參數（） 416
D.11.3 改變方法參數的類型（） 417
D.11.4 重新排列具有不同類型的方法參數（） 417
D.11.5 重新排列具有相同類型的方法參數（） 417
D.11.6 改變方法的返回類型（） 418
D.11.7 改變屬性的類型（） 418
D.11.8 將成員的可見性從 public 變更為其他的可見性（） 418
D.11.9 將成員的可見性從 protected 變更為 public（） 419
D.11.10 將虛（或抽象）成員從 protected 變更為 public（） 419
D.11.11 添加或刪除 static 修飾符（） 419
D.11.12 改為（或不再）按引用傳遞參數（） 419
D.11.13 改變按引用傳遞參數的風格（） 420
D.11.14 為結構體的方法添加 readonly 修飾符（） 420
D.11.15 從結構體的方法中刪除 readonly 修飾符（） 420
D.11.16 將必需參數變更為可選參數（） 421
D.11.17 將可選參數變更為必需參數（?） 421
D.11.18 改變可選參數的默認值（） 421
D.11.19 改變常量字段的值（） 421
D.11.20 將抽象成員變更為虛成員（） 422
D.11.21 將虛成員變更為抽象成員（） 422
D.11.22 將非虛成員變更為虛成員（） 422
D.12 改變行為 423
D.12.1 將運行時錯誤異常變更為使用錯誤異常（） 423
D.12.2 將使用錯誤異常變更為有用的行為（） 423
D.12.3 改變方法返回值的類型（?） 423
D.12.4 拋出新的異常類型（） 424
D.12.5 拋出新的異常類型，且它是從現有的異常類型中派生的（） 424
D.13 最後 424