代碼質(zhì)量和產(chǎn)出是衡量一個(gè)程序員是否優(yōu)秀最直接的標(biāo)準(zhǔn)。如何提高代碼質(zhì)量和產(chǎn)出?這就要從軟件重構(gòu)和review入手。市面上有很多關(guān)于重構(gòu)和review的書籍,但是看完之后,代碼能力并不能立竿見影顯著提升,只能幫助我們解決表面的bug和規(guī)范點(diǎn),無法幫助我們發(fā)現(xiàn)更深層次的設(shè)計(jì)問題。
從設(shè)計(jì)角度來考慮review,識別代碼壞味道可以可以有效減少技術(shù)債務(wù)。技術(shù)債務(wù)是指有意或無意的做出錯(cuò)誤的或非最優(yōu)的設(shè)計(jì)決策所引發(fā)的債務(wù)。債務(wù)越積越多,最后只能重新徹底重構(gòu)項(xiàng)目才能解決問題,這也叫做技術(shù)破產(chǎn)。如何解決技術(shù)債務(wù)問題,就要從根源上明確引起技術(shù)債務(wù)的重要的原因——設(shè)計(jì)壞味和重構(gòu)認(rèn)識不足。
抽象原則:通過精簡和概括來簡化實(shí)體:精簡指的是刪除不必要的細(xì)節(jié),概括是找出并定義重要的通用特征。
非循環(huán)依賴原則:包之間的關(guān)系不可形成循環(huán)。
不自我重復(fù)原則:在詳細(xì)設(shè)計(jì)中,設(shè)計(jì)實(shí)體和代碼和重復(fù)可能表現(xiàn)為類型名重復(fù)和實(shí)現(xiàn)重復(fù)。
封裝原則:通過隱藏抽象的實(shí)現(xiàn)細(xì)節(jié)和隱藏變化等方法實(shí)現(xiàn)關(guān)注點(diǎn)分離和信息隱藏。
信息隱藏原則:找出棘手或可能變化的設(shè)計(jì)決策,并創(chuàng)建合適的模塊或類型來對其他模塊或類型隱藏這些決策。
保持簡單原則:簡潔是軟件系統(tǒng)設(shè)計(jì)的重要目標(biāo),應(yīng)避免引入不必要的復(fù)雜性。
里氏替換原則:所有的子類型都必須至少提供超類型承諾的行為且對每個(gè)超類型的引用都可替換成子類型實(shí)例。
層次接口原則:使用分類、概括、替換、排序等方法以層次方式組織對抽象。
模塊化原則:通過集中和分解等手法創(chuàng)建高內(nèi)聚、低耦合的抽象。
開閉原則:類型應(yīng)對擴(kuò)展開放,對修改關(guān)閉。具體是模塊應(yīng)該能夠在不修改代碼情況下支持新需求。
單一職責(zé)原則:絕不應(yīng)有多個(gè)導(dǎo)致類需要修改的原因,如修改一個(gè)成員可能影響類的其他不相關(guān)職責(zé),導(dǎo)致類難以維護(hù)。
變化封裝原則:倡導(dǎo)一種信息隱藏方式,建議將可能發(fā)生變化的概念封裝起來。很多設(shè)計(jì)模式都體現(xiàn)了這種設(shè)計(jì)原則,如策略模式、橋梁模式、觀察者模式。
我們從設(shè)計(jì)的角度來看代碼時(shí),要遵循六要素:
了解完設(shè)計(jì)原則和六要素后,我們再來看設(shè)計(jì)壞味。
本文中每種壞味我們只選其中一例做具體說明。
抽象原則倡導(dǎo)通過精簡和概括來簡化實(shí)體:精簡指的是刪除不必要的細(xì)節(jié),而概括指的是找出并定義通過的重要特征。交通標(biāo)志是用于交流的抽象示例,而數(shù)字符號和編程語言是用于解決問題的抽象示例。
使用一系列數(shù)據(jù)或者編碼字符串,而不創(chuàng)建類或者接口時(shí)會產(chǎn)生這種壞味
概念
應(yīng)用抽象原則的一種實(shí)現(xiàn)手法是創(chuàng)建概念邊界清晰,身份唯一的實(shí)體。由于沒有創(chuàng)建抽象來表示實(shí)體,而是使用基本數(shù)據(jù)類型或編碼字符串等原始數(shù)據(jù)來表示它,這違反了抽象原則,將這種壞味稱為缺失抽象(Missing Abstraction)。不必要的抽象也違反了模塊化原則。
潛在原因
未做重復(fù)的設(shè)計(jì)分析
未重構(gòu)
錯(cuò)誤的將重點(diǎn)放在細(xì)微的性能改善上
示例
在JDK1.0中方法printStackTrace()以字符串的方式將棧跟蹤打印到標(biāo)準(zhǔn)錯(cuò)誤流。
在需要以編程方式訪問棧跟蹤元素的客戶程序中,必須要編程代碼來獲取數(shù)據(jù),如行號等,由于客戶程度依賴這種字符串格式,JDK設(shè)計(jì)人員只能在后續(xù)版本中兼容這種格式了。
重構(gòu)建議:從Jdk1.4起對JAVA的API進(jìn)行了改進(jìn),StackTraceElement類就是原來設(shè)計(jì)中缺失的對象。
別名
基本類型偏執(zhí):使用基本類型對日期、金額進(jìn)行編碼,而不創(chuàng)建類時(shí),將引發(fā)這種壞味。
數(shù)據(jù)泥團(tuán):在很多地方同事使用一系列數(shù)據(jù)項(xiàng),而不創(chuàng)建類時(shí),將引發(fā)這種壞味。
現(xiàn)實(shí)考慮
避免過度設(shè)計(jì):有時(shí)候,實(shí)體只是數(shù)據(jù)元素,沒有任何相關(guān)聯(lián)的行為。這種情況下使用類或者接口來表示它們可能導(dǎo)致過度設(shè)計(jì)。
封裝原則倡導(dǎo)通過隱藏抽象的實(shí)現(xiàn)細(xì)節(jié)和隱藏變化等手法實(shí)現(xiàn)關(guān)注的分離和信息隱藏。比如開車必須知道發(fā)動機(jī)原理嗎?
對于抽象的一個(gè)或多個(gè)成員,聲明的訪問權(quán)限超過了實(shí)際需求時(shí),將導(dǎo)致這種壞味。例如,將字段聲明為公有的類就存在「不充分封裝」壞味。
概念
封裝的原則是將接口和實(shí)現(xiàn)分離,以便能獨(dú)立修改。這種關(guān)注點(diǎn)分離,讓客戶程序只依賴抽象的接口,而對它們隱藏具體實(shí)現(xiàn)。修改實(shí)現(xiàn)不影響客戶程序。對抽象的內(nèi)部隱藏的不充分稱為不充分的封裝(Deficient Encapsulation)。
潛在原因
為方便測試
在面向?qū)ο笾胁捎眠^程思維
快速交付
示例
來看看java.lang.System,in、out、err都被聲明成final,但可以通過java.lang.System的setIn、setOut、setErr分別賦值。任何代碼都能很方便的使用它們,比如System.out.println();
PrintStream是java 1.0就有的,只支持8位的ASCII值,Java1.1出的PrintWriter支持Unicode,然而就是因?yàn)閼?yīng)用程序都能直接使用PrintStream來訪問PrintStream的方法,根本不能摒棄PrintStream類。
重構(gòu)建議:Java 1.6引入了java.io.Console類,他提供了用于訪問基于字符的控制臺的方法。reader()、writer()來獲取Console相關(guān)的Writer和Reader對象。
別名
可隱藏的公有屬性、方法
未封裝的類
包含未參數(shù)化方法的類
現(xiàn)實(shí)考慮
嵌套或匿名類中過于寬松的訪問性
性能考慮:比如前面說的java.lang.System
模塊化原則倡導(dǎo)利用集中和分解等手法創(chuàng)建高內(nèi)聚、低耦合的抽象。
應(yīng)集中放在一個(gè)抽象中的數(shù)據(jù)和方法分散在多個(gè)抽象中時(shí),將導(dǎo)致這種壞味。表現(xiàn)為類被用作數(shù)據(jù)容器沒有任何方法、類的方法更多的被其他類的成員調(diào)用。
概念
一種重要的模塊化實(shí)現(xiàn)手法是「將相關(guān)的數(shù)據(jù)和方法集中在一起」。如果抽象中只包含數(shù)據(jù)成員,而操作這些數(shù)據(jù)成員的方法位于其他抽象中,它就違反了這種實(shí)現(xiàn)手法,存在「拆散的模塊化」壞味。稱為拆散的模塊化(Broken Modularization)。
潛在原因
以過程思維使用面向?qū)ο笳Z言
不熟悉既有設(shè)計(jì)
重構(gòu)建議
對于包含大量數(shù)據(jù)類的過程型設(shè)計(jì),可采用重構(gòu)手法“將過程型設(shè)計(jì)轉(zhuǎn)換為對象”。
別名
被動地存儲數(shù)據(jù)的類
數(shù)據(jù)類
數(shù)據(jù)記錄
記錄類
數(shù)據(jù)容器
錯(cuò)位的操作
依戀情結(jié)
錯(cuò)位的控制
現(xiàn)實(shí)考慮
自動生成的代碼
數(shù)據(jù)傳輸對象
層次型壞味
層次結(jié)構(gòu)原則倡導(dǎo)采用分類、歸并、替換和排序等手法以層次方式組織抽象。比如地球上的870萬種生物。
代碼片段使用條件邏輯來顯式管理行為變化,而原本可以創(chuàng)建一個(gè)層次目錄,并使用它來封裝這些變化,會產(chǎn)生這種壞味
概念
基于類型碼的switch語句(或串接的if-else語句)是最著名的設(shè)計(jì)壞味之一。
使用類型碼來處理行為變化表明沒有進(jìn)行有意義的分類,導(dǎo)致設(shè)計(jì)中缺少相應(yīng)的層次結(jié)構(gòu)。稱為缺失層次結(jié)構(gòu)(Missing Hierarchy)。
潛在原因
錯(cuò)誤的采用過于簡單的設(shè)計(jì)
過程型設(shè)計(jì)思維
忽視了繼承也是一種設(shè)計(jì)手法
示例
串接的if else語句顯示的檢查類型AbstractButton,JToolBar和JTextCompont并在各種條件下調(diào)用方法getMargin(),這種造成的情況是將來可能在代碼中的其他地方也會出現(xiàn)。
重構(gòu)建議
如果條件檢查中的多個(gè)實(shí)現(xiàn)調(diào)用方法相同,可引入相關(guān)的接口來抽象共同的協(xié)議。
如果代碼中包含可轉(zhuǎn)換為類的條件語句,可采用重構(gòu)手法“提取層次結(jié)構(gòu)”來創(chuàng)建一個(gè)類層次結(jié)構(gòu),其中每個(gè)類都表示條件檢查中的一種情形。
別名
標(biāo)記類
繼承缺位
緊縮的類型層次結(jié)構(gòu)
內(nèi)嵌功能
現(xiàn)實(shí)考慮
與外部交互
——————————————————分割線——————————————————
我是小微,專注微服務(wù)技術(shù)分享,致力挖掘更多“高、精、全”的微服務(wù)知識分享給大家。
我的微信:weiweiweiblack (備注:51CTO )
微信公號:黑少微服務(wù),“分享技術(shù),熱愛生活”,歡迎關(guān)注
另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)cdcxhl.cn,海內(nèi)外云服務(wù)器15元起步,三天無理由+7*72小時(shí)售后在線,公司持有idc許可證,提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國服務(wù)器、虛擬主機(jī)、免備案服務(wù)器”等云主機(jī)租用服務(wù)以及企業(yè)上云的綜合解決方案,具有“安全穩(wěn)定、簡單易用、服務(wù)可用性高、性價(jià)比高”等特點(diǎn)與優(yōu)勢,專為企業(yè)上云打造定制,能夠滿足用戶豐富、多元化的應(yīng)用場景需求。
網(wǎng)頁名稱:軟件設(shè)計(jì),那些你不知道的事-創(chuàng)新互聯(lián)
文章出自:http://muchs.cn/article40/dpidho.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供關(guān)鍵詞優(yōu)化、ChatGPT、網(wǎng)站內(nèi)鏈、軟件開發(fā)、商城網(wǎng)站、動態(tài)網(wǎng)站
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請盡快告知,我們將會在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場,如需處理請聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來源: 創(chuàng)新互聯(lián)
猜你還喜歡下面的內(nèi)容