【单元测试】一文读懂java单元测试

1. 什么是单元测试
2. 为什么要单元测试
3. 单元测试框架 - JUnit
- 3.1 JUnit 简介
- 3.2 JUnit 内容
- 3.3 JUnit 使用
- - 3.3.1 Controller 层单元测试
  - 3.3.2 Service 层单元测试
  - 3.3.3 Dao 层单元测试
  - 3.3.4 异常测试
  - 3.3.5 测试套件测多个类
  - 3.3.6 idea 中查看单元测试覆盖率
  - 3.3.7 JUnit 插件自动生成单测代码
  - 3.3.8 常用注解和配置

1. 什么是单元测试

单元测试是软件开发中常用的一种测试方法，用于验证代码的单个功能单元是否按照预期工作。
测试方法：

白盒测试（White Box Testing）：在白盒测试中，测试人员了解代码的内部结构和实现细节，编写测试用例来覆盖不同的代码路径和逻辑条件。
黑盒测试（Black Box Testing）：黑盒测试不考虑代码的内部实现，而是基于需求规格说明或功能规范编写测试用例，测试程序的输入和输出是否符合预期。
单元测试框架：使用单元测试框架可以简化单元测试的编写和执行。常见的单元测试框架包括JUnit（Java）、NUnit（.NET）、pytest（Python）等。
断言（Assertion）：在单元测试中，断言用于检查预期结果和实际结果是否匹配。测试人员可以使用断言来验证程序的特定行为和结果。
边界值测试（Boundary Value Testing）：边界值测试通过选择测试用例中的边界条件，例如最小值、最大值、临界值等，来验证程序在边界情况下的行为。
异常处理测试（Exception Handling Testing）：异常处理测试用于验证程序在遇到异常情况时是否能够正确地捕获和处理异常，并保证系统的稳定性和可靠性。
参数化测试（Parameterized Testing）：参数化测试允许在单个测试用例中使用不同的参数进行多次测试，以增加测试覆盖率和复用性。
这些方法都可以根据具体的需求和开发环境选择使用。单元测试的目标是尽可能地覆盖代码，确保每个单元都能按照预期工作，并提高软件的质量和可维护性。

这些方法都可以根据具体的需求和开发环境选择使用。单元测试的目标是尽可能地覆盖代码，确保每个单元都能按照预期工作，并提高软件的质量和可维护性。

2. 为什么要单元测试

（1）单元测试意义：

程序代码都是由基本单元不断组合成复杂的系统，底层基本单元都无法保证输入输出正确性，层级递增时，问题就会不断放大，直到整个系统崩溃无法使用。所以单元测试的意义就在于保证基本功能是正常可用且稳定的。而对于接口、数据源等原因造成的不稳定因素，是外在原因，不在单元测试考虑范围之内。

（2）使用 main 方法进行测试：

@PostMapping("/add")
public void addStudent(@RequestBody Student student){
    studentService.save(student);
}

假如要对上面的 Controller 进行测试，可以编写如下的代码示例，使用 main 方法进行测试的时候，先启动整个工程应用，然后编写 main 方法如下进行访问，在单步调试代码。

public static void main(String[] args) {
    RestTemplate restTemplate = new RestTemplate();
    HttpHeaders httpHeaders = new HttpHeaders();
    httpHeaders.setContentType(MediaType.APPLICATION_JSON);
    String json = "{\"id\":4,\"name\":\"阿狸\",\"classname\":\"初三一班\",\"age\":16,\"sex\":\"女\"}";
    HttpEntity<String> httpEntity = new HttpEntity<>(json, httpHeaders);
    String url = "http://localhost:8080/student/add";
    ResponseEntity<Map> responseEntity = restTemplate.postForEntity(url, httpEntity, Map.class);
    System.out.println(responseEntity.getBody());
}

（3）使用 main 方法进行测试的缺点：

通过编写大量的 main 方法针对每个内容做打印输出到控制台枯燥繁琐，不具备优雅性。
测试方法不能一起运行，结果需要程序员自己判断正确性。
统一且重复性工作应该交给工具去完成。

3. 单元测试框架 - JUnit

3.1 JUnit 简介

Unit 官网：https://junit.org/。JUnit 是一个用于编写可重复测试的简单框架。它是用于单元测试框架的 xUnit 体系结构的一个实例。

JUnit 的特点：

（1）针对于 Java 语言特定设计的单元测试框架，使用非常广泛。

（2）特定领域的标准测试框架。

（3）能够在多种 IDE 开发平台使用，包含 Idea、Eclipse 中进行集成。

（4）能够方便由 Maven 引入使用。

（5）可以方便的编写单元测试代码，查看测试结果等。

JUnit 的重要概念：

名称	功能作用
Assert	断言方法集合
TestCase	表示一个测试案例
TestSuite	包含一组 TestCase，构成一组测试
TestResult	收集测试结果

JUnit 的一些注意事项及规范：

（1）测试方法必须使用 @Test 修饰

（2）测试方法必须使用 public void 进行修饰，不能带参数

（3）测试代码的包应该和被测试代码包结构保持一致

（4）测试单元中的每个方法必须可以独立测试，方法间不能有任何依赖

（5）测试类一般使用 Test 作为类名的后缀

（6）测试方法使一般用 test 作为方法名的前缀

JUnit 失败结果说明：

（1） Failure：测试结果和预期结果不一致导致，表示测试不通过

（2） error：由异常代码引起，它可以产生于测试代码本身的错误，也可以是被测代码的 Bug

3.2 JUnit 内容

（1）断言的 API

断言方法	断言描述
assertNull(String message, Object object)	检查对象是否为空，不为空报错
assertNotNull(String message, Object object)	检查对象是否不为空，为空报错
assertEquals(String message, Object expected, Object actual)	检查对象值是否相等，不相等报错
assertTrue(String message, boolean condition)	检查条件是否为真，不为真报错
assertFalse(String message, boolean condition)	检查条件是否为假，为真报错
assertSame(String message, Object expected, Object actual)	检查对象引用是否相等，不相等报错
assertNotSame(String message, Object unexpected, Object actual)	检查对象引用是否不等，相等报错
assertArrayEquals(String message, Object[] expecteds, Object[] actuals)	检查数组值是否相等，遍历比较，不相等报错
assertArrayEquals(String message, Object[] expecteds, Object[] actuals)	检查数组值是否相等，遍历比较，不相等报错
assertThat(String reason, T actual, Matcher<? super T> matcher)	检查对象是否满足给定规则，不满足报错

（2） JUnit 常用注解：

1） @Test: 定义一个测试方法 @Test (excepted=xx.class): xx.class 表示异常类，表示测试的方法抛出此异常时，认为是正常的测试通过的 @Test (timeout = 毫秒数) : 测试方法执行时间是否符合预期。

2） @BeforeClass： 在所有的方法执行前被执行，static 方法全局只会执行一次，而且第一个运行。

3） @AfterClass：在所有的方法执行之后进行执行，static 方法全局只会执行一次，最后一个运行。

4） @Before：在每一个测试方法被运行前执行一次。

5） @After：在每一个测试方法运行后被执行一次。

6） @Ignore：所修饰的测试方法会被测试运行器忽略。

7） @RunWith：可以更改测试执行器使用 junit 测试执行器。

3.3 JUnit 使用

3.3.1 Controller 层单元测试

（1） Springboot 中使用 maven 引入 Junit 非常简单，使用如下依赖即可引入：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>

<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.13.1</version>
    <scope>test</scope>
</dependency>

（2）上面使用 main 方法案例可以使用如下的 Junit 代码完成：

@RunWith(SpringRunner.class)
@SpringBootTest(classes = UnittestDemoApplication.class)
class StudentControllerTest {

    @Autowired
    private WebApplicationContext webApplicationContext;

    private MockMvc mockMvc;

    @BeforeEach
    void setUp() {
        mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();
    }

    @Test
    void testAddStudent() throws Exception {
        // 创建一个Student对象作为请求的JSON体
        Student student = new Student();
        student.setId(6);
        student.setName("小乔");
        student.setClassname("初二三班");
        student.setAge(14);
        student.setSex("女");

        // 将Student对象转换为JSON字符串
        ObjectMapper objectMapper = new ObjectMapper();
        String json = objectMapper.writeValueAsString(student);

        // 发送POST请求
        mockMvc.perform(MockMvcRequestBuilders.post("/student/add")
                        .contentType(MediaType.APPLICATION_JSON_UTF8)
                        .accept(MediaType.APPLICATION_JSON_UTF8)
                        .content(json)
                )
                // 断言返回的状态码为200
                .andExpect(MockMvcResultMatchers.status().isOk())
                // 断言返回的JSON中包含指定的code和message
                .andExpect(MockMvcResultMatchers.jsonPath("$.code").value(200))
                .andExpect(MockMvcResultMatchers.jsonPath("$.message").value("保存成功"))
                .andDo(MockMvcResultHandlers.print());
    }
}

只需要在类或者指定方法上右键执行即可，可以直接充当 postman 工作访问指定 url，且不需要写请求代码，这些都由工具自动完成。

在这里插入图片描述

（3）案例中相关组件介绍

本案例中构造 mockMVC 对象时，也可以使用如下方式：

@Autowired
private StudentController studentController;
@Before
public void setupMockMvc(){
   // 初始化MockMvc对象
   mockMvc = MockMvcBuilders.standaloneSetup(studentController).build();
}

其中 MockMVC 是 Spring 测试框架提供的用于 REST 请求的工具，是对 Http 请求的模拟，无需启动整个模块就可以对 Controller 层进行调用，速度快且不依赖网络环境。

使用 MockMVC 的基本步骤如下：

mockMvc.perform 执行请求
MockMvcRequestBuilders.post 或 get 构造请求
MockHttpServletRequestBuilder.param 或 content 添加请求参数
MockMvcRequestBuilders.contentType 添加请求类型
MockMvcRequestBuilders.accept 添加响应类型
ResultActions.andExpect 添加结果断言
ResultActions.andDo 添加返回结果后置处理
ResultActions.andReturn 执行完成后返回相应结果

3.3.2 Service 层单元测试

可以编写如下代码对 Service 层查询方法进行单测：

正例：

@RunWith(SpringRunner.class)
@SpringBootTest
public class StudentServiceTest {
 
	@Autowired
    private StudentService studentService;
 
    @Test
    public void getOne(){
        Student stu = studentService.getById(1);
        Assert.assertThat(stu.getName(), CoreMatchers.is("张三"));
    }
}

执行结果：

在这里插入图片描述

反例：

@RunWith(SpringRunner.class)
@SpringBootTest
public class StudentServiceTest {
 
	@Autowired
    private StudentService studentService;
 
    @Test
    public void getOne(){
        Student stu = studentService.getById(1);
        Assert.assertThat(stu.getName(), CoreMatchers.is("李四"));
    }
}

执行结果：

在这里插入图片描述

3.3.3 Dao 层单元测试

可以编写如下代码对 Dao 层保存方法进行单测：

@RunWith(SpringRunner.class)
@SpringBootTest
public class StudentDaoTest {
 
	@Autowired
    private StudentMapper studentMapper;
 
    @Test
    @Rollback(value = true)
    @Transactional
    public void insertOne() throws Exception {
   	    Student student = new Student();
        student.setId(7);
        student.setName("王五");
        student.setClassname("大一");
        student.setAge(20);
        student.setSex("男");
        int count = studentMapper.insert(student);
        Assert.assertEquals(1, count);
    }
}

在这里插入图片描述
其中 @Rollback (value = true) 可以执行单元测试之后回滚所新增的数据，保持数据库不产生脏数据。

3.3.4 异常测试

（1）在 service 层定义一个异常情况：

public void computeScore() {
   int a = 10, b = 0;
   int c = a/b;
}

（2）在 service 的测试类中定义单元测试方法：

反例

    @Test
    public void computeScoreTest() {
        studentService.computeScore();
    }

结果：

在这里插入图片描述

正例：

junit 5.0版本之前，在@Test上添加expected = ArithmeticException.class

@Test(expected = ArithmeticException.class)
    public void computeScoreTest() {
        studentService.computeScore();
    }

junit 5.0版本之后，使用Assert.assertThrows

@Test
public void computeScoreTest() {
    Assert.assertThrows(ArithmeticException.class, () -> {
        studentService.computeScore(); // This line should throw ArithmeticException
    });
}