@Mock @Spy @InjectMocks 注解

本文主要是介绍@Mock @Spy @InjectMocks 注解，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

1、@Mock注解

@Mock 注解往往用来创建以及注入模拟实例。当我们被测试代码依赖一个实例时，我们会用 mockito 框架创建一个模拟的实例，而不是去真的创建需要的对象。@Mock注释是Mockito.Mock（classToMock）的一种替代方法，他们都取得了相同的结果；使用@Mock通常被认为是“更干净”的，因为我们不会用看起来都一样的样板作业来填充测试用例。

@Mock
HashMap<String, Integer> mockedMap;//或者HashMap mockedMap = Mockito.mock(HashMap.class);

@Mock
private HashMap<String, Integer> mockHashMap;@Test
public void saveTest() {// 执行方法mockHashMap.put("A", 1);// 验证方法执行次数Mockito.verify(mockHashMap, times(1)).put("A", 1);Mockito.verify(mockHashMap, times(0)).get("A");// 验证MAP容量assertEquals(0, mockHashMap.size());// 模拟依赖方法Mockito.when(mockHashMap.size()).thenReturn(10);// 验证MAP容量assertEquals(10, mockHashMap.size());
}

以上测试用例使用@Mock注解生成一个HashMap的模拟实例，当我们执行了put方法后，可以看到此模拟实例的容量依然为0，是因为mockHashMap并非真实的MAP对象，而是生成的一个模拟实例；我们需要模拟某个方法并指定返回值时，可以用Mockito.when(…).thenReturn(…)的方式来模拟依赖方法，此时我们验证mockHashMap的容量就是10了。

2、@Spy注解

@Spy注释用于创建一个真实对象并监视这个真实对象。@Spy对象能够调用所监视对象的所有正常方法，同时仍然跟踪每一次交互，就像我们使用mock一样，可以自己定义行为。@Spy注释是Mockito.spy（classToMock）的一种替代方法，同样可以减少样板代码，使代码看起来更整洁。

@Spy
private HashMap<String, Integer> mockHashMap;// 或者HashMap<String, Integer> mockHashMap = Mockito.spy(HashMap.class);
HashMap<String, Integer> mockHashMap = Mockito.spy(new HashMap<>());

@Spy
private HashMap<String, Integer> mockHashMap;@Test
public void saveTest() {// 执行方法mockHashMap.put("A", 1);// 验证方法执行次数Mockito.verify(mockHashMap, times(1)).put("A", 1);Mockito.verify(mockHashMap, times(0)).get("A");// 验证MAP容量assertEquals(1, mockHashMap.size());// 模拟依赖方法Mockito.when(mockHashMap.size()).thenReturn(10);// 验证MAP容量assertEquals(10, mockHashMap.size());assertEquals(1, mockHashMap.get("A"));
}

以上测试用例使用@Spy注解生成一个HashMap的模拟实例，当我们执行了put方法后，可以看到此实例的容量已经真实的变为1了，是因为mockHashMap是创建的一个真实的MAP对象；同样我们需要模拟某个方法并指定返回值时，可以用Mockito.when(…).thenReturn(…)的方式来模拟依赖方法，此时我们验证mockHashMap的容量就是10了，因为此对象真实包含一个A=1，所以验证get方法结果是真实的1。

3、@InjectMocks注解

@InjectMocks注解用来创建被测试的类对象，他的依赖对项由@Mock来创建；即mockito会将@Mock以及@Spy创建的对象注入到@InjectMocks生成的对象中，以便模拟我们被测试类所依赖的对象。

@Component
public class UserRepositoryImpl implements UserRepository {@Overridepublic Long createUser(UserDto userDto) {log.info("com.summer.toolkit.mock.UserRepositoryImpl.createUser方法执行");return 1L;}
}@Component
public class UserManagerImpl implements UserManager {@Resourceprivate UserRepository userRepository;@Overridepublic Long createUser(UserDto userDto) {Long result = userRepository.createUser(userDto);log.info("UserManagerImpl.createUser方法执行结果：{}", result);return result;}
}@Service
public class UserServiceImpl implements UserService {@Resourceprivate UserManager userManager;@Overridepublic Long createUser(UserDto userDto) {log.info("创建用户入参：{}", JSON.toJSONString(userDto));Long id = userManager.createUser(userDto);log.info("创建用户出参：{}", id);return id;}}

@Mock
private UserManagerImpl userManager;@InjectMocks
private UserServiceImpl userService;@Test
public void testCreateUser() {// 模拟依赖方法Mockito.when(userManager.createUser(any())).thenReturn(Long.valueOf(1));// 调用被测方法var userDto = this.buildUserDto();var result = userService.createUser(userDto);// 验证方法结果Long expect = 1L;Assertions.assertEquals(expect, result);// 验证方法是否被调用，带超时时间Mockito.verify(userManager, Mockito.timeout(100).times(1)).createUser(userDto);// 任何验证模式下都能使用这种方式，异常抛出指定描述的异常Mockito.verify(userManager, Mockito.times(1).description("someMethod should be called twice")).createUser(any());
}

以上代码UserServiceImpl 是我们的业务代码，模拟插入用户方法，此类依赖UserManager 对象；当我们需要对UserServiceImpl 进行单元测试时，就需要通过@InjectMocks 生成我们的被测试类UserServiceImpl ，用@Mock 来生成我们的模拟依赖对象UserManagerImpl，此时Mockito会将UserManagerImpl自动注入到UserServiceImpl 中，我们在调用userService.createUser()方法时就不会报空指针异常了。

@Spy
private UserRepositoryImpl userRepository;@Spy
private UserManagerImpl userManager;@InjectMocks
private UserServiceImpl userService;@BeforeEach
public void before() {//通过ReflectionTestUtils注入需要的非public字段数据ReflectionTestUtils.setField(userManager, "userRepository", userRepository);
}@Test
public void testCreateUser() {// 模拟依赖方法Mockito.when(userRepository.createUser(any())).thenReturn(Long.valueOf(2));// 调用被测方法var userDto = this.buildUserDto();var result = userService.createUser(userDto);// 验证方法结果Long expect = 2L;Assertions.assertEquals(expect, result);// 验证方法是否被调用，带超时时间Mockito.verify(userManager, Mockito.timeout(100).times(1)).createUser(userDto);// 任何验证模式下都能使用这种方式，异常抛出指定描述的异常Mockito.verify(userManager, Mockito.times(1).description("someMethod should be called twice")).createUser(any());
}

当我们有多层依赖的时候，@InjectMocks并不会注入多层依赖的对象，可以通过以上方法，在测试用例执行前，通过反射的方式将其注入进去。

文章参考：Mockito Annotations: @Mock, @Spy, @InjectMocks and @Captor

这篇关于@Mock @Spy @InjectMocks 注解的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

---