MockBean

@MockBean 是 Spring Boot 中用于在测试环境中创建和注入 mock 对象的注解。它通常与 Spring Boot 的测试框架（如 @SpringBootTest）一起使用，以便在测试时替换实际的 bean，从而避免对外部依赖的调用。

以下是 @MockBean 的一些常见用法：

1. 基本用法

假设你有一个服务类 UserService，它依赖于 UserRepository。在测试中，你可以使用 @MockBean 来创建 UserRepository 的 mock 实例。

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserServiceTest {

    @Autowired
    private UserService userService;

    @MockBean
    private UserRepository userRepository;

    @Test
    public void testGetUser() {
        User mockUser = new User("John", "Doe");
        Mockito.when(userRepository.findById(1L)).thenReturn(Optional.of(mockUser));

        User user = userService.getUser(1L);
        assertEquals("John", user.getFirstName());
        assertEquals("Doe", user.getLastName());
    }
}

2. 替换现有的 Bean

@MockBean 还可以用于替换现有的 Spring 容器中的 bean。例如，如果你有一个配置类定义了一个 bean，你可以在测试中用 @MockBean 替换它。

@Configuration
public class AppConfig {

    @Bean
    public ExternalService externalService() {
        return new ExternalServiceImpl();
    }
}

@RunWith(SpringRunner.class)
@SpringBootTest
public class ExternalServiceTest {

    @MockBean
    private ExternalService externalService;

    @Test
    public void testExternalService() {
        Mockito.when(externalService.callExternalApi()).thenReturn("Mock Response");

        String response = externalService.callExternalApi();
        assertEquals("Mock Response", response);
    }
}

3. 多个 @MockBean

你可以在一个测试类中使用多个 @MockBean 注解来创建多个 mock 对象。

@RunWith(SpringRunner.class)
@SpringBootTest
public class MultipleMocksTest {

    @MockBean
    private UserRepository userRepository;

    @MockBean
    private OrderRepository orderRepository;

    @Autowired
    private UserService userService;

    @Autowired
    private OrderService orderService;

    @Test
    public void testServices() {
        User mockUser = new User("John", "Doe");
        Mockito.when(userRepository.findById(1L)).thenReturn(Optional.of(mockUser));

        Order mockOrder = new Order(1L, "Sample Order");
        Mockito.when(orderRepository.findById(1L)).thenReturn(Optional.of(mockOrder));

        User user = userService.getUser(1L);
        assertEquals("John", user.getFirstName());

        Order order = orderService.getOrder(1L);
        assertEquals("Sample Order", order.getDescription());
    }
}

总结

• @MockBean 用于在测试环境中创建和注入 mock 对象。
• 它可以替换现有的 Spring 容器中的 bean。
• 可以在一个测试类中使用多个 @MockBean 注解来创建多个 mock 对象。

通过使用 @MockBean，你可以在测试中轻松地模拟依赖对象，从而专注于测试你的业务逻辑。

这行代码是使用 Mockito 框架来模拟 userRepository 的行为。具体来说，它定义了当 userRepository 的 findById 方法被调用并传入参数 1L 时，返回一个包含 mockUser 的 Optional 对象。

让我们逐步解析这行代码：

1. Mockito.when(...)

Mockito.when 是 Mockito 框架中的一个静态方法，用于指定当某个方法被调用时应该执行的行为。它接受一个方法调用作为参数。

2. userRepository.findById(1L)

这是你希望模拟的方法调用。在这个例子中，userRepository 是一个被 @MockBean 注解标记的 mock 对象，findById 是你希望模拟的方法，1L 是传递给该方法的参数。

3. .thenReturn(Optional.of(mockUser))

thenReturn 是 Mockito 中的一个方法，用于指定当 when 中的方法被调用时应该返回的值。在这个例子中，它返回一个包含 mockUser 的 Optional 对象。

结合起来

这行代码的完整含义是：当 userRepository 的 findById 方法被调用并传入参数 1L 时，返回一个包含 mockUser 的 Optional 对象。

示例代码

User mockUser = new User("John", "Doe");
Mockito.when(userRepository.findById(1L)).thenReturn(Optional.of(mockUser));

解释

• User mockUser = new User("John", "Doe");: 创建一个 User 对象 mockUser，其名字为 “John” 和 “Doe”。
• Mockito.when(userRepository.findById(1L)): 指定当 userRepository 的 findById 方法被调用并传入参数 1L 时。
• thenReturn(Optional.of(mockUser)): 返回一个包含 mockUser 的 Optional 对象。

使用场景

这种模拟方法调用的方式通常用于单元测试中，以便你可以控制依赖对象的行为，从而专注于测试你的业务逻辑。例如，在测试 UserService 的 getUser 方法时，你可以模拟 UserRepository 的行为，以确保 UserService 的逻辑是正确的，而不需要依赖实际的数据库访问。

完整示例

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserServiceTest {

    @Autowired
    private UserService userService;

    @MockBean
    private UserRepository userRepository;

    @Test
    public void testGetUser() {
        User mockUser = new User("John", "Doe");
        Mockito.when(userRepository.findById(1L)).thenReturn(Optional.of(mockUser));

        User user = userService.getUser(1L);
        assertEquals("John", user.getFirstName());
        assertEquals("Doe", user.getLastName());
    }
}

在这个示例中，userRepository.findById(1L) 被调用时将返回 Optional.of(mockUser)，从而使得 userService.getUser(1L) 方法能够返回 mockUser，并且你可以验证返回的用户对象的属性是否正确。