目录
提前预知
- 课程笔记来源于雷神的SpringBoot2教程
- 参考文档地址:参考文档
- 要学会查看官方文档!!!!!!!!!
01、JUnit5
Spring Boot 2.2.0 版本开始引入 JUnit 5 作为单元测试默认库
,作为最新版本的JUnit框架,JUnit5与之前版本的Junit框架有很大的不同。
由三个不同子项目的几个不同模块组成:
Unit 5 = JUnit Platform + JUnit Jupiter + JUnit Vintage
JUnit Platform
: Junit Platform是在JVM上启动测试框架的基础,不仅支持Junit自制的测试引擎,其他测试引擎也都可以接入。JUnit Jupiter
: JUnit Jupiter提供了JUnit5的新的编程模型,是JUnit5新特性的核心。内部 包含了一个测试引擎,用于在Junit Platform上运行。JUnit Vintage
: 由于JUint已经发展多年,为了照顾老的项目,JUnit Vintage提供了兼容JUnit4.x,Junit3.x的测试引擎。
注意:
- SpringBoot 2.4 以上版本移除了
默认对 Vintage 的依赖
。如果需要兼容junit4需要自行引入(不能使用junit4的功能
) - JUnit 5’s Vintage 引擎被移除了从
spring-boot-starter-test
场景启动器中,如果需要继续兼容junit4需要自行引入Vintage
如何导包:
- 如果不想使用JUnit4版本的功能,直接导入
spring-boot-starter-test
场景启动器,使用JUnit5进行测试
即可
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
- 如果
还想使用JUnit4测试功能
,则要这样
<!--测试引擎启动器-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<!--兼容junit4-->
<dependency>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>org.hamcrest</groupId>
<artifactId>hamcrest-core</artifactId>
</exclusion>
</exclusions>
</dependency>
使用:SpringBoot整合JUnit以后
- 测试类上使用
@SpringBootTest
标注 - 编写测试方法:@Test标注(
注意需要使用junit5版本的@Test注解
) - JUnit类具有Spring的功能:
- @Autowired
- @Transactional:
标注测试方法,测试完成后自动回滚
02、JUnit5常用注解
JUnit官方文档地址:官网地址
JUnit5的注解与JUnit4的注解有所变化
@Test
:表示方法是测试方法。但是与JUnit4的@Test不同,它的职责非常单一不能声明任何属性,拓展的测试将会由Jupiter提供额外测试@ParameterizedTest
:表示方法是参数化测试@RepeatedTest
:表示方法可重复执行,例如:@RepeatedTest(5),测试方法执行5次@DisplayName
:为测试类或者测试方法设置展示名称@BeforeEach
:表示在每个单元测试之前执行@AfterEach
:表示在每个单元测试之后执行@BeforeAll
:表示在所有单元测试之前执行@AfterAll
:表示在所有单元测试之后执行@Tag
:表示单元测试类别,类似于JUnit4中的@Categories@Disabled
:表示测试类或测试方法不执行,类似于JUnit4中的@Ignore@Timeout
:表示测试方法运行如果超过了指定时间将会返回错误@ExtendWith
:为测试类或测试方法提供扩展类引用
03、断言(assertions)
断言(assertions):是测试方法中的核心部分,用来对测试需要满足的条件进行验证。这些断言方法都是 org.junit.jupiter.api.Assertions
类的静态方法
。
JUnit 5 内置的断言可以分成如下几个类别:
- 检查业务逻辑返回的数据是否合理。
- 所有的测试运行结束以后,会有一个详细的测试报告;
3.1、简单断言
用来对单个值进行简单的验证,如:
方法 | 说明 |
---|---|
assertEquals | 判断两个对象或两个原始类型是否相等 |
assertNotEquals | 判断两个对象或两个原始类型是否不相等 |
assertSame | 判断两个对象引用是否指向同一个对象 |
assertNotSame | 判断两个对象引用是否指向不同的对象 |
assertTrue | 判断给定的布尔值是否为 true |
assertFalse | 判断给定的布尔值是否为 false |
assertNull | 判断给定的对象引用是否为 null |
assertNotNull | 判断给定的对象引用是否不为 null |
//断言失败之后,后面的代码不执行
@Test
@DisplayName("simple assertion")
public void simple() {
//里面可以传字符串参数,作为断言失败之后的日志输出
assertEquals(3, 1 + 2, "simple math");
assertNotEquals(3, 1 + 1);
assertNotSame(new Object(), new Object());
Object obj = new Object();
assertSame(obj, obj);
assertFalse(1 > 2);
assertTrue(1 < 2);
assertNull(null);
assertNotNull(new Object());
}
3.2、数组断言
通过 assertArrayEquals 方法来判断两个对象或原始类型的数组是否相等
@Test
@DisplayName("array assertion")
public void array() {
assertArrayEquals(new int[]{1, 2}, new int[] {1, 2});
}
3.3、组合断言
assertAll 方法接受多个 org.junit.jupiter.api.Executable 函数式接口的实例作为要验证的断言,可以通过 lambda 表达式很容易的提供这些断言。
组合断言:当里面的所有方法成功,才算成功
@Test
@DisplayName("assert all")
public void all() {
assertAll("Math",
() -> assertEquals(2, 1 + 1),
() -> assertTrue(1 > 0)
);
}
3.4、异常断言
在JUnit4时期,想要测试方法的异常情况时,需要用@Rule注解的ExpectedException变量还是比较麻烦的。而JUnit5提供了一种新的断言方式Assertions.assertThrows() ,配合函数式编程就可以进行使用。
@Test
@DisplayName("异常测试")
public void exceptionTest() {
ArithmeticException exception = Assertions.assertThrows(
//扔出断言异常
ArithmeticException.class, () -> System.out.println(1 % 0));
}
3.5、超时断言
Junit5还提供了Assertions.assertTimeout() 为测试方法设置了超时时间
@Test
@DisplayName("超时测试")
public void timeoutTest() {
//如果测试方法时间超过1s将会异常
Assertions.assertTimeout(Duration.ofMillis(1000), () -> Thread.sleep(500));
}
3.6、快速失败
通过 fail 方法直接使得测试失败
当我们不希望方法返回某个结果,如果返回了某个结果就断言失败。
@Test
@DisplayName("fail")
public void shouldFail() {
fail("This should fail");
}
04、前置条件(assumptions)
JUnit 5 中的前置条件(assumptions【假设】)类似于断言,不同之处在于
- 不满足的断言会使得测试方法失败
- 不满足的前置条件只会使得测试方法的执行终止
前置条件可以看成是测试方法执行的前提,当该前提不满足时,就没有继续执行的必要。
@DisplayName("前置条件")
public class AssumptionsTest {
private final String environment = "DEV";
@Test
@DisplayName("simple")
public void simpleAssumeTrue() {
//结果为true,执行下面的输出,不为true,执行后面的字符串输出
Assumptions.assumeTrue(true,"结果不是true");
System.out.println("为True才输出");
}
@Test
@DisplayName("simple")
public void simpleAssumeFalse() {
//结果为false,执行下面的输出,不为false,执行后面的字符串输出
Assumptions.assumeFalse(false,"结果不是false");
System.out.println("为false才输出");
}
@Test
@DisplayName("assume then do")
public void assumeThenDo() {
Assumptions.assumingThat(
Objects.equals(this.environment, "DEV"),
() -> System.out.println("In DEV")
);
}
}
assumeTrue 和 assumFalse 确保给定的条件为 true 或 false,不满足条件会使得测试执行终止
,后面的代码不会执行。
assumingThat 的参数是表示条件的布尔值和对应的 Executable 接口的实现对象。只有条件满足时,Executable 对象才会被执行
;当条件不满足时,测试执行并不会终止
05、嵌套测试
JUnit 5 可以通过 Java 中的内部类
和@Nested 注解
实现嵌套测试,从而可以更好的把相关的测试方法组织在一起。在内部类中可以使用@BeforeEach
和@AfterEach
注解,而且嵌套的层次没有限制。
- 代码:
@DisplayName("嵌套测试")
public class TestingAStackDemo {
//创建一个栈
Stack<Object> stack;
@Test
@DisplayName("new Stack()")
void isInstantiatedWithNew() {
new Stack<>();
//嵌套测试情况下:外层的Test不能驱动内层的BeforeEach,AfterEach,AfterAll之类的方法
assertNull(stack);
}
//嵌套:第一层
@Nested
@DisplayName("when new")
class WhenNew {
@BeforeEach
void createNewStack() {
stack = new Stack<>();
}
@Test
@DisplayName("is empty")
void isEmpty() {
assertTrue(stack.isEmpty());
}
@Test
@DisplayName("throws EmptyStackException when popped")
void throwsExceptionWhenPopped() {
assertThrows(EmptyStackException.class, stack::pop);
}
@Test
@DisplayName("throws EmptyStackException when peeked")
void throwsExceptionWhenPeeked() {
assertThrows(EmptyStackException.class, stack::peek);
}
//嵌套:第二层
@Nested
@DisplayName("after pushing an element")
class AfterPushing {
String anElement = "an element";
@BeforeEach
void pushAnElement() {
stack.push(anElement);
}
//内层的Test能驱动外层的BeforeEach,AfterEach,AfterAll之类的方法
@Test
@DisplayName("it is no longer empty")
void isNotEmpty() {
assertFalse(stack.isEmpty());
}
@Test
@DisplayName("returns the element when popped and is empty")
void returnElementWhenPopped() {
assertEquals(anElement, stack.pop());
assertTrue(stack.isEmpty());
}
@Test
@DisplayName("returns the element when peeked but remains not empty")
void returnElementWhenPeeked() {
assertEquals(anElement, stack.peek());
assertFalse(stack.isEmpty());
}
}
}
}
- 运行结果:
06、参数化测试
参数化测试是JUnit5很重要的一个新特性,它使得用不同的参数多次运行测试成为了可能,也为我们的单元测试带来许多便利。
利用@ValueSource等注解,指定传入参数,我们将可以使用不同的参数进行多次单元测试,而不需要每新增一个参数就新增一个单元测试,省去了很多冗余代码。
@ValueSource
: 为参数化测试指定入参来源,支持八大基础类
以及String类
型,Class类
型@NullSource
: 表示为参数化测试提供一个null的入参@EnumSource
: 表示为参数化测试提供一个枚举入参@CsvFileSource
:表示读取指定CSV文件内容作为参数化测试入参@MethodSource
:表示读取指定方法的返回值作为参数化测试入参(注意方法返回需要是一个流
)
参数化测试真正强大之处在于他可以支持外部的各类入参,如:CSV,YML,JSON 文件甚至方法的返回值也可以作为入参。只需要去实现ArgumentsProvider接口,任何外部文件都可以作为它的入参。
- 代码:
//参数测试
@ParameterizedTest
//参数值为数组
@ValueSource(strings = {"one", "two", "three"})
@DisplayName("参数化测试1")
public void parameterizedTest1(String string) {
System.out.println(string);
Assertions.assertTrue(StringUtils.isNotBlank(string));
}
//参数测试
@ParameterizedTest
//提供参数的方法
@MethodSource("method")
@DisplayName("方法来源参数")
public void testWithExplicitLocalMethodSource(String name) {
System.out.println(name);
Assertions.assertNotNull(name);
}
static Stream<String> method() {
return Stream.of("apple", "banana");
}
- 运行结果:
07、迁移指南
JUnit5相对于JUnit4的变化如下,在进行迁移的时候需要注意:
- 注解在
org.junit.jupiter.api
包中 - 断言在
org.junit.jupiter.api.Assertions
类中 - 前置条件在
org.junit.jupiter.api.Assumptions
类中。 - 把
@Before
和@After
替换成@BeforeEach
和@AfterEach
- 把
@BeforeClass
和@AfterClass
替换成@BeforeAll
和@AfterAll
。 - 把
@Ignore
替换成@Disabled
。 - 把
@Category
替换成@Tag
。 - 把
@RunWith
、@Rule
和@ClassRule
替换成@ExtendWith
。