1 引言

軟件應(yīng)用在發(fā)展到適當(dāng)時(shí)機(jī)，” 重構(gòu)”，是開發(fā)過程中不可避免需要進(jìn)行的一項(xiàng)工作。重構(gòu)代碼，以適配當(dāng)前模塊設(shè)計(jì)之初未考慮到的多樣化場(chǎng)景，并增加模塊的可維護(hù)性、健壯性、可測(cè)試性。那么，如何明確重構(gòu)的方向，以及量化重構(gòu)的結(jié)果呢？代碼圈復(fù)雜度可以是一個(gè)供選擇的指標(biāo)。下文介紹如何獲取應(yīng)用的代碼圈復(fù)雜度做到線上監(jiān)控，給到復(fù)盤程序復(fù)雜程度的數(shù)據(jù)支撐。

2 背景知識(shí)

2.1 圈復(fù)雜度

圈復(fù)雜度（Cyclomatic complexity，簡(jiǎn)寫 CC）也稱為條件復(fù)雜度，是一種代碼復(fù)雜度的衡量標(biāo)準(zhǔn)。由托馬斯?J?麥凱布（Thomas J. McCabe, Sr.）于 1976 年提出，用來表示程序的復(fù)雜度，其符號(hào)為 VG 或是 M。它可以用來衡量一個(gè)模塊判定結(jié)構(gòu)的復(fù)雜程度，數(shù)量上表現(xiàn)為獨(dú)立現(xiàn)行路徑條數(shù)，也可理解為覆蓋所有的可能情況最少使用的測(cè)試用例數(shù)。圈復(fù)雜度大說明程序代碼的判斷邏輯復(fù)雜，可能質(zhì)量低且難于測(cè)試和維護(hù)。程序的可能錯(cuò)誤和高的圈復(fù)雜度有著很大關(guān)系。

2.2 圈復(fù)雜度計(jì)算方式

常用結(jié)構(gòu)圈復(fù)雜度計(jì)算

順序結(jié)構(gòu)：順序結(jié)構(gòu)復(fù)雜度為 1。

if-else-else、switch-case：每增加一個(gè)分支，復(fù)雜度增加 1，&& 、|| 運(yùn)算也為一個(gè)分支。

循環(huán)結(jié)構(gòu)：增加一個(gè)循環(huán)結(jié)構(gòu)，復(fù)雜度增加 1。

return：增加一條 return 語(yǔ)句，復(fù)雜度將加 1。

2.3 圈復(fù)雜度度量標(biāo)準(zhǔn)

如上列出行業(yè)內(nèi)相對(duì)認(rèn)可的度量數(shù)據(jù)，實(shí)際這個(gè)完全是看自己的業(yè)務(wù)體量和項(xiàng)目情況來決定的。假設(shè)你的業(yè)務(wù)很簡(jiǎn)單，而且是個(gè)單體應(yīng)用，功能都是很簡(jiǎn)單的 CRUD，那你的圈復(fù)雜度即使想上去也沒有那么容易。此時(shí)你就可以選擇把圈復(fù)雜度的重構(gòu)閾值設(shè)定為 10. 假設(shè)你的業(yè)務(wù)十分復(fù)雜，而且涉及到多個(gè)其他的微服務(wù)系統(tǒng)調(diào)用，再加上各種業(yè)務(wù)中的 corner case 的判斷，圈復(fù)雜度上 100 可能都不在話下。

2.4 降低圈復(fù)雜度方法

1）函數(shù)提煉與拆分，單一職責(zé)

拆分成子函數(shù)

每個(gè)函數(shù)要有明確的功能實(shí)現(xiàn)，不要為了追求行數(shù)少而合并功能實(shí)現(xiàn)

邏輯模塊和數(shù)據(jù)模塊要區(qū)分開編寫

2）優(yōu)化算法

減少不必要條件、循環(huán)分支，盡量少用 if …else … ，采用三元表達(dá)式替換 if else

3）表達(dá)式邏輯優(yōu)化

合并條件表達(dá)式，比如使用 a || b || c

4）減少提前 return

3 方案概述

3.1 腳本設(shè)計(jì)

1）開發(fā)語(yǔ)言

python

2）依賴環(huán)境

lizard

APScheduler

smtplib

pymysql

3）腳本架構(gòu)

3.2 功能介紹

1）支持檢索語(yǔ)言范圍： 支持 15 種開發(fā)語(yǔ)言，包含常用語(yǔ)言如下

C/C++ (works with C++14)

Java

C# (C Sharp)

JavaScript (With ES6 and JSX)

Python

Golang

2）掃描參數(shù)配置說明：
利用 lizard 執(zhí)行掃描，常用命令如下： 配置檢查范圍：

列出要分析的編程語(yǔ)言。如果留空，將搜索支持的所有語(yǔ)言。

-l LANGUAGES,--languages LANGUAGES

排除與模式匹配的文件。匹配一切？匹配任何單個(gè)字符，“/folder/” 遞歸地排除文件夾中的所有內(nèi)容?？梢灾付ǘ鄠€(gè)模式。不要忘了在模式周圍加 “” 號(hào)。

-x EXCLUDE,--exclude EXCLUDE

設(shè)置白名單，默認(rèn)’./whitelizard.txt’

-W WHITELIST,--whitelist WHITELIST

配置閥值警告：

圈復(fù)雜度數(shù)警告的閾值，默認(rèn)值為 15，>15 會(huì)產(chǎn)生警告。

-C CCN,--CCN CCN

設(shè)置字段的限制數(shù)。可以代碼行數(shù)，圈復(fù)雜度，令牌數(shù)，參數(shù)數(shù)或自定義字段。如果函數(shù)設(shè)置超過了限制數(shù)會(huì)報(bào)警。

-T THRESHOLDS,--ThresholdTHRESHOLDS

配置報(bào)告輸出：

根據(jù)格式輸出到文件

-o OUTPUT_FILE,--output_file OUTPUT_FILE

官網(wǎng)地址：http://www.lizard.ws
源碼地址：https://github.com/terryyin/lizard 3）定時(shí)執(zhí)行掃描任務(wù)：

通過 BackgroundScheduler 創(chuàng)建調(diào)度任務(wù)，自動(dòng)觸發(fā)掃描方法，結(jié)果寫庫(kù)

defdojob():

scheduler=BackgroundScheduler()

scheduler.add_job(func,"cron",hour=21,minute=30)

scheduler.start()

3.3 結(jié)果展示

3.3.1 報(bào)告名詞解釋

Cyclomatic complexity，圈復(fù)雜度也就是分支復(fù)雜度，最好保持在 15 以下，目前腳本設(shè)置閥值 10。

LOC，包含注釋的代碼行數(shù)，目前設(shè)置 200 閥值。

Token count ，token 的個(gè)數(shù)，一個(gè)程序最多可以有 8192 個(gè)令牌， 每個(gè)令牌都是一個(gè)詞，例如關(guān)鍵字，標(biāo)識(shí)符，常量，標(biāo)點(diǎn)符號(hào)，操作符。對(duì)括號(hào)和字符串計(jì)數(shù)作為 1 個(gè)令牌。逗號(hào)、句點(diǎn)、LOCAL、分號(hào)、END 和注釋不計(jì)算在內(nèi)。

Parameter count，參數(shù)統(tǒng)計(jì)就是函數(shù)的參數(shù)個(gè)數(shù)，目前腳本設(shè)置閥值 10。

3.3.2 執(zhí)行結(jié)果展示

Windows 環(huán)境運(yùn)行腳本，輸入 file_root（文件地址）執(zhí)行掃描，支持自動(dòng)彈出瀏覽器展示本次運(yùn)行的 Html 報(bào)告

每周定期執(zhí)行，按照系統(tǒng)維度掃描，支持觸發(fā)郵件通知對(duì)應(yīng)系統(tǒng)研發(fā)查看超過閥值方法名稱

3.3.3 應(yīng)用數(shù)據(jù)監(jiān)控

每周定期拉取指定分支最新代碼，執(zhí)行文件分析，存儲(chǔ)掃描結(jié)果，通過數(shù)據(jù)圖表展示

4 總結(jié)

對(duì)于軟件代碼好壞的衡量，圈復(fù)雜度可以作為一個(gè)參考指標(biāo)，研發(fā)可以通過提煉拆分函數(shù)、優(yōu)化算法、優(yōu)化邏輯表達(dá)式等方法降低模塊（函數(shù)）圈復(fù)雜度。以上闡述圈復(fù)雜度一種線上監(jiān)控方法，利用好線上化數(shù)據(jù)，結(jié)合現(xiàn)有團(tuán)隊(duì)項(xiàng)目情況，才能形成更好的實(shí)踐機(jī)制。