Spring Boot使用JUnit和Mockito进行Service层单元测试

文章目录

前言

  在平时的开发当中，一个项目往往包含了大量的方法，可能有成千上万个。如何去保证这些方法产生的结果是我们想要的呢？那么在SpringBoot项目中我们是如何对Service层的方法进行测试的呢？

一、单元测试是什么

  单元测试是一种软件测试方法，用于测试代码的最小可测试单元。在Java开发中，编写单元测试可以帮助开发人员更好地理解代码的功能和实现，同时也可以提高代码的质量和可维护性。

二、为什么要写单元测试

• 提高代码质量：编写单元测试可以帮助开发人员更好地理解代码的功能和实现，从而更容易发现代码中的问题和潜在的错误。
• 提高代码可维护性：单元测试可以帮助开发人员更好地理解代码的实现，从而更容易进行维护和修改。
• 提高开发效率：单元测试可以帮助开发人员更快地发现代码中的问题和潜在的错误，从而减少调试和修复问题的时间。
• 保证代码的正确性：单元测试可以帮助开发人员验证代码的正确性，从而确保代码的功能符合预期。
• 支持持续集成和持续交付：单元测试可以作为持续集成和持续交付流程的一部分，确保代码的质量和稳定性。

三、简单示例

假设我们有一个简单的UserService类，其中包含了一些用户相关的逻辑：

@ServicepublicclassUserService{privatefinalUserRepository userRepository;publicUserService(UserRepository userRepository){this.userRepository = userRepository;}publicUsercreateUser(User user){// 一些创建用户的逻辑return userRepository.save(user);}publicUsergetUserById(Long id){// 一些获取用户的逻辑return userRepository.findById(id).orElse(null);}}

我们的目标是编写UserService的单元测试。

首先，我们需要引入JUnit和Mockito的依赖。在Maven项目中，可以在pom.xml文件中添加以下依赖：

<dependencies><!-- 其他依赖 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency><dependency><groupId>org.mockito</groupId><artifactId>mockito-core</artifactId><scope>test</scope></dependency></dependencies>

接下来，我们可以编写UserService的单元测试：

@RunWith(MockitoJUnitRunner.class)publicclassUserServiceTest{@MockprivateUserRepository userRepository;@InjectMocksprivateUserService userService;@TestpublicvoidtestCreateUser(){User user =newUser();
        user.setId(1L);
        user.setUsername("John");
        user.setEmail("[email protected]");Mockito.when(userRepository.save(Mockito.any(User.class))).thenReturn(user);User createdUser = userService.createUser(user);assertNotNull(createdUser);assertEquals(1L, createdUser.getId().longValue());assertEquals("John", createdUser.getUsername());assertEquals("[email protected]", createdUser.getEmail());Mockito.verify(userRepository,Mockito.times(1)).save(Mockito.any(User.class));}@TestpublicvoidtestGetUserById(){User user =newUser();
        user.setId(1L);
        user.setUsername("John");
        user.setEmail("[email protected]");Mockito.when(userRepository.findById(1L)).thenReturn(Optional.of(user));User retrievedUser = userService.getUserById(1L);assertNotNull(retrievedUser);assertEquals(1L, retrievedUser.getId().longValue());assertEquals("John", retrievedUser.getUsername());assertEquals("[email protected]", retrievedUser.getEmail());Mockito.verify(userRepository,Mockito.times(1)).findById(1L);}}

解析：

• 在上述示例中，我们使用了Mockito的注解@Mock和@InjectMocks来创建UserService的Mock对象并注入到被测试的userService对象中。
• 在testCreateUser()方法中，我们使用Mockito的when()方法模拟了 userRepository的save()方法的行为，并返回预设的User对象。然后，我们调用userService的createUser()方法，并对返回的User对象进行断言验证。
• 在testGetUserById()方法中，我们使用Mockito的when()方法模拟了userRepository的findById()方法的行为，并返回预设的User对象。然后，我们调用userService的getUserById()方法，并对返回的User对象进行断言验证。
• 最后，我们使用Mockito的verify()方法来验证userRepository的方法是否被调用了指定的次数。

这是一个简单的Spring Boot Service层单元测试的示例。通过使用Mockito，我们可以模拟依赖对象的行为，使得单元测试更加可控和可靠。

总结

• 本文简单讲述了单元测试是什么、为什么要写单元测试和在SpringBoot项目中我们是如何编写Service层单元测试的以及做了一个简单示例
• 欢迎大家提出建议以及批评，有任何问题可以私信。