【Java】JAVA中的断言是什么?有什么陷阱?

Z时代
2024-01-10
分类：技术分享

如何在 Java 中使用断言

什么是 Java 断言？

在 JDK 1.4之前，开发人员经常使用注释来记录关于程序正确性的假设。然而，注释作为测试和调试假设的机制是无用的。编译器忽略注释，因此无法使用它们进行 bug 检测。开发人员在更改代码时也经常不更新注释。

在 JDK 1.4中，断言被引入作为测试和调试代码假设的新机制。实质上，断言是在运行时执行的可编译实体，假设你已经为程序测试启用了它们。可以通过编写断言来通知 bug 发生的地方，这样可以大大减少调试失败程序的时间。

如何用 Java 编写断言

编写断言的表达式:

assert BooleanExpr;

如果 BooleanExpr 的计算结果为 true，则不会发生任何事情，并继续执行。但是，如果表达式计算结果为 false，那么将抛出 AssertionError

举个例子

    public static void main(String[] args) {
int a = 10;
assert a>100;//false}

此断言表明开发人员认为变量 a 包含一个大于100的值。但是，情况显然不是这样;

assert 语句的执行导致抛出 AssertionError

运行后没有反应??

有的小伙伴发现自己的IDE并没有抛出Error 这是因为没有显示开启,启用断言
开启方法: vm options 加入 -ea

【Java】JAVA中的断言是什么?有什么陷阱?

此时我们运行项目发现抛出了异常

Exception in thread "main" java.lang.AssertionError

at Scratch.main(scratch_4.java:4)

希望获得更多信息?

此时我们已经知道了断言的基本用法但是抛出Error后我们并不知道是什么问题导致的还需要去翻看代码找到报错的地方, 如果我们希望获得更多有用的信息我们可以这样修改Assert语句:

assert BooleanExpr : expr;

expr 是任何可以返回值的表达式(包括方法调用)但是不能调用具有 void 返回类型的方法。一个有用的表达式是一个字符串，用它来描述失败的原因

举个例子

public static void main(String[] args) {
int a = 10;
assert a>100 : "a < 100";}

运行:

Exception in thread "main" java.lang.AssertionError: a < 100at Scratch.main(scratch_4.java:5)

无论哪个例子，在不使用-ea (启用断言)选项的情况下运行都不会产生输出。当断言未启用时，它们不会执行，尽管它们仍然存在于类文件中。

前置条件和后置条件

前置条件: 是在执行某些代码之前必须求值为 true 的条件

后置条件: 是在执行某些代码后必须求值为 true 的条件

前置条件

前置条件检查:

import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
class PNG
{
/**
*  Create a PNG instance, read specified PNG file, and decode
*  it into suitable structures.
*
*  @param filespec path and name of PNG file to read
*
*  @throws NullPointerException when <code>filespec</code> is
*          <code>null</code>
*/
PNG(String filespec) throws IOException
{
//在非私有构造方法中 使用前置条件
if (filespec == null)
throw new NullPointerException("filespec is null");
try (FileInputStream fis = new FileInputStream(filespec))
{
readHeader(fis);
}
}
private void readHeader(InputStream is) throws IOException
{
//在私有方法中使用前置条件检查
assert is != null : "null passed to is";
}
}
class Scratch
{
public static void main(String[] args) throws IOException
{
PNG png = new PNG((args.length == 0) ? null : args[0]);
}
}

后置条件

后置条件检查:

public class AssertDemo
{
public static void main(String[] args)
{
int[] array = { 20, 91, -6, 16, 0, 7, 51, 42, 3, 1 };
sort(array);
for (int element: array)
System.out.printf("%d ", element);
System.out.println();
}
private static boolean isSorted(int[] x)
{
for (int i = 0; i < x.length - 1; i++)
if (x[i] > x[i + 1])
return false;
return true;
}
private static void sort(int[] x)
{
int j, a;
// For all integer values except the leftmost value ...
for (int i = 1; i < x.length; i++)
{
// Get integer value a.
a = x[i];
// Get index of a. This is the initial insert position, which is
// used if a is larger than all values in the sorted section.
j = i;
// While values exist to the left of a's insert position and the
// value immediately to the left of that insert position is
// numerically greater than a's value ...
while (j > 0 && x[j - 1] > a)
{
// Shift left value -- x[j - 1] -- one position to its right --
// x[j].
x[j] = x[j - 1];
// Update insert position to shifted value's original position
// (one position to the left).
j--;
}
// Insert a at insert position (which is either the initial insert
// position or the final insert position), where a is greater than
// or equal to all values to its left.
x[j] = a;
}
//在 sort ()返回给它的调用者之前，我使用 assert 检查 x 被排序的后置条件。
assert isSorted(x): "array not sorted";
}}