如何使用断言

[导读]建立基本断言是相对琐碎的，但是即使essert.h是C标准的一部分，它也可能会因一个开发环境而异。如果您要检查不同工具链中的断言，您会注意到断言的实现可能会大不相同。这使我们进入了使用主张的第一步，该断言是检查您的essert.h模块。例如，让我们看看Arm的Keil MDK中的sustert.h模块的样子。花一点时间检查下面的图1中的代码。

在上一篇文章中，关于断言的简介，我们讨论了如何使用断言来捕获错误，并且不应将断言用于错误处理。

请记住，断言是：

“除非程序中有一个错误，否则在程序中的特定点上的布尔表达式将是真实的。”

在今天的帖子中，我们将研究您通常如何设置并使用断言来捕获错误。

设置并使用断言

建立基本断言是相对琐碎的，但是即使essert.h是C标准的一部分，它也可能会因一个开发环境而异。如果您要检查不同工具链中的断言，您会注意到断言的实现可能会大不相同。这使我们进入了使用主张的第一步，该断言是检查您的essert.h模块。例如，让我们看看Arm的Keil MDK中的sustert.h模块的样子。花一点时间检查下面的图1中的代码。

图1：keil MDK的sustert.h头文件

所有这些代码都控制可用于主张宏的不同定义!我们应该在这里注意到几件重要的事情。

首先，我们可以控制断言宏是否没有替换，基本上是从代码库中编译的，或者我们可以定义一个版本，如果断言失败，该版本将调用函数。如果我们想禁用主张，我们需要创建符号ndebug。这通常是通过编译器设置完成的。

接下来，如果我们使用的是keil，我们还必须确保定义__do_not_link_promise_with_assert。同样，这通常是在编译器设置符号表中完成的。最后，在这一点上，我们可以提出将用于我们主张的定义：

定义断言(e)(e?(void)0：__clibns __aeabi_assert(“ e”，__file__，__line__))

与您在STM32Cubeide等海湾合作委员会工具中发现的东西相比，这一切都非常复杂。您可以看到图2中的区别。

图2：STM32Cubeide的essert.h标题定义

请注意，如果断言失败相似但截然不同，则调用的功能。这就是为什么我们需要花一些时间来回顾我们的工具链的期望。这很重要，因为我们必须定义我们的assert_failed函数，我们需要知道该称呼它，以便将其正确链接到项目。

实施主张

一旦我们找到了断言的实现，我们就需要为函数创建定义。 assert.h创建声明，但没有定义该函数的作用，就不会有任何有用。我们需要做四件事，其中包括：

· 复制声明并将声明粘贴到源模块中

· 将新声明变成函数定义

· 输出一些东西，以便开发人员知道断言失败

· 阻止程序执行

对于使用KEIL的开发人员，他们的断言失败的功能将看起来像图3中的代码。

图3：keil“ assert_failed”功能定义

您可以看到红色，我从essert.h复制并粘贴了声明，并将其变成函数定义。在蓝色中，我正在通过微控制器的UARTS打印一条消息，以通知开发人员断言失败。打印出来的典型消息是通知开发人员的声明失败和行号。这告诉开发人员的问题在哪里。

这使我们变得有趣。您可以创建非常复杂的断言，以测试单个断言中的多个条件，但是您必须做更多的工作来确定出了什么问题。通常，我的断言很简单，最多可以在一个断言中检查一个和三个条件。在大多数情况下，我将只检查一个条件，如有必要，我将使用多个断言。它节省了试图解码条件的哪一部分失败的时间和麻烦。

最后，一旦我们通知了开发人员出现问题，我们想以相同的方式停止程序执行。绿色突出显示了上面的循环是一种做到这一点的方法。此时，系统“停止”执行任何新代码，只是坐在循环中。这是可以做到的，但是从IDE的角度来看，这并没有表明开发人员出现了问题。如果我的调试器可以处理闪存断点，或者我将使用汇编指令__bkpt停止处理器，我更喜欢在此功能中放置断点。那时，IDE将停止并突出显示代码线，告诉我我有问题。

触发断言

一旦实现了断言功能，我将始终进行测试，以确保它以我期望的方式工作。最好的方法是简单地创建一个在应用程序中某个地方失败的断言。一个很好的例子是将以下断言放在某个地方：

断言(1> 2);

此断言永远不会是真实的，一旦编译和执行代码，我们可能会从应用程序中看到串行输出，看起来像图4。