使用 Spring mockMvc 测试可选路径变量

Posted 2023-02-27

【中文标题】使用 Spring mockMvc 测试可选路径变量

【英文标题】：Using Spring mockMvc to test optional path variables

【发布时间】：2018-01-31 05:32:58

【问题描述】：

我在 Spring MVC 中有一个带有可选路径变量的方法。我正在尝试在未提供可选路径变量的情况下对其进行测试。

来自控制器的片段，要调用的资源 URI-

@RequestMapping(value = "/some/uri/foo/bar", method = RequestMethod.PUT)
public <T> ResponseEntity<T> someMethod(
     @PathVariable("foo") String foo, 
     @PathVariable(value = "bar", required = false) String bar
) 
    LOGGER.info("foo: , bar: ", foo, bar);

我使用 MockMvc 测试的片段-

//inject context
@Autowired
private WebApplicationContext webApplicationContext;

protected MockMvc mockMvc;

@Before
public void setup() 
    //build mockMvc
    mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();


@Test
public void someMethodTest() throws Exception 
    //works as expected
    mockMvc.perform(put("/some/uri/foo/bar", "foo", "bar"))
            .andExpect(status().isOk()); //works

    //following doesn't work

    //pass null for optional
    mockMvc.perform(put("/some/uri/foo/bar", "foo", null))
            .andExpect(status().isOk()); //throws 404

    //pass empty for optional
    mockMvc.perform(put("/some/uri/foo/bar", "foo", ""))
            .andExpect(status().isOk()); //throws 404

    //remove optional from URI
    mockMvc.perform(put("/some/uri/foo", "foo"))
            .andExpect(status().isOk()); //throws 404

【问题讨论】：

***.com/questions/17821731/… 的可能重复项。简而言之 - 您应该在请求映射中使用 URI 数组 (@RequestMapping(value = "/some/uri/foo/bar", "/some/uri/foo")

我不认为这是该问题的重复，因为 PathVariable 可以是可选的，我在上面发布的代码中将其用作可选。

【参考方案1】：

像这样使用 @RequestMapping 值的数组 ...

@RequestMapping(
    value = "/some/uri/foo", "/some/uri/foo/bar", 
    method = RequestMethod.PUT)
public ResponseEntity<String> someMethod(
    @PathVariable("foo") String foo, 
    @PathVariable(value = "bar", required = false) String bar
) 
    return new ResponseEntity<>(foo + " and " + (bar == null ? "<null>" : bar), HttpStatus.OK);

...将使此测试通过：

@Test
public void someMethodTest() throws Exception 
    MvcResult mvcResult = mockMvc.perform(put("/some/uri/foo/bar", "foo", "bar"))
            .andExpect(status().isOk()).andReturn();
    Assert.assertEquals("foo and bar", mvcResult.getResponse().getContentAsString());

    mvcResult = mockMvc.perform(put("/some/uri/foo/bar", "foo", null))
            .andExpect(status().isOk()).andReturn();
    Assert.assertEquals("foo and <null>", mvcResult.getResponse().getContentAsString());

    mvcResult = mockMvc.perform(put("/some/uri/foo/bar", "foo", ""))
            .andExpect(status().isOk()).andReturn();
    Assert.assertEquals("foo and <null>", mvcResult.getResponse().getContentAsString());

    mvcResult = mockMvc.perform(put("/some/uri/foo", "foo"))
            .andExpect(status().isOk()).andReturn();
    Assert.assertEquals("foo and <null>", mvcResult.getResponse().getContentAsString());

这似乎是最简单的解决方案，而且它可能对 Swagger 等工具更友好，因为它使映射变得明确。

但是，您也可以声明通配符映射，然后在控制器方法中使用路径匹配器来解释请求 URI。比如这个方法……

private final AntPathMatcher antPathMatcher = new AntPathMatcher();

@RequestMapping(value = "/some/uri/with/wildcards/**", method = RequestMethod.PUT)
public ResponseEntity<String> someMethod(HttpServletRequest request) 
    String matched = antPathMatcher.extractPathWithinPattern(
            (String) request.getAttribute(HandlerMapping.BEST_MATCHING_PATTERN_ATTRIBUTE), request.getPathInfo());
    // ugly parsing code to read the path variables, allowing for the optionality of the second one
    String foo = matched;
    String bar = null;
    String[] pathVariables = matched.split("/");
    if (pathVariables.length > 1) 
        foo = pathVariables[0];
        bar = pathVariables[1];
    
    return new ResponseEntity<>(foo + " and " + (bar == null ? "<null>" : bar), HttpStatus.OK);

...将使此测试通过：

@Test
public void someMethodTestWithWildcards() throws Exception 
    MvcResult mvcResult = mockMvc.perform(put("/some/uri/with/wildcards/foo/bar", "foo", "bar"))
            .andExpect(status().isOk()).andReturn();
    Assert.assertEquals("foo and bar", mvcResult.getResponse().getContentAsString());

    mvcResult = mockMvc.perform(put("/some/uri/with/wildcards/foo/bar", "foo", null))
            .andExpect(status().isOk()).andReturn();
    Assert.assertEquals("foo and <null>", mvcResult.getResponse().getContentAsString());

    mvcResult = mockMvc.perform(put("/some/uri/with/wildcards/foo/bar", "foo", ""))
            .andExpect(status().isOk()).andReturn();
    Assert.assertEquals("foo and <null>", mvcResult.getResponse().getContentAsString());

    mvcResult = mockMvc.perform(put("/some/uri/with/wildcards/foo", "foo"))
            .andExpect(status().isOk()).andReturn();
    Assert.assertEquals("foo and <null>", mvcResult.getResponse().getContentAsString());

【参考方案2】：

这已经很晚了，但我最近遇到了这种情况，并认为这篇文章会对其他人有所帮助。

如果使用可选的请求参数或路径变量模拟端点，您可以像这样指定它。

假设我有一个从控制器调用的参数为m1(String param1, String param2) 的方法。

其中参数 2 是控制器的可选参数，因此在运行时如果未传递 null 将传递。

如何模拟：

Mockito.when(m1(Mockito.anyString(), Mockito.eq(null)).the return(<whatever you want to return>)

在您的测试中使用 Mockito.eq(null) 将其作为 null 传递给可选参数。

【讨论】：

.the return 或 .thenReturn?

在列出的失败的测试用例中，这只会处理一种情况。