导航
- 我们为什么需要Mock?
- Mockito介绍
- 创建Mock对象
- 1.通过方法创建
- 2.通过注解创建
- 设置预期返回
- Mockito测试案例
我们为什么需要Mock?
当我们进行单元测试时,如果依赖的对象出现了问题,就算被测试的对象本身并无问题,也会导致测试案例的失败;又或者,被测试对象里需要使用一些难以获取的依赖对象时,如与数据库交互的Mapper层等。
我们只想对被测试对象本身进行测试,要排除其他的干扰,与其他组件的联合测试,放在集成测试就好了,单元测试不应该被外界打扰。
为了屏蔽掉这些外界的干扰,我们提出了Mock思想:mock测试就是在测试过程中,对于某些不容易构造或者不容易获取的对象,用一个虚拟的对象来创建以便测试的测试方法。
当我们依赖外部对象时,使用mock改为调用一个虚拟的、模拟出来的对象来代替,以尽可能的屏蔽外界的干扰。如图,对A类进行测试时,我们将B、C类用其Mock对象替换。
Mock思想是一个广泛通用的思想,在许多语言、测试层里,都会用到。这里主要介绍在Java语言里做单元测试时的Mock工具 - Mockito。
Mockito介绍
Mockito 是一个简单的流行的 Mock 框架。它能够帮我们创建 Mock 对象,保持单元测试的独立性。SpringBoot默认的Mock框架是Mockito,和junit一样,只需要依赖spring-boot-starter-test就可以了。
引如Mockito 的依赖也特别简单,如果你是Maven工程,只需要加入如下依赖:
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<version>3.5.15</version>
<scope>test</scope>
</dependency>
创建Mock对象
使用Mockito创建对象的方式有两种。比如,我们想把userService中的与数据库连接的Mapper对象Mock掉时:
1.通过方法创建
class MockitoTest {
private UserMapper mockUserMapper;
private UserServiceImpl userService;
@Before
public void setup() {
mockUserMapper = mock(UserMapper.class);
userService = new UserServiceImpl();
userService.setUserDao(mockUserMapper);
}
}
2.通过注解创建
class MockitoTest {
@Mock
UserMapper mockUserMapper;
@InjectMocks
private UserServiceImpl userService;
@Before
public void setUp() {
MockitoAnnotations.openMocks(this);
}
}
在日常工作中,我更偏向于使用注解的方式,更简单~
设置预期返回
创建了mock对象后,在调用对象方法前,我们还需要先设定方法的期望返回值。
when(mockUserMapper.selectUser(eq(1))).thenReturn(new User(1, "User1"));
when(mockUserMapper.updateUser(isA(User.class))).thenReturn(true);
when(mockUserMapper.insertUser(any())).thenReturn(true);
when(mock对象.方法).thenReturn(对象或值)
,这是最常用的期望定义语句,可以满足绝大部分场景。表示当某个方法被执行时,直接返回执行的对象或值,而不用真实去调用。
除了when方法,还有三个比较重要的参数匹配器需要注意:
- eq():相当于equals,相等时才能成功调用mock方法
- isA():入参为指定类时,才能成功调用mock方法
- any():为任意入参,都可以成功调用mock方法
来一组输出,感受下调用结果:
System.out.println(mockUserMapper.selectUser(1));
System.out.println(mockUserMapper.selectUser(2));
System.out.println(mockUserMapper.updateUser(null));
System.out.println(mockUserMapper.updateUser(new User(1,"User1")));
System.out.println(mockUserMapper.insertUser(null));
System.out.println(mockUserMapper.insertUser(new User(1,"User1")));
-----------------------输出为-----------------------
User(id=1, name=User1)
null
false
true
true
true
他们都在import static org.mockito.ArgumentMatchers.*;
下,里面还定义了许多其他的匹配器,可以按需使用。
Mockito测试案例
接着上诉的User案例,贴出完整的代码,及测试代码。如果上文我表述不清导致没有看懂,也可以阅读源码后重新阅读,有助于理解~
Service类提供的方法很简单,如果User的Id在数据库中存在,则进行update,否则进行insert。代码如下:
@Service
public class UserServiceImpl {
@Autowired
private UserMapper userMapper;
public void createOrUpdateUser(User newUser){
User user = userMapper.selectUser(newUser.getId());
if(user != null){
userMapper.updateUser(newUser);
}else{
userMapper.insertUser(newUser);
}
}
}
测试代码:
public class UserServiceImplTest {
@Mock
UserMapper mockUserMapper;
@InjectMocks
private UserServiceImpl userService;
@Before
public void setUp() {
MockitoAnnotations.openMocks(this);
}
@Test
public void given_exists_user_when_createOrUpdateUser_then_update_and_dont_insert() {
//mock预期返回
when(mockUserMapper.selectUser(eq(1))).thenReturn(new User(1, "User1"));
when(mockUserMapper.updateUser(isA(User.class))).thenReturn(true);
when(mockUserMapper.insertUser(any())).thenReturn(true);
//执行被测试方法
userService.createOrUpdateUser(new User(1, "User1"));
//通过调用次数,验证代码分支是否正确执行
verify(mockUserMapper,times(1)).updateUser(any());
verify(mockUserMapper,never()).insertUser(any());
}
}
因为UserServiceImpl也是mock出来的,所以整个测试都不依赖于Spring容器,不需要启动容器后获取。
在最后的两行verify()
,是Mockito提供的检验方法,用户检验指定方法是否调用过,及调用次数。需要静态导入import static org.mockito.Mockito.*;