SpringBoot实战（三十六）编写单元测试

一、什么是单元测试？

单元测试 是指对软件中的最小可测试单元进行检查和验证。在 Java 中，单元测试的最小单元是类。通过编写针对类或方法的小段代码，来检验被测代码是否符合预期结果或行为。

执行单元测试可以帮助开发者验证代码是否正确实现了功能需求，以及是否能够适应应用环境或需求变化。

---

二、Spring Boot 中的单元测试依赖

在 Spring Boot 项目中，要进行单元测试，首先需要添加相应的依赖。Maven 依赖如下：

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

这个依赖包含了多个库和功能，主要有以下几个：

• JUnit：JUnit 是 Java 中最流行和最常用的单元测试框架，它提供了一套 注解 和 断言 来编写和运行单元测试。例如 @Test 注解表示一个测试方法，assertEquals 断言表示两个值是否相等。
• Spring Test：Spring Test 是一个基于 Spring 的测试框架，它提供了一套注解和工具来配置和管理 Spring 上下文和 Bean。例如 @SpringBootTest 注解表示一个集成测试类，@Autowired 注解表示自动注入一个 Bean。
• Mockito：Mockito 是一个 Java 中最流行和最强大的 Mock 对象库，它可以模仿复杂的真实对象行为，从而简化测试过程。例如 @MockBean 注解表示创建一个 Mock 对象，when 方法表示定义 Mock 对象的行为。
• Hamcrest：Hamcrest 是一个 Java 中的匹配器库，它提供了一套语义丰富而易读的匹配器来进行结果验证。例如 asserThat 断言表示验证一个值是否满足一个匹配器，is 匹配器表示两个值是否相等。
• AssertJ：AssertJ 是一个 Java 中的断言库，它提供了一套流畅而直观的断言语法来进行结果验证。例如 assertThat 断言表示验证一个值是否满足一个条件，isEqualTo 断言表示两个值是否相等。

除了以上这些库外，spring-boot-starter-test 还包含了其他一些库和功能，如 JsonPath、JsonAssert、XmlUnit 等。这些库和功能可以根据不同的测试场景进行选择和使用。

---

三、举例 Spring Boot 中不同层次的单元测试

如果是通过spring initialize创建的springboot项目（本系列第一篇文章有讲解），其实会自动创建一个单元测试类：

我们在写单元测试的时候，直接继承这个类即可。

3.1 Service层

在 Spring Boot 中，对 Service 层进行单元测试，可以使用 @SpringBootTest 注解来加载完整的 Spring 上下文，从而可以自动注入 Service 层的 Bean。同时，可以使用 @MockBean 注解来创建和注入其他层次的 Mock 对象，从而避免真实地调用其他层次的方法，而是模拟其行为。

例如，假设有一个 UserService 类，它提供了一个根据用户 ID 查询用户信息的方法：

@Service
public class UserService {
   
   

    @Autowired
    private UserRepository userRepository;
    
    public User getUserById(Long id) {
   
   
        return userRepository.findById(id).orElse(null);
    }
}

要对这个类进行单元测试，可以编写以下测试类：

@SpringBootTest
public class UserServiceTest {
   
   
    
    @Autowired
    private UserService userService;
    
    @MockBean
    private UserRepository userRepository;
    
    @Test
    public void testGetUserById() {
   
   
        // 创建一个User对象
        User user = new User();
        user.setId(1L);
        user.setName("ACGkaka");
        user.setEmail("acgkaka@example.com");
        
        // 当调用userRepository.findById(1L)时，返回一个包含user对象的Optional对象
        when(userRepository.findById(1L)).thenReturn(Optional.of(user));
        
        // 调用userService.getUserId()方法，传入1L作为参数，得到一个User对象。
        User result = userService.getUserById(1L);
        
        // 验证结果对象与user对象相等
        assertThat(result).isEqualTo(user);
        
        // 验证userRepository.findById(1L)方法被调用了一次
        verify(userRepository, times