技巧1:記住ASSERT的定義
成都創(chuàng)新互聯(lián)是一家專注于網(wǎng)站建設(shè)、成都網(wǎng)站建設(shè)與策劃設(shè)計(jì),莘縣網(wǎng)站建設(shè)哪家好?成都創(chuàng)新互聯(lián)做網(wǎng)站,專注于網(wǎng)站建設(shè)10余年,網(wǎng)設(shè)計(jì)領(lǐng)域的專業(yè)建站公司;建站業(yè)務(wù)涵蓋:莘縣等地區(qū)。莘縣做網(wǎng)站價(jià)格咨詢:18982081108
對(duì)許多開發(fā)人員來說,斷言是一個(gè)令人困惑的話題,因?yàn)樗鼈兊脑S多使用方式與其設(shè)計(jì)初衷背道而馳。我見到的最清晰的斷言定義是這樣的:
“斷言是在程序某個(gè)特定點(diǎn)的一個(gè)布爾表達(dá)式,除非程序中有缺陷(Bug),否則它的值將為真?!?/p>
想要理解上述斷言定義的開發(fā)人員應(yīng)該留意下面三個(gè)要點(diǎn):
·斷言會(huì)評(píng)估一個(gè)表達(dá)式是真還是假
·斷言是在代碼中的某個(gè)點(diǎn)對(duì)系統(tǒng)狀態(tài)的一種假設(shè)
·斷言會(huì)驗(yàn)證系統(tǒng)假設(shè),如果不為真,就表明代碼中有一個(gè)缺陷
技巧2:使用ASSERT驗(yàn)證函數(shù)的先決條件
斷言非常適合契約式設(shè)計(jì)環(huán)境,在這種環(huán)境中,開發(fā)人員非常清晰地定義了某個(gè)函數(shù)的先決條件。斷言可以用來檢查該函數(shù)的輸入是否滿足先決條件。就拿圖1所示的代碼片段為例:
圖1:函數(shù)的先決條件
函數(shù)的STate輸入應(yīng)該在定義的系統(tǒng)狀態(tài)范圍內(nèi)。如果State不是有效的狀態(tài)值,那么它就不是錯(cuò)誤,而是缺陷!斷言可以用來驗(yàn)證State是有效的假設(shè),如圖2所示:
圖2:對(duì)函數(shù)先決條件應(yīng)用斷言
在State不小于最大值的事件中,斷言表達(dá)式將被評(píng)估為假,程序于是將停止執(zhí)行。停止程序執(zhí)行可以讓開發(fā)人員很容易馬上看到哪里的代碼出錯(cuò),而不是過段時(shí)間以后才知道。
技巧3:使用ASSERT驗(yàn)證函數(shù)的后置條件
斷言也能用來驗(yàn)證契約式設(shè)計(jì)環(huán)境中對(duì)某個(gè)函數(shù)輸出的假設(shè)。例如,如果前面定義的System_StateSet函數(shù)返回SystemState變量,開發(fā)人員可以預(yù)計(jì)它也在期望的范圍之內(nèi)。斷言可以用來對(duì)缺陷進(jìn)行監(jiān)視,如圖3所示。
圖3:對(duì)函數(shù)后置條件應(yīng)用斷言
開發(fā)人員在查看上述代碼后可能會(huì)感到這些檢查毫無意義。剛剛才設(shè)置好的SystemState怎么就會(huì)出現(xiàn)大于SYSTEM_STATE_MAX的值呢?答案是這確實(shí)不應(yīng)該出現(xiàn),然而有時(shí)候會(huì)莫名其妙地發(fā)生改變,也許是通過中斷或并行線程,此時(shí)斷言可以立即標(biāo)志出這個(gè)缺陷。
技巧4:不要把ASSERT用于錯(cuò)誤處理
在記住斷言定義之后,開發(fā)人員應(yīng)該切記:斷言是用于檢測(cè)缺陷的,不能用于錯(cuò)誤處理。錯(cuò)誤處理是設(shè)計(jì)用于響應(yīng)錯(cuò)誤的用戶輸入和意外的事件順序的軟件。錯(cuò)誤在系統(tǒng)中預(yù)料是會(huì)發(fā)生的,但僅僅是因?yàn)橛袩o效的輸入而并不意味著代碼中有缺陷。錯(cuò)誤處理應(yīng)該與缺陷尋找分開來。錯(cuò)誤使用斷言的一個(gè)典型例子是,在試圖打開一個(gè)文件用于讀取時(shí)去檢查文件的指針,如圖4所示。
圖4:ASSERT的不當(dāng)使用
讀者可以清楚地看到,試圖打開文件的結(jié)果與文件系統(tǒng)的狀態(tài)和用戶數(shù)據(jù)有關(guān),而與代碼中的缺陷一點(diǎn)關(guān)系也沒有。開發(fā)人員應(yīng)該編寫錯(cuò)誤處理程序,而不是用斷言,以便在文件不存在時(shí),錯(cuò)誤處理程序可以用一些默認(rèn)可用數(shù)據(jù)來創(chuàng)建它,以便后續(xù)代碼繼續(xù)操作。
技巧5:ASSERT僅對(duì)開發(fā)有意義,不能用于生產(chǎn)
開發(fā)ASSERT宏的原始意圖是在開發(fā)過程中啟用它,在后面生產(chǎn)時(shí)要禁用。可以用NDEBUG宏激活和禁用ASSERT。正確實(shí)施的斷言在被禁用后應(yīng)該對(duì)嵌入式系統(tǒng)基本沒有影響。
問題是,如果測(cè)試是在斷言啟用的情況下進(jìn)行的(為了捕捉任何缺陷,應(yīng)該這樣做),那么現(xiàn)在禁用斷言將導(dǎo)致交付的產(chǎn)品與測(cè)試的產(chǎn)品處于不同的狀態(tài)。斷言確實(shí)會(huì)占用一些代碼空間,但更重要的是,它們需要占用少量的時(shí)鐘周期來評(píng)估它們的布爾表達(dá)式。禁用ASSERT可能對(duì)具有有限資源的裸機(jī)系統(tǒng)的執(zhí)行時(shí)序產(chǎn)生很大影響,從而導(dǎo)致在生產(chǎn)系統(tǒng)中產(chǎn)生新的缺陷。開發(fā)團(tuán)隊(duì)需要判斷是否值得冒關(guān)閉斷言的.風(fēng)險(xiǎn)。
一種替代方案是保留斷言在激活狀態(tài),而將它們的輸出重定向到一個(gè)系統(tǒng)日志。這樣可以確保任何揮之不去的缺陷很容易被識(shí)別,而且能避免中止系統(tǒng)的運(yùn)行,而中止系統(tǒng)可不是明智之舉。
技巧6:不允許斷言有副作用
ASSERT的默認(rèn)實(shí)現(xiàn)允許開發(fā)人員包含一段可執(zhí)行代碼作為布爾表達(dá)式的一部分。舉例來說,一個(gè)狀態(tài)變量可以被實(shí)現(xiàn)為表達(dá)式的一部分并傳遞給ASSERT。但如果傳遞給ASSERT的表達(dá)式有副作用,也就是說,它會(huì)改變嵌入式系統(tǒng)的狀態(tài),那么禁用斷言將改變系統(tǒng)的行為。開發(fā)人員應(yīng)該確保他們的表達(dá)式?jīng)]有副作用,否則他們需要冒險(xiǎn)在系統(tǒng)中增加只針對(duì)產(chǎn)品代碼喚醒的休眠時(shí)間缺陷。
技巧7:斷言應(yīng)該占代碼的1%至3%
每個(gè)開發(fā)人員對(duì)于代碼庫(Code Base)中應(yīng)該有多少個(gè)斷言都有自己的主見。大家一致同意的一個(gè)數(shù)字是,代碼庫中的斷言占比應(yīng)該大于0。斷言為開發(fā)人員提供了一種在代碼庫中發(fā)生缺陷的時(shí)刻發(fā)現(xiàn)它的好方法。調(diào)試是在開發(fā)嵌入式系統(tǒng)中最浪費(fèi)時(shí)間并令人沮喪的事情之一。不管開發(fā)人員認(rèn)可的占比是1%、3%還是5%,使用斷言肯定對(duì)你有利,并會(huì)使開發(fā)嵌入式軟件變得多少有些趣味。
技巧8:將斷言用作可執(zhí)行代碼注釋
斷言可以生成極好的注釋!編寫出色的表達(dá)式可以確切地告訴開發(fā)人員在代碼的某個(gè)給定點(diǎn)應(yīng)該預(yù)料發(fā)生什么事情。開發(fā)人員應(yīng)該做好他們斷言的架構(gòu),幫助人們更清楚地理解系統(tǒng)中發(fā)生的事情,進(jìn)而幫助減少缺陷。
小結(jié)
斷言是一種出色的工具,但有太多的嵌入式軟件開發(fā)人員忽視了這一工具。本文討論的八個(gè)技巧只是如何正確使用斷言的冰山一角。接下來讀者就可以在測(cè)試平臺(tái)中建立和開始使用斷言,并研究它們?cè)趯?shí)際的嵌入式系統(tǒng)中是如何工作的。
是程序調(diào)試很重要的手段,ASSERT( f )在Debug模式下,每次運(yùn)行到這里后會(huì)計(jì)算括號(hào)中的表達(dá)式,如果表達(dá)式為0,則中斷執(zhí)行,彈出一個(gè)警告框,用戶可選擇“繼續(xù)”,“重試”,“忽略”在Release模式下,這句語句不會(huì)被編譯進(jìn)代碼。ASSERT一般用于程序內(nèi)部確認(rèn)參數(shù)的正確性,即調(diào)用內(nèi)部函數(shù)的時(shí)候,要由調(diào)用者保證參數(shù)的正確,而被調(diào)用函數(shù)內(nèi)部,就可以通過ASSERT來檢查參數(shù)是否滿足要求。
C語言是一門通用計(jì)算機(jī)編程語言,應(yīng)用廣泛。C語言的設(shè)計(jì)目標(biāo)是提供一種能以簡易的方式編譯、處理低級(jí)存儲(chǔ)器、產(chǎn)生少量的機(jī)器碼以及不需要任何運(yùn)行環(huán)境支持便能運(yùn)行的編程語言。
盡管C語言提供了許多低級(jí)處理的功能,但仍然保持著良好跨平臺(tái)的特性,以一個(gè)標(biāo)準(zhǔn)規(guī)格寫出的C語言程序可在許多電腦平臺(tái)上進(jìn)行編譯,甚至包含一些嵌入式處理器(單片機(jī)或稱MCU)以及超級(jí)電腦等作業(yè)平臺(tái)。
二十世紀(jì)八十年代,為了避免各開發(fā)廠商用的C語言語法產(chǎn)生差異,由美國國家標(biāo)準(zhǔn)局為C語言制定了一套完整的美國國家標(biāo)準(zhǔn)語法,稱為ANSI C,作為C語言最初的標(biāo)準(zhǔn)。?[1]??目前2011年12月8日,國際標(biāo)準(zhǔn)化組織(ISO)和國際電工委員會(huì)(IEC)發(fā)布的C11標(biāo)準(zhǔn)是C語言的第三個(gè)官方標(biāo)準(zhǔn),也是C語言的最新標(biāo)準(zhǔn),該標(biāo)準(zhǔn)更好的支持了漢字函數(shù)名和漢字標(biāo)識(shí)符,一定程度上實(shí)現(xiàn)了漢字編程。
assert宏的原型定義在assert.h中,其作用是如果它的條件返回錯(cuò)誤,則終止程序執(zhí)行。
庫函數(shù): assert.h
原型定義: void assert( int expression );
assert的作用是現(xiàn)計(jì)算表達(dá)式 expression ,如果其值為假(即為0),那么它先向stderr打印一條出錯(cuò)信息,然后通過調(diào)用 abort 來終止程序運(yùn)行。
例程:
#include stdio.h
#include assert.h
#include stdlib.h
int main( void )
{
FILE *fp;
fp = fopen( "test.txt", "w" );//以可寫的方式打開一個(gè)文件,如果不存在就創(chuàng)建一個(gè)同名文件
assert( fp );?????????????????????????? //所以這里不會(huì)出錯(cuò)
fclose( fp );
fp = fopen( "noexitfile.txt", "r" );//以只讀的方式打開一個(gè)文件,如果不存在就打開文件失敗
assert( fp );?????????????????????????? //所以這里出錯(cuò)
fclose( fp );?????????????????????????? //程序永遠(yuǎn)都執(zhí)行不到這里來
return 0;
}
[root@localhost error_process]# gcc badptr.c
[root@localhost error_process]# ./a.out
a.out: badptr.c:14: main: Assertion `fp'' failed.
已放棄
使用assert的缺點(diǎn)是,頻繁的調(diào)用會(huì)極大的影響程序的性能,增加額外的開銷。
在調(diào)試結(jié)束后,可以通過在包含#include assert.h的語句之前插入 #define NDEBUG 來禁用assert調(diào)用,示例代碼如下:
#include stdio.h
#define NDEBUG
#include assert.h
用法總結(jié)與注意事項(xiàng):
1)在函數(shù)開始處檢驗(yàn)傳入?yún)?shù)的合法性
如:
int resetBufferSize(int nNewSize)
{
//功能:改變緩沖區(qū)大小,
//參數(shù):nNewSize 緩沖區(qū)新長度
//返回值:緩沖區(qū)當(dāng)前長度
//說明:保持原信息內(nèi)容不變???? nNewSize=0表示清除緩沖區(qū)
assert(nNewSize = 0);
assert(nNewSize = MAX_BUFFER_SIZE);
...
}
2)每個(gè)assert只檢驗(yàn)一個(gè)條件,因?yàn)橥瑫r(shí)檢驗(yàn)多個(gè)條件時(shí),如果斷言失敗,無法直觀的判斷是哪個(gè)條件失敗
不好: assert(nOffset=0 nOffset+nSize=m_nInfomationSize);
好: assert(nOffset = 0);
assert(nOffset+nSize = m_nInfomationSize);
3)不能使用改變環(huán)境的語句,因?yàn)閍ssert只在DEBUG個(gè)生效,如果這么做,會(huì)使用程序在真正運(yùn)行時(shí)遇到問題
錯(cuò)誤: assert(i++ 100)
這是因?yàn)槿绻鲥e(cuò),比如在執(zhí)行之前i=100,那么這條語句就不會(huì)執(zhí)行,那么i++這條命令就沒有執(zhí)行。
正確: assert(i 100)
i++;
4)assert和后面的語句應(yīng)空一行,以形成邏輯和視覺上的一致感
5)有的地方,assert不能代替條件過濾