HAL和標(biāo)準(zhǔn)庫(kù)的Assert斷言機(jī)制

偶爾會(huì)有讀者問(wèn)：改bug有什么技巧？

有經(jīng)驗(yàn)的工程師都知道，隨著軟件版本的迭代，或者需求不斷變更，我們的代碼就會(huì)變得越來(lái)越“臃腫”。

在編碼的過(guò)程中，如果沒(méi)有注重一些細(xì)節(jié)，你的代碼就可能存在許多隱藏的Bug。

那么，我們?nèi)绾握页鲞@些隱藏的Bug呢？

今天就說(shuō)其中的一點(diǎn)：Assert斷言。

關(guān)于Assert斷言

什么是Assert斷言？

編寫代碼時(shí)，我們總是會(huì)做出一些假設(shè)，斷言就是用于在代碼中捕捉這些假設(shè)，可以將斷言看作是異常處理的一種高級(jí)形式。

斷言表示為一些布爾表達(dá)式，程序員相信在程序中的某個(gè)特定點(diǎn)該表達(dá)式值為真。

可以在任何時(shí)候啟用和禁用斷言驗(yàn)證，因此可以在測(cè)試時(shí)啟用斷言，而在部署時(shí)禁用斷言。

同樣，程序投入運(yùn)行后，最終用戶在遇到問(wèn)題時(shí)可以重新啟用斷言。 ---來(lái)自百度百科

這里的概念，可能不好理解，簡(jiǎn)單舉一個(gè)例子來(lái)說(shuō)明吧。

有這么一個(gè)數(shù)組和函數(shù)：

int Array[5] = {0xA1, 0xB2, 0xC3, 0xD4, 0xE5};


int Fun(char i)
{
    return Array[i];
}

如果我們函數(shù)中不加Assert斷言語(yǔ)句，你覺(jué)得直接調(diào)用會(huì)這個(gè)函數(shù)會(huì)有風(fēng)險(xiǎn)嗎？ 假如這么調(diào)用：

int a;


a = Fun(8);

很明顯，就這么調(diào)用，會(huì)出錯(cuò)，且我們不容易發(fā)現(xiàn)錯(cuò)誤在哪里。

但是，假如添加有Assert斷言語(yǔ)句，錯(cuò)誤就能一下找出來(lái)。

Assert斷言實(shí)際應(yīng)用

其實(shí)，Assert斷言在很多標(biāo)準(zhǔn)的代碼中，基本都有。我們還是拿STM32的代碼來(lái)說(shuō)明吧。

不管是STM32標(biāo)準(zhǔn)外設(shè)庫(kù)、還是HAL、LL庫(kù)源代碼里面都有Assert斷言機(jī)制。

不知道大家有沒(méi)有注意過(guò)assert_param函數(shù)？

1.拿STM32最常見(jiàn)的GPIO初始化函數(shù)為例 A.標(biāo)準(zhǔn)外設(shè)庫(kù)GPIO初始化：



B.HAL庫(kù)GPIO初始化：

?
相信大家都看到過(guò)STM32庫(kù)中的參數(shù)斷言語(yǔ)句，他的作用就是用于檢查函數(shù)傳入?yún)?shù)是否正確。

2.STM32參數(shù)斷言使能

STM32的assert_param參數(shù)斷言函數(shù)是沒(méi)有使能的，如下：

#define assert_param(expr) ((void)0)

也就是assert_param不起作用。

如果需要使用，就需要對(duì)其使能才行。

A.標(biāo)準(zhǔn)外設(shè)庫(kù)

?

B.HAL庫(kù)

道理一樣，使能ASSERT，可以手動(dòng)：

#define USE_FULL_ASSERT    1U

也可以通過(guò)STM32CubeMX配置：

?
3.代碼大小

添加Assert斷言之后，代碼量肯定要增加，比如： 不使能assert_param代碼量：

Code=5350 RO-data=360 RW-data=16 ZI-data=1152

使能assert_param：

Code=8300 RO-data=362 RW-data=16 ZI-data=1152

4.斷言失敗處理

斷言失敗，可根據(jù)實(shí)際項(xiàng)目需求，做出一定處理。比如：打印錯(cuò)誤信息，存儲(chǔ)錯(cuò)誤日志等。 本文就講到這里，具體如何應(yīng)用實(shí)際項(xiàng)目中，還需要大家進(jìn)一步深入理解其中精髓。

審核編輯：湯梓紅