讀C#代碼整潔之道筆記04_重構C#代碼識別代碼壞味道

来源:https://www.cnblogs.com/lying7/archive/2023/03/23/17232199.html
-Advertisement-
Play Games

1. 應用程式級別代碼壞味道 1.1. 布爾盲點 1.1.1. 由於函數使用布爾值而導致的信息缺失 1.1.2. 解決方案是將布爾替換為枚舉類型 1.2. 組合爆炸 1.2.1. 不同的代碼使用不同的參數組合來執行同一件事情的產物 1.2.2. 解決方案使用泛型 1.3. 人為複雜性 1.3.1.  ...


1. 應用程式級別代碼壞味道

1.1. 布爾盲點

  • 1.1.1. 由於函數使用布爾值而導致的信息缺失

  • 1.1.2. 解決方案是將布爾替換為枚舉類型

1.2. 組合爆炸

  • 1.2.1. 不同的代碼使用不同的參數組合來執行同一件事情的產物

  • 1.2.2. 解決方案使用泛型

1.3. 人為複雜性

  • 1.3.1. 簡單的架構複雜化

  • 1.3.2. 解決方案務必保持軟體的簡單易懂(Keep It Simple,Stupid,KISS)

1.4. 數據泥團

  • 1.4.1. 相同的欄位同時出現在不同的類和參數列表中時

  • 1.4.1.1. 說明系統中缺少類定義

  • 1.4.2. 識別並泛化缺失的類可以降低系統的複雜度

1.5. 粉飾註釋

  • 1.5.1. 註釋中用優美的詞句掩蓋代碼的缺點

1.6. 重覆代碼

  • 1.6.1. 多次出現的代碼

  • 1.6.1.1. bug=技術債務=程式員支出

  • 1.6.2. 解決方案將這些代碼添加到當前項目的可重用類並放置在類庫中

  • 1.6.3. 解決方案2:面向方面編程(AOP)是另一種刪除樣板代碼的方法

1.7. 意圖不明

  • 1.7.1. 他人無法輕易理解代碼的意圖

1.8. 可變的變數

  • 1.8.1. 不同操作之間多次更改的變數

  • 1.8.2. 消除變數的可變性,使其值更易於預測

  • 1.8.3. 函數編程

  • 1.8.3.1. LINQ

1.9. 怪異的解決方案

  • 1.9.1. 源代碼中解決同樣問題的方案多種多樣

  • 1.9.1.1. 源代碼中解決同樣問題的方案多種多樣

  • 1.9.1.2. 沒有制定統一標準而造成

  • 1.9.1.3. 程式員並沒有意識到系統中已經存在解決方案

  • 1.9.2. 解決方案:不同的重覆的解決方案編寫新類,並將最整潔最高效的方式添加到類中

  • 1.9.3. 解決方案2:適配器模式來統一不同的系統介面

1.10. 霰彈式修改

  • 1.10.1. 一種改動需要在多個類中進行修改

  • 1.10.1.1. 複雜的代碼還會導致程式員認知負擔過重

  • 1.10.2. 減少耦合可以使類更易於測試

  • 1.10.3. 將不屬於類的代碼移出到恰當的位置可以提高應用程式的可讀性、可維護性與可擴展性

1.11. 解決方案蔓延

  • 1.11.1. 一種職責在不同的方法、類甚至庫中均被實現

  • 1.11.2. 單一職責轉移到同一個類中

1.12. 不可控的副作用

  • 1.12.1. 在產品中由於無法被質量保證過程發現而引起的問題

  • 1.12.2. 唯一的辦法就是重構代碼使其完全可測,並可以在調試期間查看變數的狀態以確保程式的正確性。

2. 類級別代碼壞味道

2.1. 過高的圈複雜度

  • 2.1.1. 大量的分支和迴圈

  • 2.1.2. 1~10

  • 2.1.2.1. 代碼簡單沒有風險

  • 2.1.3. 11~20

  • 2.1.3.1. 較複雜,風險相對較低

  • 2.1.4. 21~50

  • 2.1.4.1. 引起註意,中等風險

  • 2.1.5. 超過50

  • 2.1.5.1. 風險高,必須重構

  • 2.1.6. 解決方案

  • 2.1.6.1. 使用工廠模式替換switch語句

  • 2.1.6.2. 改善if語句條件檢測的可讀性

  • 2.1.6.3. LINQ語句替換迴圈

2.2. 發散式變化

  • 2.2.1. 對代碼進行一處更改,但是發現自己必須更改許多不相關的方法

  • 2.2.2. 原因

  • 2.2.2.1. 類結構不良造成

  • 2.2.2.2. 複製粘貼代碼

  • 2.2.2.3. 利用基類和子類的關係實現繼承

2.3. 向下類型轉換

  • 2.3.1. 將基類轉換為它的一個子類

2.4. 過度的字面量使用

  • 2.4.1. 將字面量保存在常量中

  • 2.4.2. 將字元串字面量放置在本地化資源文件中

2.5. 依戀情結

  • 2.5.1. 當一個方法花費大量的時間處理類中的代碼而非自身的代碼

2.6. 狎昵(xiá nì)關係

  • 2.6.1. 一個類若依賴另一個類的實現細節

  • 2.6.2. 類之間不應當相互依賴

  • 2.6.3. 類應當是自包含的

  • 2.6.4. 類之間應該儘可能少地互相瞭解彼此的底細

2.7. 不恰當的暴露

  • 2.7.1. 類暴露了其內部細節

  • 2.7.2. 打破了面向對象編程的封裝原則

2.8. 巨大的類

  • 2.8.1. 務必令其儘可能小巧、整潔、易於閱讀

2.9. 冗贅類

  • 2.9.1. 一種並不包含什麼有效操作的類

  • 2.9.2. 和其他包含相似意圖的類合併

  • 2.9.3. 削減繼承層次結構

  • 2.9.3.1. 理想的繼承層次是1

  • 2.9.4. 非常小的類還可以考慮採用內聯的處理方法

2.10. 中間人類

  • 2.10.1. 僅將功能委托給其他對象

  • 2.10.2. 捨棄中間人直接和處理相應職責的類進行交互

  • 2.10.3. 將其與現有類合併

2.11. 孤立的變數和常量類

  • 2.11.1. 使用一個獨立的類來定義系統不同部分使用的變數和常量

  • 2.11.2. 丟失其上下文而無法表達任何實際含義

  • 2.11.3. 移動到使用它們的位置

2.12. 基本類型偏執

  • 2.12.1. 使用常量作為欄位名稱

  • 2.12.2. 不恰當地使用常量保存信息

  • 2.12.3. 使用基本類型值而非使用對象

2.13. 被拒絕的遺贈

  • 2.13.1. 一個類繼承自另一個類,卻沒有使用其所有方法

  • 2.13.2. 考慮是否真的需要基類

2.14. 誇誇其談未來性

  • 2.14.1. 一個類的功能現在不需要,但是將來可能用到

  • 2.14.2. 死代碼,應當將其刪除

2.15. 命令,而非詢問

  • 2.15.1. 將數據和操作數據的方法綁定在一起

  • 2.15.2. 一個對象包含邏輯,並要求其他包含數據的對象提供數據以供其執行操作,則應當將邏輯與數據合併到一個類中

2.16. 臨時欄位

  • 2.16.1. 不需要在對象的整個生命周期記憶體在的成員變數

  • 2.16.2. 將臨時欄位及操作這些欄位的方法移動到它們自己的類中

3. 方法級別的代碼壞味道

3.1. 不合群的方法

  • 3.1.1. 一個類中和其他方法截然不同的方法

  • 3.1.2. 考慮該方法的目的

  • 3.1.2.1. 確定哪裡才是該方法最合適的落腳點了

3.2. 無用的代碼

  • 3.2.1. 現存的方法無人使用

  • 3.2.2. 要識別無用的代碼並將其刪除

  • 3.2.3. 構造器、屬性和變數也應遵循相同的原則

3.3. 過多的返回數據

  • 3.3.1. 遠超客戶端的調用

3.4. 過長或過短的標識符

  • 3.4.1. 標識符應當既能描述對象又簡明扼要

3.5. 過長的代碼行

  • 3.5.1. 應儘量將其格式化,在點號和逗號處換行

3.6. 過長的方法

  • 3.6.1. 方法應當只負責執行單一任務

3.7. 參數過多

  • 3.7.1. 方法參數數目超過3個

3.8. 過度耦合的消息鏈

  • 3.8.1. 當一個方法調用一個對象,繼而調用另一個對象

  • 3.8.2. 消息鏈違反了迪米特法則

  • 3.8.2.1. 類只應當和離其最近的鄰居通信

  • 3.8.2.2. 重構類,將所需的狀態和行為放在距離其更近的位置

3.9. 過高的圈複雜度

3.10. 人為複雜性

3.11. 依戀情結

3.12. 狎昵關係

3.13. 冗贅方法

3.14. 中間人方法

3.15. 怪異的解決方案

3.16. 誇誇其談未來性

3.17. 參見前文


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Mybatis高級特性能夠幫助我們更加靈活地操作資料庫,包括動態SQL、緩存機制、插件機制、自定義類型轉換等。學習這些特性可以讓我們更好地利用Mybatis,提高數據操作的效率和質量。 未來的道路由自己抉擇,事業的高度由自己決定。 動態SQL 動態SQL中,Mybatis提供了多種標簽來幫助我們構建 ...
  • 一、問題引入 在學習棧的過程中,教材有一個案例:利用棧結果解析括弧的匹配問題。括弧問題:[({}{})],說明 [] 、() 、{} 稱為一對。 號碼位置對應的括弧之間進行匹配,結果:0-7、 1-6、 2-3、 4-5 二、過程記錄 💡 基於順序棧實現 利用棧的特性:先進後出 ,對括弧進行匹配輸 ...
  • 本系列將和大家分享Redis分散式緩存,本章主要簡單介紹下Redis中的布隆過濾器(Bloom Filter),以及如何破解ServiceStack和如何解決緩存雪崩、緩存穿透、緩存擊穿、緩存預熱問題。 ...
  • 一、Show與ShowDialog眾所周知在c#中有兩種顯示視窗的方式:模態顯示(showdialog)與非模態顯示(show),模態顯示會阻塞調用視窗的所有消息響應,在調用ShowDialog方法後,直到關閉對話框後,才執行此方法後面的代碼 ,期間用戶是無法對該視窗外的界面進行ui交互的;非模態顯 ...
  • 背景: 如何在ASP.Net Core的生產環境中保護swagger ui,也就是index.html頁面。其實swagger是自帶禁用的功能的,只需要設置開關即可。但是有一些場景,是需要把這些介面進行開放或者導出成文檔供第三方進行調用,這個時候卻又不想讓所有人訪問。本文介紹一種許可權控制訪問的方式, ...
  • 一:背景 1. 講故事 最近收到了兩起程式崩潰的dump,查了下都是經典的 double free 造成的,蠻有意思,這裡就抽一篇出來分享一下經驗供後面的學習者避坑吧。 二:WinDbg 分析 1. 崩潰點在哪裡 windbg 帶了一個自動化分析命令 !analyze -v 可以幫助我們找到崩潰時的 ...
  • .net core 自定義授權策略提供程式進行許可權驗證 在這之前先瞭解一下鑒權和授權的概念; 鑒權 鑒權可以說是身份驗證,身份驗證是確定用戶身份的過程; 在ASP.NET Core 中身份驗證是由身份驗證服務IAuthenticationService負責的,它被身份驗證中間件使用, 身份驗證服務會 ...
  • 上一篇 ASP.NET Core - 選項系統之選項配置 中提到 IOptions、IOptionsMonitor 和 IOptionsSnapshot 三個介面,通過這三個介面都可以從依賴註入容器中解析出已經配置的選項類,在我們通過 Configure 方法配置選項時,這三個介面會被同時註冊,但三 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...