![](/img/trans.png)
[英]How to Unit test Spring-Boot REST endpoints with MockMVC where the path mappings are environment variables?
[英]Using Spring mockMvc to test optional path variables
我在 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
}
使用像这样的@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());
}
这已经很晚了,但我最近遇到了这种情况,并认为这篇文章会对其他人有所帮助。
如果使用可选的请求参数或路径变量模拟端点,您可以像这样指定它。
假设我有一个从控制器调用的参数为m1(String param1, String param2)
。
其中 param 2 是控制器的可选参数,因此在运行时如果未传递 null 则将传递它。
如何嘲讽:
Mockito.when(m1(Mockito.anyString(), Mockito.eq(null)).the return(<whatever you want to return>)
在测试中使用Mockito.eq(null)
将其作为 null 传递给可选参数。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.