@Mock @Spy @InjectMocks 注解

2024-03-19 10:20
文章标签 注解 mock spy injectmocks

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

文章目录

  • 1、@Mock注解
  • 2、@Spy注解
  • 3、@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 注解的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/825668

相关文章

在 Spring Boot 中使用 @Autowired和 @Bean注解的示例详解

《在SpringBoot中使用@Autowired和@Bean注解的示例详解》本文通过一个示例演示了如何在SpringBoot中使用@Autowired和@Bean注解进行依赖注入和Bean... 目录在 Spring Boot 中使用 @Autowired 和 @Bean 注解示例背景1. 定义 Stud

Spring排序机制之接口与注解的使用方法

《Spring排序机制之接口与注解的使用方法》本文介绍了Spring中多种排序机制,包括Ordered接口、PriorityOrdered接口、@Order注解和@Priority注解,提供了详细示例... 目录一、Spring 排序的需求场景二、Spring 中的排序机制1、Ordered 接口2、Pri

Idea实现接口的方法上无法添加@Override注解的解决方案

《Idea实现接口的方法上无法添加@Override注解的解决方案》文章介绍了在IDEA中实现接口方法时无法添加@Override注解的问题及其解决方法,主要步骤包括更改项目结构中的Languagel... 目录Idea实现接China编程口的方法上无法添加@javascriptOverride注解错误原因解决方

Java中基于注解的代码生成工具MapStruct映射使用详解

《Java中基于注解的代码生成工具MapStruct映射使用详解》MapStruct作为一个基于注解的代码生成工具,为我们提供了一种更加优雅、高效的解决方案,本文主要为大家介绍了它的具体使用,感兴趣... 目录介绍优缺点优点缺点核心注解及详细使用语法说明@Mapper@Mapping@Mappings@Co

Java中注解与元数据示例详解

《Java中注解与元数据示例详解》Java注解和元数据是编程中重要的概念,用于描述程序元素的属性和用途,:本文主要介绍Java中注解与元数据的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参... 目录一、引言二、元数据的概念2.1 定义2.2 作用三、Java 注解的基础3.1 注解的定义3.2 内

SpringBoot使用注解集成Redis缓存的示例代码

《SpringBoot使用注解集成Redis缓存的示例代码》:本文主要介绍在SpringBoot中使用注解集成Redis缓存的步骤,包括添加依赖、创建相关配置类、需要缓存数据的类(Tes... 目录一、创建 Caching 配置类二、创建需要缓存数据的类三、测试方法Spring Boot 熟悉后,集成一个外

使用@Slf4j注解,log.info()无法使用问题

《使用@Slf4j注解,log.info()无法使用问题》在使用Lombok的@Slf4j注解打印日志时遇到问题,通过降低Lombok版本(从1.18.x降至1.16.10)解决了问题... 目录@Slf4androidj注解,log.info()无法使用问题最后解决总结@Slf4j注解,log.info(

spring—使用注解配置Bean

从Spring2.5开始,出现了注解装配JavaBean的新方式。注解可以减少代码的开发量,spring提供了丰富的注解功能,现在项目中注解的方式使用的也越来越多了。   ** 开启注解扫描          Spring容器默认是禁用注解配置的。打开注解扫描的方式主要有两种: <context:component-scan>组件扫描和<context:annotation

Spring Boot 注解探秘:HTTP 请求的魅力之旅

在SpringBoot应用开发中,处理Http请求是一项基础且重要的任务。Spring Boot通过提供一系列丰富的注解极大地简化了这一过程,使得定义请求处理器和路由变得更加直观与便捷。这些注解不仅帮助开发者清晰地定义不同类型的HTTP请求如何被处理,同时也提升了代码的可读性和维护性。 一、@RequestMapping @RequestMapping用于将特定的HTTP请求映射到特定的方法上

Redis缓存 自定义注解+aspect+反射技术实现

最近再给云随笔后台增加redis模块,突然发现spring-boot-starter-data-redis模块很不人性化,实现不了通用的方式,(当然,你也可以自己写个通用的CacheUtil来实现通用的方式),但由于本人非常的爱装逼,就在这里不讲解那种傻瓜式操作了,这里只讲干货,干到你不可置信的干货). 例如:这里我使用了它其中的RedisTemplate ,发现存到redis中后,数据