在Spring Boot控制器中验证HTTP POST请求中的请求体是否为空

Question

我正在替换Spring Boot REST控制器中对POST请求输入的手动验证。JSR-303 Spring Bean验证用于验证请求主体中的实例变量，这是预期的工作。什么是建议的方法来验证请求主体中的对象不是null？

我试过：

>

用@NotNull注释整个类

我正在替换：

@PostMapping...
public ResponseEntity<Map<String, Object>> editFoo(
@RequestBody Foo foo, ...) {
   if(foo == null) {
      return (new ResponseEntity<>(headers, HttpStatus.BAD_REQUEST));
   }
}

与Bean验证等效：

@PostMapping...
public ResponseEntity<Map<String, Object>> editFoo(
@Valid @RequestBody Foo foo, ...) {
   ...
}

我尝试通过以下方式对控制器方法进行单元测试：

// Arrange
    Foo foo = null;
    String requestBody = objectMapper.writeValueAsString(foo);

    // Act + assert
    mockMvc
    .perform(
    post("/end_point")
    .contentType("application/json")
    .content(requestBody))
    .andExpect(status().isBadRequest());

我希望MethodArgumentNotValidException由@ControllerAdvice处理此异常，但在执行单元测试时，我得到了HttpMessageEndableException。我的问题是：

1. 是否需要测试请求主体是否为空
2. 如果1。如果是真的，那么应该如何通过Bean验证来实现呢

Answer 1

查看代码时，您已经检查了主体是否为空。实际上，@RequestBody有一个默认参数required，默认为true。所以不需要进行Bean验证！

你的主要问题似乎在你的测试中。首先，编写一个测试来验证null上的endpoint行为是很好的。

然而，在你的测试中，你不能通过null。您尝试使用objectMapper从null值创建Json对象。您正在编写的对象似乎不是有效的json。因此，当您发送此正文时，Spring表示它无法读取消息，也就是您请求的正文，正如您所说，它是一个应用程序/json内容，但其中没有json。

要测试空正文，只需在测试中发送请求，只需删除。内容（requestBody）行，它应该可以工作！

---编辑1我以为它是因为身体而拒绝了信息，但事实上它似乎马上就对我起作用了。这是我的控制器和测试，您可以将其与完整代码进行比较：

@RestController()
@RequestMapping("end_point")
public class TestController {

    @PostMapping
    public ResponseEntity<Map<String, Object>> editFoo(@RequestBody Foo foo) {
       // if(foo == null) {
       //     return (new ResponseEntity<>(new HashMap<>(), HttpStatus.BAD_REQUEST));
       // }

        return (new ResponseEntity<>(new HashMap<>(), HttpStatus.OK));
    }
}


@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@AutoConfigureMockMvc
public class TestControllerTest {
    @Autowired
    private MockMvc mvc;

    @Autowired
    private ObjectMapper objectMapper;

    @Test
    public void test_body_is_null() throws Exception {

        Foo foo = null;
        String requestBody = objectMapper.writeValueAsString(foo);

        // Act + assert
        mvc
            .perform(
                post("/end_point")
                    .contentType("application/json")
                    .content(requestBody))
            .andExpect(status().isBadRequest());
    }
}

这是使用Spring Boot 2.1.6制作的。发布

---为记录编辑2如果您想在此处使用null验证，请参阅控制器的一个片段：

@RestController()
@RequestMapping("end_point")
@Validated
public class TestController {

    @PostMapping
    public ResponseEntity<Map<String, Object>> editFoo(@NotNull @RequestBody(required = false) Foo foo) {

        return (new ResponseEntity<>(new HashMap<>(), HttpStatus.OK));
    }
}

首先，必须将主体的required设置为false，因为默认值为true。然后，您必须在请求主体上添加@NotNull注释，并在控制器上添加@Validated。在这里，如果启动测试，您将看到请求失败，原因是：

org.springframework.web.util.NestedServletException: Request processing failed; nested exception is javax.validation.ConstraintViolationException: editFoo.foo: must not be null

正如你所说的，你有一个@ControlllerAdtions，然后你可以按照你的意愿映射异常！