如何有效的解決代碼的圈復(fù)雜度
作者:京東零售 張學(xué)剛
背景介紹
不管小型公司還是大型互聯(lián)網(wǎng)公司,很多項(xiàng)目債臺(tái)高筑,新功能開發(fā)困難。其中一個(gè)很大的原因就是代碼復(fù)雜,可讀性差。Sonar開發(fā)團(tuán)隊(duì)曾上綱上線的戲稱開發(fā)人員的7宗罪,其中很關(guān)鍵的一條就是“復(fù)雜度”。那復(fù)雜度有沒有一個(gè)明確的衡量標(biāo)準(zhǔn),我們又如何去解決代碼的圈復(fù)雜度呢?今天我在這里和大家聊一下。
圈復(fù)雜度的計(jì)算方法
我們先來看一下圈復(fù)雜度與代碼質(zhì)量以及測試和維護(hù)成本之間的一個(gè)關(guān)系。
我們可以看到當(dāng)圈復(fù)雜度,在1-10之間的時(shí)候,代碼是清晰,結(jié)構(gòu)化的??蓽y試性比較高,維護(hù)成本也比較低。隨著圈復(fù)雜度的升高,代碼的狀況開始惡化,當(dāng)大于30的時(shí)候,代碼已經(jīng)逐步變?yōu)椴豢勺x,維護(hù)成本非常高。
點(diǎn)邊計(jì)算法
那圈復(fù)雜度是如何計(jì)算的呢,常用的第一種方法叫做點(diǎn)邊計(jì)算法,它圈復(fù)雜度的計(jì)算方式 V(G) = E ? N + 2,我們用下邊圖來解釋一下這個(gè)公式:
其中公式之中的E指的是控制流圖中邊的數(shù)量,N指的是控制流圖中的節(jié)點(diǎn)數(shù)量。這兩個(gè)圖形指的就是控制流圖。那我們可以計(jì)算一下,第一個(gè)控制流圖的圈復(fù)雜度是:4-4+2=2.
節(jié)點(diǎn)判定法
除此之外圈復(fù)雜度還有一種更為直觀的計(jì)算方法,因?yàn)槿?fù)雜度實(shí)際上體現(xiàn)了“判定條件”的數(shù)量,所以圈復(fù)雜度實(shí)際上就是等于判定節(jié)點(diǎn)的數(shù)量再加上1。它的計(jì)算公式為:V (G) = P + 1 其中判定節(jié)點(diǎn)(P)指的是我們常用的分支語句。例如if語句、while語句、case語句等。
那如何來降低圈復(fù)雜度呢?
圈復(fù)雜度的常用解決方法
提煉函數(shù)
接下來我們重點(diǎn)介紹一些降低圈復(fù)雜的方法,我通過工作中常見的代碼,來表述一下,如何去降低復(fù)雜度,如果你有更好的方法,也歡迎留言跟我交流。在我們的工作中,做業(yè)務(wù)系統(tǒng)的時(shí)候,通過異步消息進(jìn)行數(shù)據(jù)傳遞,是比較常用的一種方式,在我們監(jiān)聽到對端系統(tǒng)的消息的時(shí)候,一般會(huì)做這幾件事情。判斷消息是否為空-->轉(zhuǎn)換消息為數(shù)據(jù)傳輸對象DTO-->進(jìn)一步的判斷對象的數(shù)據(jù)是否合法-->進(jìn)行業(yè)務(wù)邏輯的處理。這幾個(gè)典型的步驟,很多童鞋可能用左邊圖的方式進(jìn)行處理。這個(gè)時(shí)候,如果每一個(gè)步驟的方法比較復(fù)雜的時(shí)候,這個(gè)總的方法會(huì)非常復(fù)雜,這個(gè)時(shí)候,我們可以通過提煉方法的方式,對高內(nèi)聚的操作,提煉到一個(gè)獨(dú)立的方法中,來分治復(fù)雜性。??
使用衛(wèi)語句
我們知道圈復(fù)雜度的一個(gè)因素就是分支語句多,我們在寫業(yè)務(wù)代碼的時(shí)候,常見到這樣的一種代碼,if-then-else的層層嵌套。衛(wèi)語句的原則是,如果某個(gè)條件極其罕見,就應(yīng)該單獨(dú)檢查該條件,并在該條件為真時(shí),立刻返回。下面是一個(gè)生產(chǎn)中的場景,如果記賬請求落庫成功后就進(jìn)行余額的操作,如果不成功就返回失敗結(jié)果。因?yàn)槁鋷焓∈遣怀R姷?,所以我們采用衛(wèi)語句的方式,來減少分支語句。讓代碼更清晰。
合并條件
經(jīng)常遇到一種情況,我們對錯(cuò)誤的處理,需要返回給調(diào)用方,內(nèi)部的錯(cuò)誤碼,為了方便快讀的定位錯(cuò)誤會(huì)非常詳細(xì),但是對外可能會(huì)泛化這種錯(cuò)誤碼,這個(gè)時(shí)候我們可以通過合并條件的方式,簡化條件分支,來降低圈復(fù)雜度。下面是一個(gè)生產(chǎn)中的場景,如果記賬失敗,則對錯(cuò)誤結(jié)果進(jìn)行包裝處理,并返回給調(diào)用方。這個(gè)時(shí)候我們可以將錯(cuò)誤碼合并,這里它是合并到map中,然后針對這組錯(cuò)誤碼統(tǒng)一進(jìn)行了處理。??
通過多態(tài)方式替代條件式
在我們開發(fā)中,如果是一個(gè)平臺(tái)化的系統(tǒng),很多時(shí)候,有這樣的需求。例如:不同的租戶、不同的業(yè)務(wù)甚至不同的訂單類型都會(huì)有不同的處理流程。 這個(gè)時(shí)候最簡單的方式,就是通過條件分支來進(jìn)行不同的處理。但是當(dāng)業(yè)務(wù)繁多的時(shí)候,處理分支會(huì)顯得混亂,從而導(dǎo)致圈復(fù)雜度的升高,這個(gè)時(shí)候我們通過利用多態(tài)的方式,可以有效的降低復(fù)雜度。我們看一下下邊這段代碼,不同的訂單類型,使用不同的處理流程,這里他使用了在枚舉中實(shí)現(xiàn)多態(tài)的方式。我們發(fā)現(xiàn),其實(shí)他是實(shí)現(xiàn)了工廠模式。
替換算法
復(fù)雜算法會(huì)導(dǎo)致bug可能性的增加及可理解性/可維護(hù)性的降低,如果函數(shù)對性能要求不高,提倡使用簡單明了的算法。這里我引用了重構(gòu)中的一個(gè)例子,我們可以一起看一下。這里傳入一個(gè)人名的數(shù)組,如果數(shù)組中包含指定的名稱,就立即返回名稱。??
分解條件式
在面對大塊頭的代碼時(shí),你可以通過提煉方法的方式,將它分解為多個(gè)方法。根據(jù)每個(gè)小塊代碼的用途,命名新的方法名。對于條件邏輯,將每個(gè)分支條件分解成新方法可以突出條件邏輯,并更清楚的表達(dá)每個(gè)分支的作用。比如下面的例子中,夏季的時(shí)候商品的折扣和非夏天的商品折扣,是不同的計(jì)算方法。 這個(gè)時(shí)候,我們可以把兩種算法,提煉到兩個(gè)不同的方法中.??
移除控制標(biāo)記
有時(shí)候我們會(huì)通過控制標(biāo)記來對循環(huán)進(jìn)行處理,我們看一下這樣的一段經(jīng)常使用的代碼,同一個(gè)數(shù)組列表中查找罪惡的人,匹配到任意一個(gè)罪惡的人后返回。這里found是控制標(biāo)記,我們可通過下邊的方式去掉控制標(biāo)記,來減少一層循環(huán),達(dá)到削減復(fù)雜度的效果。
圈復(fù)雜度的思辨
那是不是當(dāng)我們檢測到圈復(fù)雜度高的時(shí)候他就一定復(fù)雜呢,下面的代碼是一個(gè)生產(chǎn)上的例子,他通過傳入的MQ的名字,對MQ進(jìn)行手動(dòng)的暫停。這個(gè)地方實(shí)際上是可以通過mq的名稱,從spring的容器中,獲取bean的。這里的例子主要是讓大家看到,雖然,這個(gè)分支比較多,但是這種扁平化的結(jié)構(gòu)可讀性還是可以的。不過如果它做的不僅僅是一個(gè)暫停的操作,而是一個(gè)很復(fù)雜的操作,這個(gè)時(shí)候,可能就需要通過提煉方法的方式進(jìn)行重構(gòu)。如果提煉方法重構(gòu)后,這個(gè)類還是過長,那就需要我們通過使用多態(tài)的特性,利用工廠模式等方式進(jìn)行進(jìn)一步的重構(gòu)。如果一開始我們就通過應(yīng)用一些復(fù)雜的設(shè)計(jì)模式進(jìn)行重構(gòu),就會(huì)存在過度設(shè)計(jì)的弊端,使代碼更不易于理解.??
總結(jié)
首先介紹了什么是圈復(fù)雜度,然后介紹了解決圈復(fù)雜度的幾種方法。
通過圈復(fù)雜度計(jì)算的兩種方式我們可以看到,圈復(fù)雜度的核心是分支語句。那解決問題的核心就集中在如何去減少分支語句。
不過最后我們也看到了,實(shí)際上,只是刻板的使用圈復(fù)雜度的算法,去度量一個(gè)段代碼的清晰度,有時(shí)候也是不可取的,所以我們在重構(gòu)系統(tǒng)的時(shí)候,可以通過圈復(fù)雜度的工具,進(jìn)行復(fù)雜度的統(tǒng)計(jì),然后對復(fù)雜度高的代碼,具體場景,具體分析。而不能一味的教條。
最后我們通過思維導(dǎo)圖來梳理一下:??