单元测试就是针对最小的功能单元编写测试代码。Java程序最小的功能单元是方法,因此,对Java程序进行单元测试就是针对单个Java方法的测试。
例子:
下面的代码就是在静态方法Factorial 中根据传入的n值计算n阶乘的值:
public class Factorial {
public static long fact(long n) {
long r = 1;
for (long i = 1; i <= n; i++) {
r = r * i;
}
return r;
}
}
要测试这个方法,一个很自然的想法是编写一个main()方法,然后运行一些测试代码:
public class Test {
public static void main(String[] args) {
if (fact(10) == 3628800) {
System.out.println("pass");
} else {
System.out.println("fail");
}
}
}
运行效果:
不过,使用main()方法测试有很多缺点:
因此,我们需要一种测试框架,帮助我们编写测试。
JUnit是一个开源的Java语言的单元测试框架,专门针对Java设计,使用最广泛,Spring Boot 2.2.0 版本开始引入 JUnit 5 作为单元测试默认库单元测试(unit testing),是指对软件中的最小可测试单元进行检查和验证。
Junit5的操作非常简单,具体操作如下:
导入Junit5的依赖
如果是Sring Boot项目的话就无需导入了,因为SpringBoot中的test依赖中有Junit5的依赖
Maven中导入以下依赖:
<dependency>
<groupId>org.junit.jupitergroupId>
<artifactId>junit-jupiter-engineartifactId>
<version>5.5.2version>
dependency>
<dependency>
<groupId>org.junit.platformgroupId>
<artifactId>junit-platform-runnerartifactId>
<version>1.5.2version>
dependency>
<dependency>
<groupId>org.junit.jupitergroupId>
<artifactId>junit-jupiter-paramsartifactId>
<version>5.6.2version>
dependency>
上面的依赖说明:
备注:更多依赖的解释可以通过这篇博文了解到:Junit5系列-什么是Junit5?
一键生成测试类以及对应方法的测试代码:
点击OK后就会在相应的test目录下生成对应的测试类和测试方法:
在face中编写测试代码即可:
运行测试方法,可以直接点击测试方法旁的绿色按钮,点击Run fact()
或者点击类旁的绿色箭头,点击Run JunitTest…
备注:运行方式1是运行对应方法的测试代码,运行方式2是运行类里的所有测试方法!
在运行的几种方式中有一种方式可以查看当前代码的覆盖率( 这种方式有助于我们更优的进行测试
):
运行后就可以查看相应的覆盖率情况:
详细的注解你可以通过官方了解,https://junit.org/junit5/docs/current/user-guide/#writing-tests-annotations
注解 | 解释 |
---|---|
@Test | 表示方法是测试方法 |
@ParameterizedTest | 表示方法是参数化测试 |
@RepeatedTest | 表示方法可重复执行 |
@DisplayName | 为测试类或者测试方法设置展示名称 |
@BeforeEach | 表示在每个单元测试之前执行 |
@AfterEach | 表示在每个单元测试之后执行 |
@BeforeAll | 表示在所有单元测试之前执行 |
@AfterAll | 表示在所有单元测试之后执行 |
@Tag | 表示单元测试类别,类似于JUnit4中的@Categories |
@Disabled | 表示测试类或测试方法不执行,类似于JUnit4中的@Ignore |
@Timeout | 表示测试方法运行如果超过了指定时间将会返回错误 |
@ExtendWith | 为测试类或测试方法提供扩展类引用 |
例子:
import org.junit.jupiter.api.*;
@TestInstance(TestInstance.Lifecycle.PER_CLASS)
class JunitTestTest {
@BeforeAll
public void initDB() {
System.out.println("正在创建数据库");
}
@BeforeEach
public void initData() {
System.out.println("正在初始化Test表数据");
}
@Test
@DisplayName("第一次测试")
public void firstTest() {
System.out.println("第一个测试案例!");
}
@Test
@DisplayName("第二次测试")
public void secondTest() {
System.out.println("第二个测试案例!");
}
@AfterEach
public void destoryData() {
System.out.println("正在销毁Test表数据");
}
@AfterAll
public void destroyDB() {
System.out.println("正在销毁数据库");
}
}
运行类测试:
注解说明:
备注:使用以上注解需要使用 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
注解。
通过 @ParameterizedTest参数化测试可以实现一次性执行多次不同参数的测试用例:
@ParameterizedTest
@ValueSource(strings = {"ONE","TWO","THREE"})
public void ParameterizedTest(String str) {
if (str.equals("ONE")){
System.out.println("ONE");
}
else if (str.equals("TWO") ){
System.out.println("TWO");
}
else if (str.equals("THREE")){
System.out.println("THREE");
}
}
运行效果:
如果测试方法加上@Disabled注解表示该注解不不执行,如下:
再次运行( 确实没有运行
):
上面采用的是定好的参数,也可以使用动态参数,如下:
参数化使用@ParameterizedTest注解,动态传参使用@MethodSource(“getStr”)注解指向一个静态的getStr()方法,就可以实现动态传参了。
运行效果:
通过@RepeatedTest注解可重复执行多次当前测试用例,如下:
对于该注解的其他参数,你可以通过这篇博文了解到:JUnit5 @RepeatedTest注解示例
断言(assertions)是测试方法中的核心部分,用来对测试需要满足的条件进行验证。这些断言方法都是 org.junit.jupiter.api.Assertions 的静态方法。JUnit 5 内置的断言可以分成如下几个类别:检查业务逻辑返回的数据是否合理。所有的测试运行结束以后,会有一个详细的测试报告;
简单断言
用来对单个值进行简单的验证。如:
断言方法 | 解释 |
---|---|
assertEquals | 判断两个对象或两个原始类型是否相等 |
assertNotEquals | 判断两个对象或两个原始类型是否不相等 |
assertSame | 判断两个对象引用是否指向同一个对象 |
assertNotSame | 判断两个对象引用是否指向不同的对象 |
assertTrue | 判断给定的布尔值是否为 true |
assertFalse | 判断给定的布尔值是否为 false |
assertNull | 判断给定的对象引用是否为 null |
assertNotNull | 判断给定的对象引用是否不为 null |
assertThrows | 判定调用某方法是否触发该异常 |
练习代码如下:
运行效果:
测试代码:
运行效果:
如果测试条件不满足就会打印出异常信息
测试异常Assertions.assertThrows:
assertThrows的第一个参数为预期异常,第二个为当执行testClass.getUser(null);触发
运行效果: