# 使用 Mockito 进行单元测试服务层 ## 概述该技能提供了使用 Mockito 对 @Service 类进行单元测试的模式。它涵盖模拟所有注入的依赖项、验证业务逻辑、测试复杂的工作流程、参数捕获、验证模式以及在不启动 Spring 容器的情况下测试异步/反应式服务。 ## 何时使用在以下情况下使用此技能： * 在@Service类中测试业务逻辑 * 模拟存储库和外部客户端依赖项 * 验证与模拟协作者的服务交互 * 测试复杂的工作流程和编排逻辑 * 想要快速、独立的单元测试（没有数据库，没有 API 调用） * 测试服务中的错误处理和边缘情况 ## 说明请按照以下步骤使用 Mockito 测试服务层： ### 1\.添加测试依赖项在测试类路径中包含 JUnit 5、Mockito 和 AssertJ。 ### 2\.使用 Mockito 扩展创建测试类使用 @ExtendWith(MockitoExtension.class) 启用 Mockito 注释。 ### 3\.声明模拟和测试中的服务使用 @Mock 表示依赖项，使用 @InjectMocks 表示正在测试的服务。 ### 4\.整理测试数据使用when().thenReturn() 创建测试数据对象并配置模拟返回值。 ### 5\.执行服务方法使用测试输入调用正在测试的服务方法。 ### 6\.断言结果使用 AssertJ 断言验证返回值并验证模拟交互。 ### 7\.测试异常场景配置模拟以引发异常并验证错误处理。 ## 示例 ## 使用 Mockito 和 JUnit 5 设置 ### Maven <依赖关系> org.junit.jupiter junit-jupiter <范围>测试 <依赖关系> org.mockito mockito-core <范围>测试 <依赖关系> org.mockito mockito-junit-jupiter <范围>测试 <依赖关系> org.assertj assertj-core <范围>测试 ### 摇篮依赖项{ testImplementation("org.junit.jupiter:junit-jupiter") testImplementation("org.mockito:mockito-core") testImplementation("org.mockito:mockito-junit-jupiter") testImplementation("org.assertj:assertj-core") } ## 基本模式：具有模拟依赖关系的服务 ### 单一依赖导入 org.junit.jupiter.api.Test; 导入 org.junit.jupiter.api.extension.ExtendWith; 导入 org.mockito.InjectMocks; 导入 org.mockito.Mock; 导入 org.mockito.junit.jupiter.MockitoExtension; 导入静态 org.mockito.Mockito.*; 导入静态 org.assertj.core.api.Assertions.*; @ExtendWith(MockitoExtension.class) 类 UserServiceTest { @模拟私有 UserRepository 用户存储库； @InjectMocks 私有 UserService 用户服务； @测试无效shouldReturnAllUsers() { // 排列列表 <用户> 预期用户 = List.of( 新用户（1L，“爱丽丝”），新用户（2L，“鲍勃”））； when(userRepository.findAll()).thenReturn(expectedUsers); // 行动 List 结果 = userService.getAllUsers(); // 断言 assertThat(结果).hasSize(2); assertThat(结果).containsExactly( 新用户（1L，“爱丽丝”），新用户（2L，“鲍勃”））；验证(userRepository, times(1)).findAll(); } } ### 多重依赖 @ExtendWith(MockitoExtension.class) 类 UserEnrichmentServiceTest { @模拟私有 UserRepository 用户存储库； @模拟私人电子邮件服务电子邮件服务； @模拟私人分析客户分析客户； @InjectMocks 私有 UserEnrichmentService 丰富服务； @测试无效shouldCreateUserAndSendWelcomeEmail（）{ 用户 newUser = 新用户(1L, "Alice", "alice@example.com"); when(userRepository.save(any(User.class))).thenReturn(newUser); doNothing().when(emailService).sendWelcomeEmail(newUser.getEmail()); 用户结果 =richmentService.registerNewUser("Alice", "alice@example.com"); assertThat(result.getId()).isEqualTo(1L); assertThat(result.getName()).isEqualTo("Alice"); 验证(userRepository).save(any(User.class)); 验证（emailService）.sendWelcomeEmail（“alice@example.com”）；验证(analyticsClient, never()).trackUserRegistration(any()); } } ## 测试异常处理 ### 服务抛出预期异常 @测试无效 shouldThrowExceptionWhenUserNotFound() { 当（userRepository.findById（999L）） .thenThrow(new UserNotFoundException("未找到用户")); assertThatThrownBy(() -> userService.getUserDetails(999L)) .isInstanceOf(UserNotFoundException.class) .hasMessageContaining("未找到用户"); 验证(userRepository).findById(999L); } @测试无效shouldRethrowRepositoryException（）{ 当（userRepository.findAll（）） .thenThrow(new DataAccessException("数据库连接失败")); assertThatThrownBy(() -> userService.getAllUsers()) .isInstanceOf(DataAccessException.class) .hasMessageContaining("数据库连接失败"); } ## 测试复杂的工作流程 ### 多个服务方法调用 @测试无效shouldTransferMoneyBetweenAccounts（）{ 账户 fromAccount = 新账户(1L, 1000.0); 账户 toAccount = 新账户(2L, 500.0); when(accountRepository.findById(1L)).thenReturn(Optional.of(fromAccount)); when(accountRepository.findById(2L)).thenReturn(Optional.of(toAccount)); 当（accountRepository.save（任何（Account.class））） .thenAnswer(调用 -> incalling.getArgument(0)); MoneyTransferService.transfer(1L, 2L, 200.0); // 验证两个帐户均已更新验证(accountRepository, times(2)).save(any(Account.class)); assertThat(fromAccount.getBalance()).isEqualTo(800.0); assertThat(toAccount.getBalance()).isEqualTo(700.0); } ## 参数捕获和验证 ### 捕获传递给 Mock 的参数导入 org.mockito.ArgumentCaptor; @测试无效shouldCaptureUserDataWhenSaving（）{ ArgumentCaptor<用户> userCaptor = ArgumentCaptor.forClass(User.class); 当（userRepository.save（任何（User.class））） .thenAnswer(调用 -> incalling.getArgument(0)); userService.createUser("Alice", "alice@example.com"); 验证(userRepository).save(userCaptor.capture()); 用户捕获的用户 = userCaptor.getValue(); assertThat(capturedUser.getName()).isEqualTo("Alice"); assertThat(capturedUser.getEmail()).isEqualTo(“alice@example.com”); } @测试无效shouldCaptureMultipleArgumentsAcrossMultipleCalls（）{ ArgumentCaptor<用户> userCaptor = ArgumentCaptor.forClass(User.class); userService.createUser("Alice", "alice@example.com"); userService.createUser("Bob", "bob@example.com"); 验证(userRepository, times(2)).save(userCaptor.capture()); List captureUsers = userCaptor.getAllValues(); assertThat(capturedUsers).hasSize(2); assertThat(capturedUsers.get(0).getName()).isEqualTo("Alice"); assertThat(capturedUsers.get(1).getName()).isEqualTo("Bob"); } ## 验证模式 ### 验证通话顺序和频率导入 org.mockito.InOrder; @测试无效shouldCallMethodsInCorrectOrder（）{ InOrder inOrder = inOrder(userRepository, emailService); userService.registerNewUser("Alice", "alice@example.com"); inOrder.verify(userRepository).save(any(User.class)); inOrder.verify(emailService).sendWelcomeEmail(any()); } @测试无效shouldCallMethodExactlyOnce() { userService.getUserDetails(1L); 验证(userRepository, times(1)).findById(1L); 验证(userRepository, never()).findAll(); } ## 测试异步/反应式服务 ### CompletableFuture 服务 @测试无效shouldReturnCompletableFutureWhenFetchingAsyncData（）{ List users = List.of(new User(1L, "Alice")); 当（userRepository.findAllAsync（）） .thenReturn(CompletableFuture.completedFuture(用户)); CompletableFuture> 结果 = userService.getAllUsersAsync(); assertThat(结果).isCompletedWithValue(用户); } ## 示例 ### 输入：没有测试覆盖率的服务 @服务公共类用户服务{ 私有最终 UserRepository userRepository；公共用户 getUser(长 id) { return userRepository.findById(id).orElse(null); } } ### 输出：具有完整测试覆盖率的服务 @ExtendWith(MockitoExtension.class) 类 UserServiceTest { @模拟私有 UserRepository 用户存储库； @InjectMocks 私有 UserService 用户服务； @测试无效shouldReturnUserWhenFound() { 用户预期用户=新用户（1L，“爱丽丝”）； when(userRepository.findById(1L)).thenReturn(Optional.of(expectedUser)); 用户结果 = userService.getUser(1L); assertThat(结果).isEqualTo(expectedUser); 验证(userRepository).findById(1L); } @测试无效 shouldThrowExceptionWhenNotFound() { when(userRepository.findById(999L)).thenReturn(Optional.empty()); assertThatThrownBy(() -> userService.getUser(999L)) .isInstanceOf(UserNotFoundException.class); } } ### 输入：手动模拟创建（反模式） UserService 服务 = new UserService(new FakeUserRepository()); ### 输出：基于 Mockito 的测试 @模拟私有 UserRepository 用户存储库； @InjectMocks 私有 UserService 用户服务； @测试无效测试（）{ when(userRepository.findById(1L)).thenReturn(Optional.of(user)); // 测试逻辑 } ## 最佳实践 * **使用 @ExtendWith(MockitoExtension.class)** 进行 JUnit 5 集成 * **手动构建服务**而不是尽可能使用反射 * **仅模拟被测服务的直接依赖关系** * **验证交互**以确保正确的协作 * **使用描述性变量名称** : `expectedUser`, `actualUser`, `captor` * **每个测试方法测试一种行为** \- 保持测试重点 * **避免测试框架代码** \-专注于业务逻辑 ## 常见模式 **与 Spy 的部分模拟**： @间谍 @InjectMocks 私有 UserService 用户服务； // 真实实例，但可以存根一些方法 @测试无效shouldUseRealMethodButMockDependency（）{ when(userRepository.findById(any())).thenReturn(Optional.of(new User())); // 调用真正的 userService 方法，但 userRepository 被模拟 } **用于测试的构造函数注入**： // 在您的服务中（生产代码）公共类用户服务{ 私有最终 UserRepository userRepository; 公共 UserService(UserRepository userRepository) { this.repository = userRepository; } } // 在你的测试中 - 可以直接注入模拟 @测试无效测试（）{ UserRepository mockRepo = mock(UserRepository.class); UserService 服务 = new UserService(mockRepo); } ## 故障排除 **UnfinishedStubbingException** ：确保所有 `when()` 调用都通过 `thenReturn()`、`thenThrow()` 或 `thenAnswer()` 完成。 **UnnecessaryStubbingException** ：删除未使用的存根定义。如果您故意有未使用的存根，请使用“@ExtendWith(MockitoExtension.class)”和“MockitoExtension.LENIENT”。 **测试中的 NullPointerException** ：验证“@InjectMocks”是否正确地将所有模拟依赖项注入到服务构造函数中。 ## 限制和警告 * 不要模拟值对象或 DTO；使用测试数据创建真实实例。 * 避免模拟过多的依赖项；如果服务有太多协作者，请考虑重构。 * 测试不应依赖于执行顺序；每个测试必须是独立的。 * 请谨慎使用“@Spy”，因为它可能导致部分模拟，这更难以理解。 * 使用 Mockito-Inline 谨慎模拟静态方法；它可能会导致长时间运行的测试套件内存泄漏。 * 不要直接测试私有方法；通过公共方法行为来测试它们。 * 参数匹配器（`any()`、`eq()`）不能与同一存根中的实际值混合。 * 避免过度验证；仅验证对测试场景重要的交互。 ## 参考文献 * [Mockito 文档]() * [JUnit 5 用户指南]() * [AssertJ 断言]()

单元测试服务层

包含技能