C++之a(chǎn)ssert推薦用法及注意事項

更新時間：2024年07月10日 09:16:08 作者：流星雨愛編程

這篇文章主要給大家介紹了關于C++之a(chǎn)ssert推薦用法及注意事項的相關資料,assert 是一個預處理宏,用于在運行時檢查表達式是否為真,文中通過代碼介紹的非常詳細,需要的朋友可以參考下

1.引言

assert在 <assert.h> 頭文件中定義，其作用是如果它的提交呢返回錯誤，則終止執(zhí)行。

原型定義：

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

assert的作用是先計算表達式expression,如果其值為假(即為0)，那么它向stderr打印一條錯誤信息，然后通過調(diào)傭abort來終止程序運行。

通常，它用于檢查在程序執(zhí)行過程中應始終為真的條件。即當違反真理時, 觸發(fā)斷言. 比如1+1=2，當1+1≠2時觸發(fā)斷言。比如，

    assert(false); // 中斷程序；
    assert(0 && "the code is error!"); // 中斷并打印信息

2.簡單示例

#include <assert.h> // header

int divide(int numerator, int denominator) {
    assert(denominator != 0); // 確保分母不為零
    return numerator / denominator;
}

int main() {
    int result = divide(10, 2);
    // ...
    return 0;
}

在上面的示例中，assert 宏確保分母永遠不為零。如果分母為零，程序?qū)⒁灾甘疚募?、行號和失敗的表達式的錯誤消息終止。

3.推薦使用方法

經(jīng)常在C++程序中，以便于在開發(fā)過程中進行斷言檢查，而在發(fā)布版本中則禁用這些檢查。

推薦寫成如下方式，編寫一個assert_utils.h文件，內(nèi)容如下：

#pragma once

#ifndef RELEASE
#include <cassert>
#define ASSERT(f) assert(f) 
#else
#define ASSERT(f) ((void)0)
#endif

下面是對這段代碼的解釋：

1) #pragma once：這是一個預處理指令，用于確保頭文件只被包含一次。它的效果取決于編譯器，但大多數(shù)現(xiàn)代編譯器都支持它。

2) #ifndef RELEASE：這是一個預處理指令，用于檢查是否定義了RELEASE宏。如果沒有定義，編譯器將繼續(xù)執(zhí)行下面的代碼塊。

3) #include <cassert>：如果RELEASE宏沒有定義，編譯器將包含cassert頭文件，這是標準C++庫的一部分，提供了assert宏。

4) #define ASSERT(f) assert(f)：定義了一個宏ASSERT，它接受一個表達式f作為參數(shù)。當ASSERT被調(diào)用時，它將執(zhí)行assert(f)，如果f為假（即表達式結(jié)果為0），程序?qū)⒔K止運行，并顯示一個斷言失敗的消息。

5) #else：如果RELEASE宏被定義，編譯器將跳過上面的代碼塊，執(zhí)行下面的代碼。

6) #define ASSERT(f) ((void)0)：在發(fā)布版本中，ASSERT宏被定義為一個空操作，即什么都不做。這樣，在發(fā)布版本的程序中，所有ASSERT調(diào)用都不會執(zhí)行任何操作，從而避免了性能損耗和潛在的程序中斷。

7) #endif：結(jié)束#ifndef RELEASE條件編譯塊。

4.常見使用場景和注意事項

4.1.檢查參數(shù)的合法性

示例如下：

int  sendData(const char* pData, int len)
{
    //[1] 校驗參數(shù)的合法性
    assert(pData);
    assert(len > 0)

    //[2]
    //...
}

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

assert(pData && len > 0);  //這樣不好

4.2.assert不能使用改變環(huán)境的語句

因為assert只在DEBUG環(huán)境中生效，如果這么做，會導致DEBUG和RELEASE的邏輯不一致。如：

assert(i++ < 100);

在DEUG環(huán)境下，每次都會執(zhí)行i++，而在RELEASE環(huán)境中不會執(zhí)行i++，這樣就會導致兩種環(huán)境下的執(zhí)行結(jié)果不一樣，正確的寫法是：

assert(i < 100);
i++;

4.3.在未知的邏輯中添加assert(false)

如：

//根據(jù)業(yè)務類型處理業(yè)務
void  dealPro(int type)
{
    if (type == 0){
        // 文本業(yè)務
    }else if (type == 1){
        // 地圖業(yè)務
    }else if (type == 2){
        // 測試業(yè)務
    }else{
        assert(false);
    }
}

上述代碼，我們的業(yè)務邏輯只涉及到文本、地圖、測試業(yè)務，其它的都是非法業(yè)務，添加assert(false)，一旦type不等與1、2、3，就會出現(xiàn)斷言錯誤，查看程序堆棧，這樣就非?？焖俚亩ㄎ怀绦蚴悄膫€地方出現(xiàn)邏輯錯誤了，這個也是一個非常好的調(diào)試技巧。