社区首页 >专栏 >@Spy、@SpyBean、@MockBean、@Mock、@RunWith、@ExtendWith对比

@Spy、@SpyBean、@MockBean、@Mock、@RunWith、@ExtendWith对比

原创

查拉图斯特拉说

发布于 2023-11-09 09:57:02

1.3K00

代码可运行

文章被收录于专栏：后端架构后端架构

运行总次数：0

代码可运行

前言

在写单元测试中经常会用到Mockito，但是这些类似的注解非常混乱，今天总结一下相关的注解，说明其中的含义和实现例子。

Mockito.mock() vs @Mock vs @MockBean

Mockito.mock ()方法允许我们创建类或接口的模拟对象。

@Test
public void givenCountMethodMocked_WhenCountInvoked_ThenMockedValueReturned() {
    UserRepository localMockRepository = Mockito.mock(UserRepository.class);
    Mockito.when(localMockRepository.count()).thenReturn(111L);

    long userCount = localMockRepository.count();

    Assert.assertEquals(111L, userCount);
    Mockito.verify(localMockRepository).count();
}

@Mock该注释是Mockito.mock()方法的简写。需要注意的是，我们应该只在测试类中使用它。与mock()方法不同的是，我们需要启用Mockito注解才能使用该注解。

@RunWith(MockitoJUnitRunner.class)
public class MockAnnotationUnitTest {
    
    @Mock
    UserRepository mockRepository;
    
    @Test
    public void givenCountMethodMocked_WhenCountInvoked_ThenMockValueReturned() {
        Mockito.when(mockRepository.count()).thenReturn(123L);

        long userCount = mockRepository.count();

        Assert.assertEquals(123L, userCount);
        Mockito.verify(mockRepository).count();
    }
}

@MockBean将模拟对象添加到 Spring 应用程序上下文中。模拟将替换应用程序上下文中相同类型的任何现有 bean。

@RunWith(SpringRunner.class)
public class MockBeanAnnotationIntegrationTest {
    
    @MockBean
    UserRepository mockRepository;
    
    @Autowired
    ApplicationContext context;
    
    @Test
    public void givenCountMethodMocked_WhenCountInvoked_ThenMockValueReturned() {
        Mockito.when(mockRepository.count()).thenReturn(123L);

        UserRepository userRepoFromContext = context.getBean(UserRepository.class);
        long userCount = userRepoFromContext.count();

        Assert.assertEquals(123L, userCount);
        Mockito.verify(mockRepository).count();
    }
}

JUnit5 @RunWith annotation with the new @ExtendWith

在 JUnit 5 中，@RunWith注释已被更强大的@ExtendWith注释取代。

@RunWith

@RunWith注释在任何较旧的 JUnit 环境中运行 JUnit 5 测试。

JUnitPlatform类是一个基于 JUnit 4 的运行器，它允许我们在 JUnit 平台上运行 JUnit 4 测试。

@RunWith(JUnitPlatform.class)
public class GreetingsUnitTest {
    // ...
}

基于 JUnit 4 的运行器的测试迁移到 JUnit 5。我们将使用 Spring 测试作为示例：

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = { SpringTestConfiguration.class })
public class GreetingsSpringUnitTest {
    // ...
}

@ExtendWith

测试迁移到 JUnit 5，我们需要用新的@ExtendWith替换@RunWith注释：

@ExtendWith(SpringExtension.class)
@ContextConfiguration(classes = { SpringTestConfiguration.class })
public class GreetingsSpringUnitTest {
    // ...
}

@Spy 和 @SpyBean 之间的区别

@Spy注释是 Mockito 测试框架的一部分，它创建真实对象的间谍（部分模拟），通常用于单元测试。

@Spy
OrderRepository orderRepository;
@Spy
NotificationService notificationService;
@InjectMocks
OrderService orderService;

@Test
void givenNotificationServiceIsUsingSpy_whenOrderServiceIsCalled_thenNotificationServiceSpyShouldBeInvoked() {
    UUID orderId = UUID.randomUUID();
    Order orderInput = new Order(orderId, "Test", 1.0, "17 St Andrews Croft, Leeds ,LS17 7TP");
    doReturn(orderInput).when(orderRepository)
        .save(any());
    doReturn(true).when(notificationService)
        .raiseAlert(any(Order.class));
    Order order = orderService.save(orderInput);
    Assertions.assertNotNull(order);
    Assertions.assertEquals(orderId, order.getId());
    verify(notificationService).notify(any(Order.class));
}

Spring Boot 的@SpyBean注解

@SpyBean注解是Spring Boot特有的，用于与Spring的依赖注入进行集成测试。

@Autowired
OrderRepository orderRepository;
@SpyBean
NotificationService notificationService;
@SpyBean
OrderService orderService;

@Test
void givenNotificationServiceIsUsingSpyBean_whenOrderServiceIsCalled_thenNotificationServiceSpyBeanShouldBeInvoked() {

    Order orderInput = new Order(null, "Test", 1.0, "17 St Andrews Croft, Leeds ,LS17 7TP");
    doReturn(true).when(notificationService)
        .raiseAlert(any(Order.class));
    Order order = orderService.save(orderInput);
    Assertions.assertNotNull(order);
    Assertions.assertNotNull(order.getId());
    verify(notificationService).notify(any(Order.class));
}

@Spy和@SpyBean之间的区别

在单元测试中，我们使用@Spy，而在集成测试中，我们使用@SpyBean。

如果@Spy注解的组件包含其他依赖项，我们可以在初始化时声明它们。如果在初始化期间未提供它们，系统将使用零参数构造函数（如果可用）。在@SpyBean测试的情况下，我们必须使用@Autowired注释来注入依赖组件。否则，在运行时，Spring Boot 会创建一个新实例。

如果我们在单元测试示例中使用 @SpyBean ，则当调用NotificationService时，测试将失败并出现NullPointerException，因为OrderService需要模拟/间谍 NotificationService。

同样，如果在集成测试的示例中使用@Spy ，则测试将失败并显示错误消息“Wanted but not invoked: notificationService.notify(<any com.baeldung.spytest.Order> )”，因为 Spring 应用程序context 不知道 @Spy注解的类。相反，它创建一个新的NotificationService实例并将其注入到OrderService 中。

@SpyBean需要手动注入bean，但是@Spy 不需要，除非你调用了依赖

总结

@Spy、@SpyBean、@MockBean、@Mock、@RunWith、@ExtendWith，带bean的就跟集成测试有关，例如集成Spring，如果只是简单的单元测试可以配置不带Bean的，这里面最好区分的还是@RunWith和@ExtendWith，一个是JUnit4一个是JUnit5。