首页 > 解决方案 > 如何在@WebMvcTest 的服务层上模拟自动装配的bean

问题描述

我正在 Spring boot gradle 应用程序中测试 REST API,我使用 @MockBean 的模拟服务返回 null。如果服务类中有一些自动装配的 bean(我使用了构造函数注入),则此模拟服务返回 null。

这是示例代码(未编译,仅用于理解)


    @RestController
    @RequestMapping("/xxx")
    class TestController {

        private RetriveDataService retriveDataService;

        public TestControllerx(RetriveDataService retriveDataService) {
            this.retriveDataService = retriveDataService;
        }

        @PostMapping(value = "/yyy")
        public MyResponseModel myMethod(@RequestBody MyRequestModel model) {

            return retriveDataService.retriveData(model);
        }

    }

    @Service
    class RetriveDataService {

        private TokenService tokenService;

        public RetriveDataService(TokenService tokenService) {
            this.tokenService = tokenService;
        }

        public MyResponseModel retriveData(MyRequestModel model) {
            String accessToken = tokenService.getToken().getAccessToken();

            return retriveData(model, accessToken);
        }

    }

    @RunWith(SpringRunner.class)
    @WebMvcTest(TestController.class)
    public class TestControllerTest {

        @Autowired
        private MockMvc mvc;

        @Autowired
        private ObjectMapper objectMapper;

        @MockBean
        private RetriveDataService retriveDataService;

        @Test
        public void testRetriveData() throws Exception {

            mvc.perform(MockMvcRequestBuilders.post("/xxx/yyy").content(objectMapper.writeValueAsString(new MyRequestModel()))
                    .contentType(MediaType.APPLICATION_JSON_UTF8)).andDo(MockMvcResultHandlers.print())
                    .andExpect(content().contentType(MediaType.APPLICATION_JSON_UTF8));
        }

    }

当我运行这个测试时,我得到以下输出(如果我的服务不需要另一个 bean,我得到预期的输出)

MockHttpServletResponse:
           Status = 200
    Error message = null
          Headers = []
     Content type = null
             Body = 
    Forwarded URL = null
   Redirected URL = null
          Cookies = []

由于此响应,我在 .andExpect(content().contentType(MediaType.APPLICATION_JSON_UTF8)); 线上面临问题。当我检查响应正文时(因为正文也是空的)

重现问题的示例项目在这里

标签: spring-boottestingmockitospringmockito

解决方案


检查您的存储库确认的假设来自有问题的评论中的讨论。

您在模拟中指定期望

MyModel requestMessage = new MyModel();
requestMessage.setMessage("Hello Request Post");
given(testService1.getMessage(requestMessage)).willReturn(responseMessage);

但是在您的控制器中收到的消息@WebMvcTest不等于测试中指定的 requestMessage。这是因为MyModel类不覆盖equals方法。在这种情况下,Mockito 将使用其默认行为:

默认情况下,对于所有返回值的方法,mock 将根据需要返回 null、原始/原始包装器值或空集合。例如 0 表示 int/Integer,false 表示 boolean/Boolean。

您有两个选项可以解决此问题:

  1. 在您的请求类中覆盖equals(和)。hashCode
  2. 熟悉参数匹配器

有关选项 2 的更多信息:

从技术上讲,您的期望相当于:

given(testService1.getMessage(ArgumentMatchers.eq(requestMessage)))
  .willReturn(responseMessage);

您可以使用其他匹配器,甚至定义自己的匹配器。如果您无法修改参数类型的代码(来自 3-rd 方库等的类型),这将很有用。例如,您可以使用ArgumentMatchers.any(MyModel.class))


推荐阅读