Spring中打桩测试(单元测试,使用@MockBean、@SpyBean)

本文介绍了在Spring单元测试中如何利用@MockBean和@SpyBean进行远程接口的模拟,以便在接口未完成或服务不可用时仍能进行测试。@MockBean注解用于替代整个类,所有方法都将返回预设值,而@SpyBean则可以在特定方法上模拟返回值,允许部分真实方法调用。文章通过实例展示了这两种注解的使用方法及其区别。

Spring中单元测试(@MockBean、@SpyBean)

概述

在开发中,有时候我们的接口需要去远程调用其他的接口,而在单元测试中,如果出现别人的接口没有开发完成或者远程服务不可用的情况,那么单元测试就不能进行下去,这时候就需要使用到下面的测试方法了,可以让我们指定远程调用方法返回一个我们自己指定符合规则的返回值,不用受限于远程接口的返回值,让单元测试能够进行下去

@MockBean

使用此注解注入的类,表明类中的所有方法都使用自定义返回的值,这样在测试的时候就不会真的去调用远程接口,而是返回一个我们预设的值

调用方法定义:TicketBuyOrderInfoVo getBuyOrderInfoVoByOrderId(@RequestParam("orderId") String orderId);

@MockBean
protected AirTicketBuyDataServiceFeignClient buyDataServiceFeignClient;

@Test
public void addComsumptions() {
   
   
	String json = "{\"buyOrderExtendBo\":{\"keyId\":\"1910081525037263066XXXX182\",\"orderId\":\"191008152448182781\",\"sellOrderId\":\"191008152447001294\",\"bookOffice\":\"\",\"outTicketOffice\":\"\",\"outTicketAccount\":\"18683561923\",\"outTicketPayAccount\":\"\",\"itineraryDispatchTypeID\":0,\"itineraryDispatchTypeName\":\"无行程单\",\"itineraryExpressMoney\":0.00,\"recipientName\":\"\",\"postAddress\":\"\",\"recipientPhoneNum\":\"\",\"itineryCreateState\":0,\"itineryCreateStateDes\":\"不需要\",\"itineryFailReason\":\"\",\"itineryOrderId\":\"\",\"key1\":\"0\",\"key2\":\"\",\"key3\":\"\",\"key4\":\"\",\"key5\":\"\",\"key6\":0,\"key7\":0,\"key8\":\"2019-10-08 15:25:04\",\"key9\":\"2019-10-08 15:25:04\",\"key10\":\"2019-10-08 15:25:04\",\"addTime\":\"2019-10-08 15:25:04\",\"isDelete\":0,\"outPayType\":0,\"outPayAccount\":\"\",\"outPayTradeNo\":\"\",\"outPayBillNo\":\"\"},\"buyOrderInfoBo\":{\"keyID\":\"1910081525036229769XXXX182\",\"orderId\":\"191008152448182781\",\"sellOrderId\":\"191008152447001294\",\"tMCNo\":\"20160426135933567151\",\"tMCName\":\"小霞TMC0\",\"corpNo\":\"20160712160619032240\",\"corpName\":\"锦茵TMC\",\"serviceProviderID\":\"20180702000000000002\",\"serviceProviderName\":\"官网产品001\",\"supplyId\":\"20190730194131772844\",\"supplyName\":\"官网产品001\",\"orderType\":0,\"orderTypeName\":\"普通订单\",\"ticketType\":0,\"voyageType\":0,\"voyageTypeName\":\"单程\",\"voyageLeg\":\"银川-中卫\",\"voyageLegEn\":\"\",\"flightNos\":\"JR1509\",\"passengerCount\"
### PowerMock中 @Mock、@MockBean、@Spy 和 @SpyBean 注解的区别 在测试框架中,`@Mock`、`@MockBean`、`@Spy` 和 `@SpyBean` 是用于创建模拟对象的注解,但它们的功能和使用场景存在显著差异。以下是四者的详细对比: #### 1. @Mock 注解 `@Mock` 是来自 Mockito 框架的一个注解,通常与 PowerMock 结合使用,以支持对静态方法、私有方法或 final 类的模拟[^1]。它主要用于以下场景: - **作用范围**:适用于单元测试中需要模拟的对象。 - **初始化方式**:需要通过 `MockitoAnnotations.initMocks(this)` 或者使用 `@RunWith(MockitoJUnitRunner.class)` 来初始化。 - **适用对象**:可以模拟普通的 Java 对象,包括类的实例、接口等。 - **行为特征**:所有方法调用都会返回默认值(如 `null`、`0`、`false`),除非显式定义行为。 示例代码如下: ```java @PrepareForTest(BeanUtils.class) @RunWith(PowerMockRunner.class) public class MyTest { @Mock private SomeService someService; @Before public void setUp() { MockitoAnnotations.initMocks(this); } @Test public void testMethod() { when(someService.getData()).thenReturn("Mocked Data"); // 测试逻辑 } } ``` #### 2. @MockBean 注解 `@MockBean` 是 Spring Boot 提供的一个注解,专为集成测试设计,用于替换 Spring 应用上下文中的真实 Bean 为 Mock 对象[^2]。它的特点如下: - **作用范围**:适用于集成测试中需要替换 Spring 容器中 Bean 的场景。 - **初始化方式**:无需手动初始化,Spring TestContext 框架会自动处理。 - **适用对象**:直接操作 Spring 容器中的 Bean,可以轻松替换任何被 Spring 管理的组件。 - **行为特征**:所有方法调用都会返回默认值,除非显式定义行为。 示例代码如下: ```java @SpringBootTest public class MyIntegrationTest { @MockBean private SomeService someService; @Autowired private SomeController someController; @Test public void testController() { when(someService.getData()).thenReturn("Mocked Data"); String result = someController.callService(); assertEquals("Mocked Data", result); } } ``` #### 3. @Spy 注解 `@Spy` 是 Mockito 提供的另一个注解,用于部分模拟对象的行为。与 `@Mock` 不同,`@Spy` 会保留原始对象的实际行为,除非显式定义模拟行为[^1]。其主要特点如下: - **作用范围**:适用于需要部分模拟对象的场景。 - **初始化方式**:需要通过 `MockitoAnnotations.initMocks(this)` 初始化。 - **适用对象**:可以是普通 Java 对象或 Spring 容器中的 Bean。 - **行为特征**:默认保留对象的真实行为,但可以选择性地模拟某些方法。 示例代码如下: ```java public class SomeServiceSpyTest { @Spy private SomeService someService = new SomeService(); @Before public void setUp() { MockitoAnnotations.initMocks(this); } @Test public void testSpyBehavior() { when(someService.getData()).thenReturn("Spied Data"); String result = someService.getData(); assertEquals("Spied Data", result); // 调用未模拟的方法时,仍执行真实逻辑 someService.performRealLogic(); } } ``` #### 4. @SpyBean 注解 `@SpyBean` 是 Spring Boot 提供的一个注解,类似于 `@MockBean`,但它创建的是 Spy 对象而不是完全的 Mock 对象[^2]。它的特点如下: - **作用范围**:适用于集成测试中需要部分模拟 Spring 容器中 Bean 的场景。 - **初始化方式**:无需手动初始化,Spring TestContext 框架会自动处理。 - **适用对象**:直接操作 Spring 容器中的 Bean,可以轻松部分模拟任何被 Spring 管理的组件。 - **行为特征**:默认保留对象的真实行为,但可以选择性地模拟某些方法。 示例代码如下: ```java @SpringBootTest public class MyIntegrationTest { @SpyBean private SomeService someService; @Autowired private SomeController someController; @Test public void testController() { doReturn("Spied Data").when(someService).getData(); String result = someController.callService(); assertEquals("Spied Data", result); // 调用未模拟的方法时,仍执行真实逻辑 someService.performRealLogic(); } } ``` #### 区别总结 | 特性 | @Mock | @MockBean | @Spy | @SpyBean | |---------------------|--------------------------------|-------------------------------|--------------------------------|--------------------------------| | **作用范围** | 单元测试 | 集成测试 | 单元测试或集成测试 | 集成测试 | | **依赖注入** | 手动管理 | 自动注入到 Spring 容器中 | 手动管理或自动注入(Spring Spy)| 自动注入到 Spring 容器中 | | **框架支持** | Mockito | Spring Boot | Mockito | Spring Boot | | **初始化方式** | 需要 `MockitoAnnotations` 初始化 | 自动初始化 | 需要 `MockitoAnnotations` 初始化 | 自动初始化 | | **适用对象** | 普通 Java 对象 | Spring 容器中的 Bean | 普通 Java 对象或 Spring Bean | Spring 容器中的 Bean | | **行为特征** | 默认返回默认值 | 默认返回默认值 | 默认保留真实行为 | 默认保留真实行为 | #### 使用场景 - **@Mock**:当测试的是一个独立的类或方法,且不需要涉及 Spring 容器时,使用 `@Mock`。 - **@MockBean**:当测试需要模拟 Spring 容器中的 Bean,并确保其他组件依赖的是 Mock 对象时,使用 `@MockBean`。 - **@Spy**:当需要部分模拟对象的行为,同时保留其余方法的真实逻辑时,使用 `@Spy`。 - **@SpyBean**:当需要部分模拟 Spring 容器中的 Bean 行为,同时保留其余方法的真实逻辑时,使用 `@SpyBean`。 ### 示例对比 假设有一个服务类 `SomeService` 和控制器类 `SomeController`,分别演示四种注解的使用场景。 #### 单元测试(@Mock) ```java public class SomeServiceTest { @Mock private SomeRepository someRepository; private SomeService someService; @Before public void setUp() { MockitoAnnotations.initMocks(this); someService = new SomeService(someRepository); } @Test public void testGetData() { when(someRepository.findData()).thenReturn("Test Data"); String result = someService.getData(); assertEquals("Test Data", result); } } ``` #### 集成测试@MockBean) ```java @SpringBootTest public class SomeControllerTest { @MockBean private SomeService someService; @Autowired private SomeController someController; @Test public void testCallService() { when(someService.getData()).thenReturn("Test Data"); String result = someController.callService(); assertEquals("Test Data", result); } } ``` #### 部分模拟(@Spy) ```java public class SomeServiceSpyTest { @Spy private SomeService someService = new SomeService(); @Before public void setUp() { MockitoAnnotations.initMocks(this); } @Test public void testSpyBehavior() { when(someService.getData()).thenReturn("Spied Data"); String result = someService.getData(); assertEquals("Spied Data", result); // 调用未模拟的方法时,仍执行真实逻辑 someService.performRealLogic(); } } ``` #### 部分模拟(@SpyBean) ```java @SpringBootTest public class SomeControllerSpyTest { @SpyBean private SomeService someService; @Autowired private SomeController someController; @Test public void testCallService() { doReturn("Spied Data").when(someService).getData(); String result = someController.callService(); assertEquals("Spied Data", result); // 调用未模拟的方法时,仍执行真实逻辑 someService.performRealLogic(); } } ``` ###
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值