JUnit 的显示名称 – @DisplayName

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

JUnit显示名称示例

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

@DisplayName("MyTestClass")
public class DisplayNameTest {
}

方法的显示名称

@Test
@DisplayName("Example Test Method with No Business Logic")
void test() {
	assertTrue(3 > 0);
}

显示名称与表情符号

@Test
@DisplayName("MyTestMethod ☺")
void test1(TestInfo testInfo) {
	assertEquals("MyTestMethod ☺", testInfo.getDisplayName());
}

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

报告中的JUnit显示名称

总结

JUnit Jupiter的@DisplayName注解并没有提供任何测试的好处。然而，它可以用来提供关于测试方法的信息，这些信息可以在报告中显示，并且可以被任何非技术用户轻松理解。

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