如何在PutMapping接口中将@RequestBody参数设置为可选

解决方案 #

Spring MVC 中@RequestBody注解默认required属性为true，强制要求请求体必须存在，所以客户端不传请求体时就会抛出异常。你只需要修改注解配置将其设为非必填即可：

方法1：直接修改@RequestBody属性

给@RequestBody添加required = false配置，修改后的方法签名如下：

@PutMapping("/{id}/reject")
public Response<Foo> rejectFoo(@PathVariable("id") String id,
        @RequestBody(required = false) Bar bar) {

注意：请求体缺失时bar会被赋值为null，业务代码中需要先做非空判断再使用，避免触发空指针异常。

方法2：结合Optional包装（适配Spring 6+/Spring Boot 3+）

如果使用的是较新版本的Spring框架，你可以用JDK的Optional类包装参数，不需要手动加required = false，Spring会自动将空请求体映射为Optional.empty()：

@PutMapping("/{id}/reject")
public Response<Foo> rejectFoo(@PathVariable("id") String id,
        @RequestBody Optional<Bar> bar) {

后续可以直接通过bar.isPresent()判断客户端是否传递了请求体，写法更安全，也避免了手动判空的冗余代码。

内容的提问来源于stack exchange，提问作者Rpj