Spring Boot轻松搞定单元测试，码出优雅代码

2023-03-20 11:03:28

Spring Boot 单元测试的艺术：确保代码质量与稳定性的制胜秘诀

在软件开发的浩瀚世界中，单元测试犹如一艘航行在代码海洋中的灯塔，指引着开发者安全前行，确保代码的品质与稳定性。在 Spring Boot 中，单元测试同样不可或缺，它为我们提供了强大而全面的工具，让我们能够以更少的精力和时间编写出更可靠的代码。

解锁 Spring Boot 单元测试的秘密

要踏上 Spring Boot 单元测试的奇妙旅程，首先，需要在项目中添加单元测试依赖。只需在 pom.xml 文件中加入以下依赖即可：

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

探索不同层级的单元测试

Spring Boot 中的单元测试就像一个多层蛋糕，每个层级都有着独特的目的：

服务层单元测试：

这个层级的测试主要检查业务逻辑的正确性。你可以利用 Mock 或 Spy 对象来模拟真实对象的行为，从而专注于业务逻辑本身，而不受外部依赖的干扰。

示例代码：

// Mock 对象
@ExtendWith(MockitoExtension.class)
public class UserServiceTest {

  @Mock
  private UserRepository userRepository;

  @InjectMocks
  private UserService userService;

  @Test
  public void testFindUserById() {
    // 给定
    User user = new User();
    user.setId(1L);
    user.setName("John Doe");
    when(userRepository.findById(1L)).thenReturn(user);

    // 当
    User result = userService.findById(1L);

    // 然后
    assertEquals(user, result);
  }
}

// Spy 对象
@ExtendWith(MockitoExtension.class)
public class UserServiceTest {

  @Spy
  private UserRepository userRepository;

  @InjectMocks
  private UserService userService;

  @Test
  public void testUpdateUser() {
    // 给定
    User user = new User();
    user.setId(1L);
    user.setName("John Doe");
    doNothing().when(userRepository).save(user);

    // 当
    userService.updateUser(user);

    // 然后
    verify(userRepository, times(1)).save(user);
  }
}

控制层单元测试：

这个层级的测试主要检查控制器方法的正确性。借助 MockMvc 对象，你可以模拟 HTTP 请求，并测试控制器方法在不同输入下的响应。

示例代码：

@ExtendWith(SpringExtension.class)
@WebMvcTest(controllers = UserController.class)
public class UserControllerTest {

  @Autowired
  private MockMvc mockMvc;

  @Test
  public void testGetUserById() throws Exception {
    // 给定
    User user = new User();
    user.setId(1L);
    user.setName("John Doe");

    // 当
    MvcResult result = mockMvc.perform(get("/users/1")).andExpect(status().isOk()).andReturn();

    // 然后
    String content = result.getResponse().getContentAsString();
    assertEquals(user.getName(), content);
  }
}

持久层单元测试：

这个层级的测试主要检查数据库操作的正确性。你可以使用嵌入式数据库或内存数据库来模拟真实数据库，从而验证持久层方法的可靠性。

示例代码：

@ExtendWith(SpringExtension.class)
@DataJpaTest
public class UserRepositoryTest {

  @Autowired
  private UserRepository userRepository;

  @Test
  public void testFindUserById() {
    // 给定
    User user = new User();
    user.setId(1L);
    user.setName("John Doe");
    userRepository.save(user);

    // 当
    User result = userRepository.findById(1L).get();

    // 然后
    assertEquals(user, result);
  }
}

Mock 对象与 Spy 对象：灵活多变的模拟工具

Mock 对象和 Spy 对象是单元测试中不可或缺的工具，它们能够模拟真实对象的行为，帮助开发者隔离测试环境，专注于业务逻辑的验证。

Mock 对象： 顾名思义，Mock 对象可以模拟任何对象的行为，你可以完全控制它的行为，返回预期的值或抛出指定的异常。

Spy 对象： Spy 对象则可以部分模拟真实对象的行为，除了可以修改对象的方法行为外，还可以监视真实对象的方法调用。

每种类型单元测试的精彩示例

为了进一步阐释不同层级的单元测试，这里提供几个更详细的示例：

服务层单元测试：

@ExtendWith(MockitoExtension.class)
public class UserServiceTest {

  @Mock
  private UserRepository userRepository;
  @Mock
  private EmailService emailService;

  @InjectMocks
  private UserService userService;

  @Test
  public void testRegisterUser() {
    // 给定
    User user = new User();
    user.setUsername("johndoe");
    user.setPassword("password");
    when(userRepository.save(user)).thenReturn(user);

    // 当
    userService.registerUser(user);

    // 然后
    verify(userRepository, times(1)).save(user);
    verify(emailService, times(1)).sendRegistrationEmail(user);
  }
}

控制层单元测试：

@ExtendWith(SpringExtension.class)
@WebMvcTest(controllers = ProductController.class)
public class ProductControllerTest {

  @Autowired
  private MockMvc mockMvc;

  @Test
  public void testGetProductById() throws Exception {
    // 给定
    Product product = new Product();
    product.setId(1L);
    product.setName("iPhone 14");

    // 当
    MvcResult result = mockMvc.perform(get("/products/1")).andExpect(status().isOk()).andReturn();

    // 然后
    String content = result.getResponse().getContentAsString();
    assertEquals(product.getName(), content);
  }
}

持久层单元测试：

@ExtendWith(SpringExtension.class)
@DataJpaTest
public class UserRepositoryTest {

  @Autowired
  private UserRepository userRepository;

  @Test
  public void testFindByUsername() {
    // 给定
    User user = new User();
    user.setUsername("johndoe");
    user.setPassword("password");
    userRepository.save(user);

    // 当
    User result = userRepository.findByUsername("johndoe").get();

    // 然后
    assertEquals(user, result);
  }
}