Java陷阱之assert关键字详解

一、概述
 
在c和c++语言中都有assert关键，表示断言。
在java中，同样也有assert关键字，表示断言，用法和含义都差不多。

二、语法
 
在java中，assert关键字是从java se 1.4 引入的，为了避免和老版本的java代码中使用了assert关键字导致错误，java在执行的时候默认是不启动断言检查的（这个时候，所有的断言语句都 将忽略！），如果要开启断言检查，则需要用开关-enableassertions或-ea来开启。

assert关键字语法很简单，有两种用法：

1、assert <boolean表达式>
如果<boolean表达式>为true，则程序继续执行。
如果为false，则程序抛出assertionerror，并终止执行。

2、assert <boolean表达式> : <错误信息表达式>
如果<boolean表达式>为true，则程序继续执行。
如果为false，则程序抛出java.lang.assertionerror，并输入<错误信息表达式>。

三、应用实例
 
下面给出一个例子，通过例子说明其用法：

public class assertfoo {
    public static void main(string args[]) {
        //断言1结果为true，则继续往下执行
        assert true;
        system.out.println("断言1没有问题，go！");

        system.out.println("\n-----------------\n");

        //断言2结果为false,程序终止
        assert false : "断言失败，此表达式的信息将会在抛出异常的时候输出！";
        system.out.println("断言2没有问题，go！");
    }
}

保存代码到c:\assertfoo.java，然后按照下面的方式执行，查看控制台输出结果：

1、编译程序：
c:\>javac assertfoo.java

2、默认执行程序，没有开启-ea开关：
c:\>java assertfoo
断言1没有问题，go！

-----------------

断言2没有问题，go！

3、开启-ea开关，执行程序：
c:\>java -ea assertfoo
断言1没有问题，go！

-----------------

exception in thread "main" java.lang.assertionerror: 断言失败，此表达式的信息将
会在抛出异常的时候输出！
        at assertfoo.main(assertfoo.java:10)

四、陷阱
 
assert关键字用法简单，但是使用assert往往会让你陷入越来越深的陷阱中。应避免使用。笔者经过研究，总结了以下原因：

1、assert关键字需要在运行时候显式开启才能生效，否则你的断言就没有任何意义。而现在主流的java ide工具默认都没有开启-ea断言检查功能。这就意味着你如果使用ide工具编码，调试运行时候会有一定的麻烦。并且，对于java web应用，程序代码都是部署在容器里面，你没法直接去控制程序的运行，如果一定要开启-ea的开关，则需要更改web容器的运行配置参数。这对程序的移 植和部署都带来很大的不便。

2、用assert代替if是陷阱之二。assert的判断和if语句差不多，但两者的作用有着本质的区别：assert关键字本意上是为测试 调试程序时使用的，但如果不小心用assert来控制了程序的业务流程，那在测试调试结束后去掉assert关键字就意味着修改了程序的正常的逻辑。

3、assert断言失败将面临程序的退出。这在一个生产环境下的应用是绝不能容忍的。一般都是通过异常处理来解决程序中潜在的错误。但是使用断言就很危险，一旦失败系统就挂了。

 
五、对assert的思考
 
assert既然是为了调试测试程序用，不在正式生产环境下用，那应该考虑更好的测试juint来代替其做用，juint相对assert关键的所提供的功能是有过之而无不及。当然完全可以通过ide debug来进行调试测试。在此看来，assert的前途一片昏暗。

因此，应当避免在java中使用assert关键字，除非哪一天java默认支持开启-ea的开关，这时候可以考虑。对比一下，assert能给你带来多少好处，多少麻烦，这是我们选择是否使用的的原则。

============================================================
comment：
反过来说，在某些开源组件中，比如validator、junit中，判断过程仿佛使用了断言风格，很有可能使用了大量的断言，但笔者在没看源码之前不能确定。
如果是开发阶段的简单测试，junit就是一个便捷强悍的工具，没有理由自己写断言而不去用它。

============================================================
comment：
首先可以用在单元测试代码中。junit侵入性是很强的，如果整个工程大量的代码都使用了junit，就难以去掉或者是选择另外一个框架。如果单元测试代码 很多，并且想复用这些单元测试案例，应该选择assert而不是junit，便于使用别的单元测试框架，比如testng。同理正式的功能代码根本就不应 该出现junit，应该使用assert.

assert主要适合在基类，框架类，接口类，核心代码类，工具类中。换言之，当你的代码的调用者是另外一个程序员写得业务代码，或者是另外一个子系统时，就很有必要使用它。比如你做了一个快速排序的算法

public static list<int> quicksort(list<int> list){
  assert list != null;
  // 申请临时空间
  //开始排序
  for(int i : list){
      //
  }
}

这种情况下，如果不检查传入参数的正确性，会抛出一个莫名其妙的空指针错误。你的调用者可能并不清楚你代码的细节，在一个系统的深处调试一个空指针错误是很浪费时间的。就应该直接明确的告诉你的调用者是传入的参数有问题。否则他会怀疑你的代码有bug。使用assert可以避免两个程序员之间互相指责对方写的代码有问题。

assert适用那些你知道具体是什么错误，你和你的调用者已经约定应该由你的调用者去排除或检查的错误。你通过一个断言告诉你的调用者。assert不适用那些外部系统造成的错误，比如用户输入数据的错误，某个外部文件格式错误。这些错误不是你的调用者而是用户造成的，甚至于不属于异常，因为出现输入错误和文件格式错误是经常的，这些错误应该由业务代码去检查。

assert比较适合于被频繁调用的 基类，框架代码，工具类，核心代码，接口代码中，这正是它在运行时被去掉的原因。测试代码应该在测试阶段开启-ea参数，便于对系统深处的核心代码做仔细的测试。

java较少使用assert的原因是java有很完整的oo体系，强制类型转换出现得较少，所以不需要类似c那样需要频繁的检查指针的类型是否正确，指针是否为空。同时java也很少直接管理内存或缓冲区，所以不需要频繁的检查传入的缓冲区是否为空或者是已经越界。

但使用好assert有助于提高框架代码的正确性和减少框架代码的使用者的调试时间。

===============================================================
comment：
assert要达到的目的是让程序员方便的发现自己的逻辑错误，并且不影响程序的效率。assert所发现的错误，是完全不应该出现的，是不能用异常代替的。异常，那是系统所允许的，或者是系统不可控的“错误”，它不是程序员的逻辑问题。

assert应该是开发阶段打开，而在发布后关闭。