主頁 > .NET開發 > 讀C#代碼整潔之道筆記04_重構C#代碼識別代碼壞味道

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

2023-03-23 11:30:15 .NET開發

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. 參見前文

轉載請註明出處,本文鏈接:https://www.uj5u.com/net/547860.html

標籤:C#

上一篇:在Winform分頁控制元件中集成匯出PDF檔案的功能

下一篇:.net core 自定義例外中間件

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • WebAPI簡介

    Web體系結構: 有三個核心:資源(resource),URL(統一資源識別符號)和表示 他們的關系是這樣的:一個資源由一個URL進行標識,HTTP客戶端使用URL定位資源,表示是從資源回傳資料,媒體型別是資源回傳的資料格式。 接下來我們說下HTTP. HTTP協議的系統是一種無狀態的方式,使用請求/ ......

    uj5u.com 2020-09-09 22:07:47 more
  • asp.net core 3.1 入口:Program.cs中的Main函式

    本文分析Program.cs 中Main()函式中代碼的運行順序分析asp.net core程式的啟動,重點不是剖析原始碼,而是理清程式開始時執行的順序。到呼叫了哪些實體,哪些法方。asp.net core 3.1 的程式入口在專案Program.cs檔案里,如下。ususing System; us ......

    uj5u.com 2020-09-09 22:07:49 more
  • asp.net網站作為websocket服務端的應用該如何寫

    最近被websocket的一個問題困擾了很久,有一個需求是在web網站中搭建websocket服務。客戶端通過網頁與服務器建立連接,然后服務器根據ip給客戶端網頁發送資訊。 其實,這個需求并不難,只是剛開始對websocket的內容不太了解。上網搜索了一下,有通過asp.net core 實作的、有 ......

    uj5u.com 2020-09-09 22:08:02 more
  • ASP.NET 開源匯入匯出庫Magicodes.IE Docker中使用

    Magicodes.IE在Docker中使用 更新歷史 2019.02.13 【Nuget】版本更新到2.0.2 【匯入】修復單列匯入的Bug,單元測驗“OneColumnImporter_Test”。問題見(https://github.com/dotnetcore/Magicodes.IE/is ......

    uj5u.com 2020-09-09 22:08:05 more
  • 在webform中使用ajax

    如果你用過Asp.net webform, 說明你也算是.NET 開發的老兵了。WEBform應該是2011 2013左右,當時還用visual studio 2005、 visual studio 2008。后來基本都用的是MVC。 如果是新開發的專案,估計沒人會用webform技術。但是有些舊版 ......

    uj5u.com 2020-09-09 22:08:50 more
  • iis添加asp.net網站,訪問提示:由于擴展配置問題而無法提供您請求的

    今天在iis服務器配置asp.net網站,遇到一個問題,記錄一下: 問題:由于擴展配置問題而無法提供您請求的頁面。如果該頁面是腳本,請添加處理程式。如果應下載檔案,請添加 MIME 映射。 WindowServer2012服務器,添加角色安裝完.netframework和iis之后,運行aspx頁面 ......

    uj5u.com 2020-09-09 22:10:00 more
  • WebAPI-處理架構

    帶著問題去思考,大家好! 問題1:HTTP請求和回傳相應的HTTP回應資訊之間發生了什么? 1:首先是最底層,托管層,位于WebAPI和底層HTTP堆疊之間 2:其次是 訊息處理程式管道層,這里比如日志和快取。OWIN的參考是將訊息處理程式管道的一些功能下移到堆疊下端的OWIN中間件了。 3:控制器處理 ......

    uj5u.com 2020-09-09 22:11:13 more
  • 微信門戶開發框架-使用指導說明書

    微信門戶應用管理系統,采用基于 MVC + Bootstrap + Ajax + Enterprise Library的技術路線,界面層采用Boostrap + Metronic組合的前端框架,資料訪問層支持Oracle、SQLServer、MySQL、PostgreSQL等資料庫。框架以MVC5,... ......

    uj5u.com 2020-09-09 22:15:18 more
  • WebAPI-HTTP編程模型

    帶著問題去思考,大家好!它是什么?它包含什么?它能干什么? 訊息 HTTP編程模型的核心就是訊息抽象,表示為:HttPRequestMessage,HttpResponseMessage.用于客戶端和服務端之間交換請求和回應訊息。 HttpMethod類包含了一組靜態屬性: private stat ......

    uj5u.com 2020-09-09 22:15:23 more
  • 部署WebApi隨筆

    一、跨域 NuGet參考Microsoft.AspNet.WebApi.Cors WebApiConfig.cs中配置: // Web API 配置和服務 config.EnableCors(new EnableCorsAttribute("*", "*", "*")); 二、清除默認回傳XML格式 ......

    uj5u.com 2020-09-09 22:15:48 more
最新发布
  • C#多執行緒學習(二) 如何操縱一個執行緒

    <a href="https://www.cnblogs.com/x-zhi/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/2943582/20220801082530.png" alt="" /></...

    uj5u.com 2023-04-19 09:17:20 more
  • C#多執行緒學習(二) 如何操縱一個執行緒

    C#多執行緒學習(二) 如何操縱一個執行緒 執行緒學習第一篇:C#多執行緒學習(一) 多執行緒的相關概念 下面我們就動手來創建一個執行緒,使用Thread類創建執行緒時,只需提供執行緒入口即可。(執行緒入口使程式知道該讓這個執行緒干什么事) 在C#中,執行緒入口是通過ThreadStart代理(delegate)來提供的 ......

    uj5u.com 2023-04-19 09:16:49 more
  • 記一次 .NET某醫療器械清洗系統 卡死分析

    <a href="https://www.cnblogs.com/huangxincheng/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/214741/20200614104537.png" alt="" /&g...

    uj5u.com 2023-04-18 08:39:04 more
  • 記一次 .NET某醫療器械清洗系統 卡死分析

    一:背景 1. 講故事 前段時間協助訓練營里的一位朋友分析了一個程式卡死的問題,回過頭來看這個案例比較經典,這篇稍微整理一下供后來者少踩坑吧。 二:WinDbg 分析 1. 為什么會卡死 因為是表單程式,理所當然就是看主執行緒此時正在做什么? 可以用 ~0s ; k 看一下便知。 0:000> k # ......

    uj5u.com 2023-04-18 08:33:10 more
  • SignalR, No Connection with that ID,IIS

    <a href="https://www.cnblogs.com/smartstar/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/u36196.jpg" alt="" /></a>...

    uj5u.com 2023-03-30 17:21:52 more
  • 一次對pool的誤用導致的.net頻繁gc的診斷分析

    <a href="https://www.cnblogs.com/dotnet-diagnostic/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/3115652/20230225090434.png" alt=""...

    uj5u.com 2023-03-28 10:15:33 more
  • 一次對pool的誤用導致的.net頻繁gc的診斷分析

    <a href="https://www.cnblogs.com/dotnet-diagnostic/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/3115652/20230225090434.png" alt=""...

    uj5u.com 2023-03-28 10:13:31 more
  • C#遍歷指定檔案夾中所有檔案的3種方法

    <a href="https://www.cnblogs.com/xbhp/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/957602/20230310105611.png" alt="" /></a&...

    uj5u.com 2023-03-27 14:46:55 more
  • C#/VB.NET:如何將PDF轉為PDF/A

    <a href="https://www.cnblogs.com/Carina-baby/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/2859233/20220427162558.png" alt="" />...

    uj5u.com 2023-03-27 14:46:35 more
  • 武裝你的WEBAPI-OData聚合查詢

    <a href="https://www.cnblogs.com/podolski/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/616093/20140323000327.png" alt="" /><...

    uj5u.com 2023-03-27 14:46:16 more