STM32库中的Assert断言有必要使用吗？

1 @: `  c: j4 }; r: j% z" C8 C! P2 a
  F  |4 k, H1 b0 T

很多小伙伴都不清楚什么是Assert，今天就再来分享一下关于Assert的内容。

1、写在前面

有经验的工程师都知道，随着软件版本的迭代，或者需求不断变更，我们的代码就会变得越来越“臃肿”。

在编码的过程中，如果没有注重一些细节，你的代码就可能存在许多隐藏的Bug。

那么，我们如何找出这些隐藏的Bug呢？

今天就说其中的一点：Assert断言。

2 n0 o( ^% X0 A  i+ u0 u) g% x3 _
# w( o( L9 q6 H  T

2、关于Assert断言

什么是Assert断言？

( P& ~5 Z) k) m2 _; r+ o2 e

编写代码时，我们总是会做出一些假设，断言就是用于在代码中捕捉这些假设，可以将断言看作是异常处理的一种高级形式。

断言表示为一些布尔表达式，程序员相信在程序中的某个特定点该表达式值为真。

可以在任何时候启用和禁用断言验证，因此可以在测试时启用断言，而在部署时禁用断言。

同样，程序投入运行后，最终用户在遇到问题时可以重新启用断言。

---来自百度百科

  @0 }  g1 e, b8 z8 A0 a2 Z

这里的概念，可能不好理解，简单举一个例子来说明吧。

有这么一个数组和函数：

1. int Array[5] = {0xA1, 0xB2, 0xC3, 0xD4, 0xE5};
   
2. 
   ! \& B) l) Y& u( P
3. int Fun(char i)
   6 ]1 w: U  m# Q7 d
4. 
   ' |7 o+ V1 J8 E# Z9 L' }5 S
5. {
   : P, W& |8 C9 y$ I8 F% H
6. 
   # C( V9 S" w5 l* h; M% [3 W
7.     return Array[i];
   . C( U; {, F9 ^2 H
8. 
   " |( _) S6 m! y' Q- r  O: b3 `
9. }

复制代码

8 _" |/ C1 T/ b2 O

如果我们函数中不加Assert断言语句，你觉得直接调用会这个函数会有风险吗？

假如这么调用：

1. int a;
   0 ~! L: J8 `3 g. p' m1 B
2. 
   
3. a = Fun(8);

复制代码

很明显，就这么调用，会出错，且我们不容易发现错误在哪里。

但是，假如添加有Assert断言语句，错误就能一下找出来。

, |: G( u1 z$ U' k

3、Assert断言实际应用

其实，Assert断言在很多标准的代码中，基本都有。我们还是拿STM32的代码来说明吧。

不管是STM32标准外设库、还是HAL、LL库源代码里面都有Assert断言机制。

不知道大家有没有注意过assert_param函数？

1.拿STM32最常见的GPIO初始化函数为例

A.标准外设库GPIO初始化：

B.HAL库GPIO初始化：

相信大家都看到过STM32库中的参数断言语句，他的作用就是用于检查函数传入参数是否正确。

2.STM32参数断言使能

STM32的assert_param参数断言函数是没有使能的，如下：

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

也就是assert_param不起作用。

如果需要使用，就需要对其使能才行。

# r  X' K( F6 T' i/ f

A.标准外设库

. k9 f0 N6 |! }. ?2 m. ^* |- t

B.HAL库

道理一样，使能ASSERT，可以手动：

#define USE_FULL_ASSERT    1U

也可以通过STM32CubeMX配置：

" k- F5 L& \) z! V  D( U

  v- _1 }% I. Z* W* x" G

2 L/ S& R7 x4 q" K

3.代码大小

添加Assert断言之后，代码量肯定要增加，比如：

不使能assert_param代码量：

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

使能assert_param：

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

4.断言失败处理

断言失败，可根据实际项目需求，做出一定处理。比如：打印错误信息，存储错误日志等。

7 \  a& \" L9 G- W& |

本文就讲到这里，方法教给大家，需要自己理解并消化其中内容。

-END-

# k, p: ^* d6 C5 A$ Q

文章出处： strongerHuang