1. 程式人生 > >assert()函式用法總結

assert()函式用法總結

assert巨集的原型定義在<assert.h>中,其作用是如果它的條件返回錯誤,則終止程式執行,原型定義:

#include <assert.h>
void assert( int expression );

 assert的作用是現計算表示式 expression ,如果其值為假(即為0),那麼它先向stderr列印一條出錯資訊,然後通過呼叫 abort 來終止程式執行。請看下面的程式清單badptr.c:

#include <stdio.h>
#include <assert.h>
#include <stdlib.h>
int main( void )
{
       FILE *fp;

       fp = fopen( "test.txt", "w" );//以可寫的方式開啟一個檔案,如果不存在就建立一個同名檔案
       assert( fp );                           //所以這裡不會出錯
       fclose( fp );

       fp = fopen( "noexitfile.txt", "r" );//以只讀的方式開啟一個檔案,如果不存在就開啟檔案失敗
       assert( fp );                           //所以這裡出錯
       fclose( fp );                           //程式永遠都執行不到這裡來
       return 0;
}

[[email protected] error_process]# gcc badptr.c 
[[email protected] error_process]# ./a.out 
a.out: badptr.c:14: main: Assertion `fp' failed.

  已放棄使用assert()的缺點是,頻繁的呼叫會極大的影響程式的效能,增加額外的開銷。在除錯結束後,可以通過在包含#include <assert.h>的語句之前插入 #define NDEBUG 來禁用assert呼叫,示例程式碼如下:

#include <stdio.h>
#define NDEBUG
#include <assert.h>

用法總結與注意事項:

  1)在函式開始處檢驗傳入引數的合法性如:

int resetBufferSize(int nNewSize)
{
  //功能:改變緩衝區大小,
  //引數:nNewSize 緩衝區新長度
  //返回值:緩衝區當前長度 
  //說明:保持原資訊內容不變     nNewSize<=0表示清除緩衝區
  assert(nNewSize >= 0);
  assert(nNewSize <= MAX_BUFFER_SIZE);
  ...
}

 2)每個assert只檢驗一個條件,因為同時檢驗多個條件時,如果斷言失敗,無法直觀的判斷是哪個條件失敗,如:

  不好:

assert(nOffset>=0 && nOffset+nSize<=m_nInfomationSize);

  好:

assert(nOffset >= 0);
assert(nOffset+nSize <= m_nInfomationSize);

  3)不能使用改變環境的語句,因為assert只在DEBUG個生效,如果這麼做,會使用程式在真正執行時遇到問題,如:

  錯誤:

assert(i++ < 100);

  這是因為如果出錯,比如在執行之前i=100,那麼這條語句就不會執行,那麼i++這條命令就沒有執行。

  正確:

assert(i < 100);
 i++;

  4)assert和後面的語句應空一行,以形成邏輯和視覺上的一致感。
 

  5)有的地方,assert不能代替條件過濾。

以下是使用斷言的幾個原則: 
   
  (1)使用斷言捕捉不應該發生的非法情況。不要混淆非法情況與錯誤情況之間的區別,後者是必然存在的並且是一定要作出處理的。 
   
  (2)使用斷言對函式的引數進行確認。 
   
  (3)在編寫函式時,要進行反覆的考查,並且自問:“我打算做哪些假定?”一旦確定了的假定,就要使用斷言對假定進行檢查。 
   
  (4)一般教科書都鼓勵程式設計師們進行防錯性的程式設計,但要記住這種程式設計風格會隱瞞錯誤。當進行防錯性程式設計時,如果“不可能發生”的事情的確發生了,則要使用斷言進行報警。 
  
  ASSERT ()是一個除錯程式時經常使用的巨集,在程式執行時它計算括號內的表示式,如果表示式為FALSE (0), 程式將報告錯誤,並終止執行。如果表示式不為0,則繼續執行後面的語句。這個巨集通常原來判斷程式中是否出現了明顯非法的資料,如果出現了終止程式以免導致嚴重後果,同時也便於查詢錯誤。  

ASSERT只有在Debug版本中才有效,如果編譯為Release版本則被忽略。  

比較好的在程式中使用assert的地方:

(1)空指標檢查。例如,針對一個函式的引數進行空指標檢查。你可以這樣使用:assert (pointer != NULL);,產生的錯誤會像這樣:Assertion ‘pointer != ((void *)0)’ failed。這樣,當出現空指標時,你的程式就會退出,並很好的給出錯誤資訊。

(2)檢查函式引數的值。例如,如果一個函式只能在它的一個引數foo為正值的時候被呼叫,你可以在函式開始時這樣寫:assert (foo > 0);,這將幫助你檢測函式的錯誤使用,這也給原始碼閱讀者很清晰的印象,那就是在這裡對函式的引數值有限制。