Assertion (software development) -- 断言

Wiki:

　　In computer programming, an assertion is a predicate (a true–false statement) placed in a program to indicate that the developer thinks that the predicate is always true at that place. If an assertion evaluates to false at run-time, an assertion failure results, which typically causes execution to abort.

　　在程式設計中，斷言（assertion）是一種放在程式中的一階邏輯（如一個結果為真或是假的邏輯判斷式），目的是為了標示與驗證程式開發者預期的結果－當程式執行到斷言的位置時，對應的斷言應該為真。若斷言不會真時，程式會中止執行，並出現錯誤訊息。

　　Programmers can use assertions to help specify programs and to reason about program correctness. For example, a precondition—an assertion placed at the beginning of a section of code—determines the set of states under which the programmer expects the code to execute. A postcondition—placed at the end—describes the expected state at the end of execution.

　　程式設計者可以用斷言來標示程式，提供程式正確性的相關資訊。例如在一段程式前加入斷言（先驗條件），說明這段程式執行前預期的狀態。或在一段程式後加入斷言（後驗條件），說明這段程式執行後預期的結果。

　　In languages such as Eiffel, assertions form part of the design process; other languages, such as C and Java, use them only to check assumptions at runtime. In both cases, they can be checked for validity at runtime but can usually also be suppressed.

　　在開發Eiffel語言的程式時，斷言是設計過程中的一部份。像C語言或Java等程式語言，主要在執行期檢查斷言是否正確，也可以用靜態斷言的方式，在編譯期檢查斷言。不論是哪一種情形，都可以檢查斷言的有效性，也可以關閉斷言檢查的機能。

百度百科：

1、编程断言：

　　编写代码时，我们总是会做出一些假设，断言就是用于在代码中捕捉这些假设。断言表示为一些布尔表达式，程序员相信在程序中的某个特定点该表达式值为真，可以在任何时候启用和禁用断言验证，因此可以在测试时启用断言而在部署时禁用断言。同样，程序投入运行后，最终用户在遇到问题时可以重新启用断言。

　　使用断言可以创建更稳定、品质更好且 不易于出错的代码。当需要在一个值为FALSE时中断当前操作的话，可以使用断言。单元测试必须使用断言（Junit/JunitX）。

　　除了类型检查和单元测试外，断言还提供了一种确定各种特性是否在程序中得到维护的极好的方法。

　　使用断言使我们向按契约式设计更近了一步。

2、断言特性：

　　前置条件断言：代码执行之前必须具备的特性

　　后置条件断言：代码执行之后必须具备的特性

　　前后不变断言：代码执行前后不能变化的特性

3、断言方式：

• assert Expression1
• assert Expression1:Expression2

　　其中Expression1应该总是一个布尔值，Expression2是断言失败时输出的失败消息的字符串。如果 Expression1为假，则抛出一个 AssertionError，这是一个错误，而不是一个异常，也就是说是一个不可控制异常（unchecked Exception)，AssertionError由于是错误，所以可以不捕获，但不推荐这样做，因为那样会使你的系统进入不稳定状态。

4、用法：

不用的情况：

　　1.不要使用断言作为公共方法的参数检查，公共方法的参数永远都要执行

　　2.断言语句不可以有任何边界效应，不要使用断言语句去修改变量和改变方法的返回值

用的情况：

　　1.可以在预计正常情况下程序不会到达的地方放置断言 ：assert false

　　2.断言可以用于检查传递给私有方法的参数。（对于公有方法，因为是提供给外部的接口，所以必须在方法中有相应的参数检验才能保证代码的健壮性）

　　3.使用断言测试方法执行的前置条件和后置条件

　　4.使用断言检查类的不变状态，确保任何情况下，某个变量的状态必须满足。（如age属性应大于0小于某个合适值）

 

 

补充：

使用断言的几个原则：

• 使用断言捕捉不应该发生的非法情况。不要混淆非法情况与错误情况之间的区别，后者是必然存在的并且是一定要作出处理的。
• 使用断言对函数的参数进行确认。
• 在编写函数时，要进行反复的考查，并且自问：“我打算做哪些假定？”一旦确定了的假定，就要使用断言对假定进行检查。
• 一般教科书都鼓励程序员们进行防错性的程序设计，但要记住这种编程风格会隐瞒错误。当进行防错性编程时，如果“不可能发生”的事情的确发生了，则要使用断言进行报警。

　　程序一般分为Debug 版本和Release 版本，Debug 版本用于内部调试，Release 版本发行给用户使用。 断言assert 是仅在Debug 版本起作用的宏，它用于检查“不应该”发生的情况。

Usage：

　　assert宏的原型定义在assert.h中，其作用是如果它的条件返回错误，则终止程序执行.

　　assert()是一个诊断宏，用于动态辨识程序的逻辑错误条件。其原型是：

 #include "assert.h"
 void assert( int expression );

如果宏的参数求值结果为非零值，则不做任何操作（no action）；如果是零值，用宽字符打印诊断消息，然后调用abort()。诊断消息包括：

• 源文件名字（在stdlib.h中声明的宏__FILE__的值）
• 所在的源文件的行号（在stdlib.h中声明的宏__LINE__的值）
• 所在的函数名（在stdlib.h中声明的宏__func__的值），这是C99新增的特性
• 求值结果为0的表达式

诊断信息的显示目标依赖于被调用程序的类型。如果是控制台程序，诊断信息显示在stderr设备；如果是基于窗口的程序，assert()产生一个Windows MessageBox来显示诊断信息。

　　 使用assert的缺点是，频繁的调用会极大的影响程序的性能，增加额外的开销。 
　　 在调试结束后，可以通过在包含#include 的语句之前插入 #define NDEBUG 来禁用assert调用，示例代码如下：

 #include
 #define NDEBUG
 #include