Java中断言的用法

Posted 2023-05-06

简单描述下断言的用法

第一步：定义一个断言，如：

int number=-28; assert (number>0):"负数不能计算平方根";//此断言是假的，所以会输出后面内容，之后会报错

第二步：在断言的类中右击选择“Run As”，之后选择” Run Configuration“；

第三步：选择 Arguments 选项卡；
第四步：在 VM arguments 文本框中输入” -ea“来运行断言；

输出结果：

参考技术A JDK1.4中引入的一个新特性之一就是断言（assert），为程序的调试提供了强有力的支持，以下的文档根据SUNTEC内容及相关内容组成。

　　源代码：

/**
* Simple examples of the use of the new assertion feature in JDK1.4
*
* @author S.Ritter 16/7/2001
**/

public class AssertExample

public static void main(String[] args)
int x = 10;
if (args.length > 0)
try
x = Integer.parseInt(args[0]);
catch (NumberFormatException nfe)
/* Ignore */


System.out.println("Testing assertion that x == 10");
assert x == 10:"Our assertion failed";
System.out.println("Test passed");




　　由于引入了一个新的要害字，所以在编译的时候就需要增加额外的参数，要编译成功，必须使用JDK1.4的Javac并加上参数'-source 1.4',例如可以使用以下的命令编译上面的代码：

　　javac -source 1.4 AssertExample.java

　　以上程序运行使用断言功能也需要使用额外的参数（并且需要一个数字的命令行参数），例如：

　　java -ea AssertExample 1

　　程序的输出为：

　　Testing assertion that x == 10
　　Exception in thread "main" java.lang.AssertionError:
　　Our assertion failed
　　at AssertExample.main(AssertExample.java:20)

　　由于输入的参数不等于10，因此断言功能使得程序运行时抛出断言错误，注重是错误，这意味着程序发生严重错误并且将强制退出。断言使用boolean值，假如其值不为true则抛出AssertionError并终止程序的运行。

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

　　boolean isEnable=false;
　　//...
　　assert isEnable=true;

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

/**
* Simple examples test enable assertion feature in JDK1.4
*
* @author Cherami 25/4/2002
**/

public class AssertExample2

public static void main(String[] args)
boolean assertEnable=false;
assert assertEnable=true;
if (assertEnable==false)
throw new RuntimeException("Assertions should be enable");





　　假如我们不使用-ea参数运行上面的程序，则控制台将输出：

　　Exception in thread "main" java.lang.RuntimeException:
　　Assertions should be enab
　　le
　　at AssertExample.main(AssertExample.java:14) 参考技术B 假定某一段的正确或者错误

Java断言绝对不是鸡肋

在防御式编程中经常会用断言（Assertion）对参数和环境做出判断，避免程序因不当的输入或错误的环境而产生逻辑异常，断言在很多语言中都存在，C、C++、Python 都有不同的断言表示形式。在Java 中的断言使用的是assert 关键字，其基本的用法如下：
    assert < 布尔表达式>
    assert < 布尔表达式> : < 错误信息>
在布尔表达式为假时，抛出AssertionError 错误，并附带了错误信息。assert 的语法较简单，有以下两个特性：

• assert 默认是不启用的
  我们知道断言是为调试程序服务的，目的是为了能够快速、方便地检查到程序异常，但Java 在默认条件下是不启用的，要启用就需要在编译、运行时加上相关的关键字，这就不多说，有需要的话可以参考一下Java 规范。
• assert 抛出的异常AssertionError 是继承自Error 的
  断言失败后，JVM 会抛出一个AssertionError 错误，它继承自Error，注意，这是一个错误，是不可恢复的，也就表示这是一个严重问题，开发者必须予以关注并解决之。

assert 虽然是做断言的，但不能将其等价于if…else…这样的条件判断，它在以下两种情况不可使用：
（1）在对外公开的方法中
我们知道防御式编程最核心的一点就是：所有的外部因素（输入参数、环境变量、上下文）都是“邪恶”的，都存在着企图摧毁程序的罪恶本源，为了抵制它，我们要在程序中处处检验，满地设卡，不满足条件就不再执行后续程序，以保护主程序的正确性，处处设卡没问题，但就是不能用断言做输入校验，特别是公开方法。我们来看一个例子：
public class Client {
    public static void main(String[] args) {
        StringUtils.encode(null);
    }
}
// 字符串处理工具类
class StringUtils{
    public static String encode(String str){
        assert str!=null:" 加密的字符串为null";
        /* 加密处理*/
    }
}
encode 方法对输入参数做了不为空的假设，如果为空，则抛出AssertionError 错误，但这段程序存在一个严重的问题，encode 是一个public 方法，这标志着是它对外公开的，任何一个类只要能够传递一个String 类型的参数（遵守契约）就可以调用，但是Client 类按照规范和契约调用enocde 方法，却获得了一个AssertionError 错误信息，是谁破坏了契约协定？—是encode 方法自己。

（2）在执行逻辑代码的情况下
assert 的支持是可选的，在开发时可以让它运行，但在生产系统中则不需要其运行了（以便提高性能），因此在assert 的布尔表达式中不能执行逻辑代码，否则会因为环境不同而产生不同的逻辑，例如：
public void doSomething(List list,Object element){
    assert list.remove(element):" 删除元素 " + element + " 失败";
    /* 业务处理*/
}
这段代码在assert 启用的环境下，没有任何问题，但是一旦投入到生产环境，就不会启用断言了，而这个方法也就彻底完蛋了，list 的删除动作永远都不会执行，所以也就永远不会报错或异常，因为根本就没有执行嘛！

以上两种情况下不能使用assert，那在什么情况下能够使用assert 呢？一句话：按照正常执行逻辑不可能到达的代码区域可以放置assert。具体分为三种情况：

• 在私有方法中放置assert 作为输入参数的校验
  在私有方法中可以放置assert 校验输入参数，因为私有方法的使用者是作者自己，私有方法的调用者和被调用者之间是一种弱契约关系，或者说没有契约关系，其间的约束是依靠作者自己控制的，因此加上assert 可以更好地预防自己犯错，或者无意的程序犯错。
• 流程控制中不可能达到的区域
  这类似于JUnit 的fail 方法，其标志性的意义就是：程序执行到这里就是错误的，例如：
  public void doSomething(){
      int i = 7;
      while(i >7){
          /* 业务处理*/
      }
      assert false:" 到达这里就表示错误";
  }
• 建立程序探针
  我们可能会在一段程序中定义两个变量，分别代表两个不同的业务含义，但是两者有固定的关系，例如var1=var2*2，那我们就可以在程序中到处设“桩”，断言这两者的关系，如果不满足即表明程序已经出现了异常，业务也就没有必要运行下去了。
  • from:http://www.weixueyuan.net/view/6105.html