基于嵌入式ASIL D產(chǎn)品的開發(fā)經(jīng)驗

軟件開發(fā)始于需求卻不能終于需求，我們在滿足需求的同時，還需要考慮代碼本身的質(zhì)量，包括可讀性、可維護性、可擴展性、可移植性、安全性、高效性等。

上一篇文章《汽車軟件單元測試的要點與意義》提到了諸如靜態(tài)分析與覆蓋度測試的一些代碼評價手段，這一篇講一些具體指標(biāo)。

這些指標(biāo)主要來自于ASIL D軟件的實踐經(jīng)驗。

1

每個函數(shù)的語句數(shù)

該指標(biāo)是指函數(shù)內(nèi)部語句的個數(shù)，是一種基礎(chǔ)的代碼復(fù)雜度度量方式。在多數(shù)語言中，我們可以使用工具自動計算語句個數(shù)。

常見語句包含以下類型：

以分號（;）結(jié)尾的簡單語句

• if語句
• for語句
• while語句
• do語句
• switch語句
• break語句
• continue語句
• return語句
• goto語句

語句個數(shù)應(yīng)盡量維持在10~20，最多不要超過50。

2

return語句的數(shù)量

為了提高代碼的可讀性，我們最好遵循“單一出口原則”，也就是盡量保證一個函數(shù)只有一個出口點（函數(shù)結(jié)束執(zhí)行的地方）。

出口點通常是return語句，所以我們也建議盡量減少其數(shù)量，比如，一個函數(shù)的return維持在1~2個之內(nèi)。

3

代碼行長度

寫文章要短句，是為了便于閱讀。代碼也是一樣，太長的代碼行會明顯增加閱讀代碼的難度，很現(xiàn)實的問題是，需要開發(fā)人員左右滾動屏幕。

在保證合理的邏輯、換行和縮進的前提下，要盡可能將長代碼拆分。通常，低于160個字符的代碼行可以認為是一個合理目標(biāo)。

4

圈復(fù)雜度

圈復(fù)雜度是指通過源代碼線性獨立路徑的個數(shù)，也是用來衡量代碼復(fù)雜度。

如何計算呢？我們可以通過以下3個代碼控制流圖來看。

一種計算公式為，圈復(fù)雜度M=控制流圖邊數(shù)E-節(jié)點N+2

故，

圖1：M=1-2+2=1，即無判定節(jié)點，圈復(fù)雜度為1。

圖2：M=4-4+2=2，即一個判定節(jié)點，圈復(fù)雜度為2。

圖3：M=7-6+2=3，即兩個判定節(jié)點，圈復(fù)雜度為3。

除了評價本身代碼判定邏輯的復(fù)雜性之外，圈復(fù)雜度還能夠用來確定最少需要多少個測試用例來滿足分支和路徑的覆蓋度。

一般經(jīng)驗是，圈復(fù)雜度應(yīng)小于10，以達到較好的可測性。

5

非循環(huán)路徑數(shù)

這個指標(biāo)也被稱為NPATH，是指通過軟件所有可能路徑的數(shù)量。其中，循環(huán)中的循環(huán)（for, while, do-while）只訪問一次。

因此，NPATH也給出了達到路徑覆蓋所需的測試用例的最大數(shù)量。而圈復(fù)雜度給出了測試用例的最小數(shù)量。

如下圖，對應(yīng)的圈復(fù)雜度和NPATH分別為2和4。NPATH建議限制在80個以內(nèi)。

6

每個函數(shù)的嵌套級別

嵌套級別用來描述函數(shù)之間調(diào)用的深度層次。

當(dāng)引入控制結(jié)構(gòu)（if, while…）時，就會發(fā)生嵌套，每將控制結(jié)構(gòu)放置在其他控制結(jié)構(gòu)內(nèi)部一次，嵌套級別就會增加一次。

以下為一個嵌套級別為2的代碼段示意。

if(a < K) {

if(b > L) {

function);

}

}

嵌套級別建議不超過4。

7

調(diào)用圖遞歸

調(diào)用圖是軟件工程中用于表示函數(shù)調(diào)用關(guān)系的有向圖，它顯示了哪個函數(shù)調(diào)用了哪個函數(shù)。

調(diào)用圖內(nèi)部的遞歸是一個函數(shù)直接或間接（通過至少一個其他函數(shù)）再次調(diào)用自身的模式。

遞歸是一種很好的編程技巧，但在嵌入式中有一些缺點。

要想停止遞歸時，必須有一個結(jié)束條件，否則，遞歸將導(dǎo)致應(yīng)用程序崩潰，但是，無論是直接遞歸還是間接遞歸，確定結(jié)束條件并不容易。

此外，由于遞歸算法需要更多的函數(shù)調(diào)用和堆棧操作，其使用會造成性能阻塞、可讀性差或堆棧溢出等問題。

一般不建議使用遞歸。

8

不同函數(shù)的調(diào)用次數(shù)

更多的函數(shù)調(diào)用必然帶來更大的復(fù)雜性，整體最好不超過7次。

9

參數(shù)數(shù)量

參數(shù)的數(shù)量是函數(shù)復(fù)雜性和接口復(fù)雜性的另一個指標(biāo)。存在的參數(shù)越多，就越容易在調(diào)用函數(shù)時出錯，比如，參數(shù)順序錯誤。

如果函數(shù)參數(shù)超過了5個，可以試著把函數(shù)分成使用較少參數(shù)的邏輯部分。

10

goto語句

goto語句可以使程序直接跳轉(zhuǎn)到同一函數(shù)中的預(yù)定義位置。

goto是一個很有爭議的語句。在處理錯誤或跳出多層循環(huán)時，有很直接的效果，但非邏輯性的跳轉(zhuǎn)會讓代碼很難理解、出了錯誤也很難追蹤。

所以，通常強烈建議不要使用goto語句。

11

注釋密度

除了從語句結(jié)構(gòu)上降低外，代碼復(fù)雜度還有一種應(yīng)對方式是代碼注釋。

函數(shù)功能的文本化描述就是注釋，這顯然有助于理解代碼。特別地，代碼已經(jīng)長時間沒有被修改，或者代碼必須由原始編寫人分析或修改時，這些注釋更加有用。

一種算法是，注釋密度是指第一個語句之后找到的注釋數(shù)量與語句數(shù)量之間的比率，20%是一個可參考的下限。

審核編輯：黃飛