c++ assert() 使用方法

標籤：main   lib   cpp   hid   __file__   同名   ogr   告訴   process   

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不能代替條件過濾

文章出處：http://www.diybl.com/course/3_program/c++/cppjs/20071111/85534.html

摘自《高品質C/C++編程指南》Page 41-42...

程式一般分為Debug 版本和Release 版本，Debug 版本用於內部調試，Release 版本發行給使用者使用。
斷言assert 是僅在Debug 版本起作用的宏，它用於檢查“不應該”發生的情況。樣本6-5 是一個記憶體複製函數。在運行過程中，如果assert 的參數為假，那麼程式就會中止（一般地還會出現提示對話，說明在什麼地方引發了assert）。

void *memcpy(void *pvTo, const void *pvFrom, size_t size)
{
    assert((pvTo != NULL) && (pvFrom != NULL)); // 使用斷言
    byte *pbTo = (byte *) pvTo; // 防止改變pvTo 的地址
    byte *pbFrom = (byte *) pvFrom; // 防止改變pvFrom 的地址
    while(size -- > 0)
        *pbTo ++ = *pbFrom ++ ;
    return pvTo;
}
樣本6-5 複製不重疊的記憶體塊

assert 不是一個倉促拼湊起來的宏。為了不在程式的Debug 版本和Release 版本引起差別，assert 不應該產生任何副作用。所以assert 不是函數，而是宏。程式員可以把assert看成一個在任何系統狀態下都可以安全使用的無害測試手段。如果程式在 assert 處終止了，並不是說含有該assert 的函數有錯誤，而是調用者出了差錯，assert 可以協助我們找到發生錯誤的原因。

很少有比跟蹤到程式的斷言，卻不知道該斷言的作用更讓人沮喪的事了。你化了很多時間，不是為了排除錯誤，而只是為了弄清楚這個錯誤到底是什麼。有的時候，程式員偶爾還會設計出有錯誤的斷言。所以如果搞不清楚斷言檢查的是什麼，就很難判斷錯誤是出現在程式中，還是出現在斷言中。幸運的是這個問題很好解決，只要加上清晰的注釋即可。這本是顯而易見的事情，可是很少有程式員這樣做。這好比一個人在森林裡，看到樹上釘著一塊“危險”的大牌子。但危險到底是什嗎？樹要倒？有廢井？有野獸？除非告訴人們“危險”是什麼，否則這個警告牌難以起到積極有效作用。難以理解的斷言常常被程式員忽略，甚至被刪除。

【規則6-5-1】使用斷言捕捉不應該發生的非法情況。不要混淆非法情況與錯誤情況之間的區別，後者是必然存在的並且是一定要作出處理的。
【規則6-5-2】在函數的入口處，使用斷言檢查參數的有效性（合法性）。
【建議6-5-1】在編寫函數時，要進行反覆的考查，並且自問：“我打算做哪些假定？”一旦確定了的假定，就要使用斷言對假定進行檢查。
【建議6-5-2】一般教科書都鼓勵程式員們進行防錯設計，但要記住這種編程風格可能會隱瞞錯誤。當進行防錯設計時，如果“不可能發生”的事情的確發生了，則要使用斷言進行警示。

ASSERT宏中應該包含的元素：

判斷條件；輸出當前宣告失敗的位置（檔案、行數等）；返回錯誤；終止程式...

幾種典型的ASSERT的寫法：

VC中的寫法：

#define ASSERT(f) \
do \
{ \
   if (!(f) && AfxAssertFailedLine(THIS_FILE, __LINE__)) \
   AfxDebugBreak(); \
} while (0) \

#define _ASSERT(expr) \
        do { if (!(expr) && \
                (1 == _CrtDbgReport(_CRT_ASSERT, __FILE__, __LINE__, NULL, NULL))) \
             _CrtDbgBreak(); } while (0)

其他平台的寫法：

# define ASSERT(x) ((x) || (dbg_printf("assertion failed ("__FILE__":%d): \"%s\"\n",__LINE__,#x), break_point(), FALSE))

原網站地址:http://hi.baidu.com/uwbadnhctpkopwr/item/1d5d1e1d316c79fcdceeca0a

c++ assert() 使用方法