assert函数（断言）

断言概述

编写代码时，我们总是会做出一些假设，断言就是用于在代码中捕捉这些假设

可以将断言看作是异常处理的一种高级形式

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

可以在任何时候启用和禁用断言验证，因此可以在测试时启用断言而在部署时禁用断言。同样，程序投入运行后，最终用户在遇到问题时可以重新起用断言。

使用断言可以创建更稳定，品质更好且易于除错的代码

当需要在一个值为FALSE时中断当前操作的话，可以使用断言

单元测试必须使用断言（Junit/JunitX）

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

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

常见的断言特性

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

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

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

断言使用方式

断言可以有两种形式

1.assert Expression1

2.assert Expression1:Expression2

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

起用断言

断言在默认情况下是关闭的，要在编译时启用断言，需要使用source1.4标记既javac source1.4 Test.java ,在运行时启用断言需要使用 -ea参数。要在系统类中启用和禁用断言可以使用 -esa 和 -dsa参数。

例如：

public > public AssertExampleOne(){}

public static void main(String args[]){

    int x=10;

    System.out.println("Testing Assertion that x==100");

    assert x=100;"Out assertion failed!";

    System.out.println("Test passed!");

}

}

如果编译时未加 -source1.4,则编译通不过

在执行时未加 -ea 时输出为

Testing Assertion that x==100

Test passed

jre忽略了断言的就代码，而使用了该参数就会输出为

Testing Assertion that x==100

Exception in thread "main" java.lang.AssertionError: Out assertion failed!

at AssertExampleOne.main(AssertExampleOne.java:6)

断言的副作用

由于程序员的问题，断言的使用可能会带来副作用，例如：

boolean isEnable=false;

//...

assert isEnable=true;

这个断言的副作用是因为它修改了程序中变量的值并且未抛出错误，这样的错误如果不细心的检查是很难发现的。但是同时我们可以根据以上的副作用得到一个有用的特性，根据它来测试断言是否打开。

public >

public static void main(String args[]){

    boolean isEnable=false;

    //...

    assert isEnable=true;

    if(isEnable==false){

      throw new RuntimeException("Assertion shoule be enable!");

    }

}

}

何时需要使用断言

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

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

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

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

什么地方不要使用断言

断言语句不是永远会执行，可以屏蔽也可以启用

因此：

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

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

下边是介绍断言的用法:

assert是在J2SE1.4中引入的新特性，assertion就是在代码中包括的布尔 型状态，程序员认为这个状态是true。一般来说assert在开发的时候是检查程序的安全性的，在发布的时候通常都不使用assert。在1.4中添加 了assert关键字和java.lang.AssertError类的支持。

首先，我们有必要从一个例子说起assert

public > public static void main(String[] args) {

    AssertTest at = new AssertTest();

    at.assertMe(true);

    at.assertMe(false);

}

private void assertMe(boolean boo) {

    assert boo?true:false;

    System.out.println("true condition");

}

}

程序中包含了assert的话，你要用javac -source 1.4 xxx.java来编译，否则编译器会报错的。要想让assert得部分运行的话，要使用java -ea xxx来运行，否则包含assert得行会被忽略。下面我们运行

javac -source 1.4 AssertTest.java

java -ea AssertTest

看看结果的输出是：

true condition

Exception in thread "main" java.lang.AssertionError

at AssertTest.assertMe(AssertTest.java:13)

at AssertTest.main(AssertTest.java:7)

当我们运行at.assertMe(true)得时候，由于assert boo?true:false相当于 assert true;因此没有任何问题，程序往下执行打印出true condition，但是执行at.assertMe(false)的时候相当于assert false，这个时候解释器就会抛出AssertionError了，程序就终止了。大家必须清楚AssertionError是继承自Error得，因 此你可以不再程序中catch它的，当然你也可以在程序中catch它然后程序可以继续执行。例如：

public > public static void main(String[] args) {

    AssertTest at = new AssertTest();

    try {

      at.assertMe(true);

      at.assertMe(false);

    } catch(AssertionError ae) {

      System.out.println("AsseriontError catched");

    }

    System.out.println("go on");

}

private void assertMe(boolean boo) {

    assert boo?true:false;

    System.out.println("true condition");

}

}

assert还有另外一种表达的方式，就是assert exp1:exp2;其中exp1是个boolean返回值得表达式，而exp2可以是原始的数据类型或者对象都可以例如：

boolean boo = true;

String str = null;

assert boo = false：str="error";

我们刚开始讲得assert exp1得形式，当exp1是false得时候，AssertionError得默认构造器会被调用，但是assert exp1:exp2这样的形式，当exp1为true的时候后面exp2被或略，如果false的话，后面的表达式的结果会被计算出来并作为 AssertionError得构造器参数。看下面的例子：

public > public static void main(String[] args) {

    AssertTest at = new AssertTest();

    at.assertMe(true);

    at.assertMe(false);

}

private void assertMe(boolean boo) {

    String s = null;

    assert boo?true:false:s = "hello world";

    System.out.println("true condition");

}

}

运行的时候会得到这样的结果:

true condition

Exception in thread "main" java.lang.AssertionError: hello world

at AssertTest.assertMe(AssertTest.java:14)

at AssertTest.main(AssertTest.java:7)

Assert最好不要滥用，原因是assert并不一定都是enable的，下面两种情况就不应该用assert

不要在public的方法里面检查参数是不是为null之类的操作，例如

public int get(String s) {

assert s != null;

}

如果需要检查也最好通过if s = null 抛出NullPointerException来检查

不要用assert来检查方法操作的返回值来判断方法操作的结果，例如

assert list.removeAll();

这样看起来好像没有问题但是想想如果assert 被disable呢，那样他就不会被执行了所以removeAll()操作就没有被执行可以这样代替

boolean boo = list.removeAl();

assert boo;

函数名: assert
功  能: 测试一个条件并可能使程序终止
用  法: void assert(int test);

程序例:
#include <assert.h>
#include <stdio.h>
#include <stdlib.h>

struct ITEM {
   int key;
   int value;
};

/* add item to list, make sure list is not null */
void additem(struct ITEM *itemptr) {
   assert(itemptr != NULL);
   /* add item to list */
}

int main(void)
{
   additem(NULL);
   return 0;
}
assert(断言)可以有两种形式：
assert Expression1 ;
assert Expression1 : Expression2 ;
Expression1 应该总是产生一个布尔值。
Expression2 可以是得出一个值的任意表达式。这个值用于生成显示更多调试信息的 String 消息。
断言在默认情况下是禁用的。要在编译时启用断言，需要使用 source 1.4 标记：
javac -source 1.4 Test.java
要在运行时启用断言，可使用 -enableassertions 或者 -ea 标记。
要在运行时选择禁用断言，可使用 -da 或者 -disableassertions 标记。
要系统类中启用断言，可使用 -esa 或者 -dsa 标记。还可以在包的基础上启用或者禁用断言。
可以在预计正常情况下不会到达的任何位置上放置断言。断言可以用于验证传递给私有方法的参数。不过，断言不应该用于验证传递给公有方法的参数，因为不管是 否启用了断言，公有方法都必须检查其参数。不过，既可以在公有方法中，也可以在非公有方法中利用断言测试后置条件。另外，断言不应该以任何方式改变程序的 状态。

assert() 函数用法
assert宏的原型定义在<assert.h>中，其作用是如果它的条件返回错误，则终止程序执行，原型定义：
#include <assert.h>
void assert( int expression );
assert的作用是现计算表达式 expression ，如果其值为假（即为0），那么它先向stderr打印一条出错信息，
然后通过调用 abort 来终止程序运行。
请看下面的程序清单badptr.c：
#include <stdio.h>
#include <assert.h>
#include <stdlib.h>
int main( void )
{
       FILE *fp;
   
       fp = fopen( "test.txt", "w" );//以可写的方式打开一个文件，如果不存在就创建一个同名文件
       assert( fp );                           //所以这里不会出错
       fclose( fp );
   
       fp = fopen( "noexitfile.txt", "r" );//以只读的方式打开一个文件，如果不存在就打开文件失败
       assert( fp );                           //所以这里出错
       fclose( fp );                           //程序永远都执行不到这里来
       return 0;
}
[root@localhost error_process]# gcc badptr.c
[root@localhost error_process]# ./a.out
a.out: badptr.c:14: main: Assertion `fp' failed.
已放弃
使用assert的缺点是，频繁的调用会极大的影响程序的性能，增加额外的开销。
在调试结束后，可以通过在包含#include <assert.h>的语句之前插入 #define NDEBUG 来禁用assert调用，示例代码如下：
#include <stdio.h>
#define NDEBUG
#include <assert.h>
用法总结与注意事项：
1)在函数开始处检验传入参数的合法性
如:
int resetBufferSize(int nNewSize)
{
//功能:改变缓冲区大小,
//参数:nNewSize 缓冲区新长度
//返回值:缓冲区当前长度
//说明:保持原信息内容不变     nNewSize<=0表示清除缓冲区
assert(nNewSize >= 0);
assert(nNewSize <= MAX_BUFFER_SIZE);
...
}
2)每个assert只检验一个条件,因为同时检验多个条件时,如果断言失败,无法直观的判断是哪个条件失败
不好: assert(nOffset>=0 && nOffset+nSize<=m_nInfomationSize);
好: assert(nOffset >= 0);
assert(nOffset+nSize <= m_nInfomationSize);

3)不能使用改变环境的语句,因为assert只在DEBUG个生效,如果这么做,会使用程序在真正运行时遇到问题
错误: assert(i++ < 100)
这是因为如果出错，比如在执行之前i=100,那么这条语句就不会执行，那么i++这条命令就没有执行。
正确: assert(i < 100)
         i++;
            
      
4)assert和后面的语句应空一行,以形成逻辑和视觉上的一致感
5)有的地方,assert不能代替条件过滤