JUnit5 学习之三：Assertions 类，java 微服务架构训练营

1. 下图是一段最简单最常见的单元测试代码，也就是 Assertions.assertEquals 方法，及其执行效果：

2. 将 Assertions.assertEquals 方法逐层展开，如下图所示，可见入参 expected 和 actual 的值如果不相等，就会在 AssertionUtils.fail 方法中抛出 AssertionFailedError 异常：

3. 用类图工具查看 Assertions 类的方法，如下图，大部分是与 assertEquals 方法类似的判断，例如对象是否为空，数组是否相等，判断失败都会抛出 AssertionFailedError 异常：

4. 判断两个数组是否相等的逻辑与判断两个对象略有不同，可以重点看看，方法源码如下：

public static void assertArrayEquals(Object[] expected, Object[] actual) {

AssertArrayEquals.assertArrayEquals(expected, actual);

}

5. 将上述代码逐层展开，在 AssertArrayEquals.java 中见到了完整的数组比较逻辑，如下图：

• 接下来，咱们编写一些单元测试代码，把 Assertions 类常用的方法都熟悉一遍；

编码实战

1. 打开 junitpractice 工程的子工程 assertassume，新建测试类 AssertionsTest.java：

2. 最简单的判断，两个入参相等就不抛异常（AssertionFailedError）：

@Test

@DisplayName("最普通的判断")

void standardTest() {

assertEquals(2, Math.addExact(1, 1));

}

3. 还有另一个 assertEquals 方法，能接受 Supplier 类型的入参，当判断不通过时才会调用 Supplier.get 方法获取字符串作为失败提示消息（如果测试通过则 Supplier.get 方法不会被执行）：

@Test

@DisplayName("带失败提示的判断(拼接消息字符串的代码只有判断失败时才执行)")

void assertWithLazilyRetrievedMessage() {

int expected = 2;

int actual = 1;

assertEquals(expected,

actual,

// 这个 lambda 表达式，只有在 expected 和 actual 不相等时才执行

()->String.format("期望值[%d]，实际值[%d]", expected, actual));

}

4. assertAll 方法可以将多个判断逻辑放在一起处理，只要有一个报错就会导致整体测试不通过，并且执行结果中会给出具体的失败详情：

@Test

@DisplayName("批量判断(必须全部通过，否则就算失败)")

void groupedAssertions() {

// 将多个判断放在一起执行，只有全部通过才算通过，如果有未通过的，会有对应的提示

assertAll("单个测试方法中多个判断",

() -> assertEquals(1, 1),

() -> assertEquals(2, 1),

() -> assertEquals(3, 1)

);

}

上述代码执行结果如下：

异常断言

1. Assertions.assertThrows 方法，用来测试 Executable 实例执行 execute 方法时是否抛出指定类型的异常；

2. 如果 execute 方法执行时不抛出异常，或者抛出的异常与期望类型不一致，都会导致测试失败；

3. 写段代码验证一下，如下，1 除以 0 会抛出 ArithmeticException 异常，符合 assertThrows 指定的异常类型，因此测试可以通过：

@Test

@DisplayName("判断抛出的异常是否是指定类型")

void exceptionTesting() {

// assertThrows 的第二个参数是 Executable，

// 其 execute 方法执行时，如果抛出了异常，并且异常的类型是 assertThrows 的第一个参数(这里是 ArithmeticException.class)，

// 那么测试就通过了，返回值是异常的实例

Exception exception = assertThrows(ArithmeticException.class, () -> Math.floorDiv(1,0));

log.info("assertThrows 通过后，返回的异常实例：{}", exception.getMessage());

}

• 以上是 Assertions 的常规用法，接下来要重点关注的就是和超时相关的测试方法；

超时相关的测试

1. 超时测试的主要目标是验证指定代码能否在规定时间内执行完，最常用的 assertTimeout 方法内部实现如下图，可见被测试的代码通过 ThrowingSupplier 实例传入，被执行后再检查耗时是否超过规定时间，超过就调用 fail 方法抛 AssertionFailedError 异常：

2. assertTimeout 的用法如下，期望时间是 1 秒，实际上 Executable 实例的 execute 用了两秒才完成，因此测试失败：

@Test

@DisplayName("在指定时间内完成测试")

void timeoutExceeded() {

// 指定时间是 1 秒，实际执行用了 2 秒

ass

【一线大厂Java面试题解析+核心总结学习笔记+最新架构讲解视频+实战项目源码讲义】
浏览器打开：qq.cn.hn/FTf 免费领取

ertTimeout(ofSeconds(1), () -> {

try{

Thread.sleep(2000);

} catch (InterruptedException e) {

e.printStackTrace();

}

});

}

执行结果如下图：

3. 上面的演示中，assertTimeout 的第二个入参类型是 Executable，此外还有另一个 assertTimeout 方法，其第二个入参是 ThrowingSupplier 类型，该类型入参的 get 方法必须要有返回值，假设是 XXX，而 assertTimeout 就拿这个 XXX 作为它自己的返回值，使用方法如下：

@Test

@DisplayName("在指定时间内完成测试")

void timeoutNotExceededWithResult() {

// 准备 ThrowingSupplier 类型的实例，

// 里面的 get 方法 sleep 了 1 秒钟，然后返回一个字符串

ThrowingSupplier<String> supplier = () -> {

try{

Thread.sleep(1000);

} catch (InterruptedException e) {

e.printStackTrace();

}

return "我是 ThrowingSupplier 的 get 方法的返回值";

};

// 指定时间是 2 秒，实际上 ThrowingSupplier 的 get 方法只用了 1 秒

String actualResult = assertTimeout(ofSeconds(2), supplier);

log.info("assertTimeout 的返回值：{}", actualResult);

}

上述代码执行结果如下，测试通过并且 ThrowingSupplier 实例的 get 方法的返回值也被打印出来：

4. 刚才咱们看过了 assertTimeout 的内部实现代码，是将入参 Executable 的 execute 方法执行完成后，再检查 execute 方法的耗时是否超过预期，这种方法的弊端是必须等待 execute 方法执行完成才知道是否超时，assertTimeoutPreemptively 方法也是用来检测代码执行是否超时的，但是避免了 assertTimeout 的必须等待 execute 执行完成的弊端，避免的方法是用一个新的线程来执行 execute 方法，下面是 assertTimeoutPreemptively 的源码：

public static void assertTimeoutPreemptively(Duration timeout, Executable executable) {

AssertTimeout.assertTimeoutPreemptively(timeout, executable);

}