JUnit @DisplayName：优化测试名称显示，提升可读性

2 年 ago
韵, 科
1 minute

JUnit 的 @DisplayName 注解用于为测试类和测试方法提供自定义名称。我们可以在显示名称中使用空格、特殊字符甚至表情符号。

JUnit 显示名称示例

默认情况下，JUnit 的报告会在 IDE 测试报告中打印出类名和方法名。我们可以使用 @DisplayName 来指定一个易读且能提供关于测试类和方法信息的自定义名称。让我们看一些 JUnit Jupiter @DisplayName 注解的例子。

测试类的显示名称

@DisplayName("我的测试类")
public class DisplayNameTest {
}

方法的显示名称

@Test
@DisplayName("无业务逻辑的示例测试方法")
void test() {
	assertTrue(3 > 0);
}

显示名称与表情符号

@Test
@DisplayName("我的测试方法 ☺")
void test1(TestInfo testInfo) {
	assertEquals("我的测试方法 ☺", testInfo.getDisplayName());
}

注意，我们可以通过在方法参数中注入 TestInfo 来获取测试方法的显示名称。

报告中的 JUnit 显示名称

JUnit 显示名称 @DisplayName 注解

总结

JUnit Jupiter 的 @DisplayName 注解本身并不能直接提升测试效果。然而，它能够提供关于测试方法的信息，这些信息可以在报告中显示，并且可以被任何非技术用户轻松理解。

你可以在我们的 GitHub 代码仓库中查看完整的课程和其他 JUnit 示例。

bannerAds