Spring Boot实现请求头与请求体自动映射至Java POJO的通用方案

要实现无需手动编写@RequestHeader或request.getHeaders()，就能自动将请求头和请求体映射到同一个POJO的功能，可以通过扩展Spring的参数解析机制完成，具体步骤如下：

1. 定义自定义注解 #

1.1 标记参数的@RequestBodyAndHeader注解 #

用来替代@RequestBody，告诉Spring使用自定义解析逻辑处理该参数：

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface RequestBodyAndHeader {
}

1.2 标记字段映射关系的@HeaderMapping注解 #

用来指定POJO字段对应的请求头名称，以及是否为必填项：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface HeaderMapping {
    String value(); // 请求头名称
    boolean required() default false;
}

2. 修改POJO类 #

在需要映射请求头的字段上添加@HeaderMapping注解，绑定对应的请求头：

@Data
public class Customer {
    @JsonProperty("customerId")
    private long OMG;
    @JsonProperty("firstName")
    private String WTF;
    @JsonProperty("lastName")
    private String LOL;
    @JsonProperty("town")
    private String YOLO;
    
    @HeaderMapping("Car-Type")
    private String carType;
    
    @HeaderMapping(value = "Car-Color", required = false)
    private String carColor;
}

3. 实现自定义参数解析器 #

实现HandlerMethodArgumentResolver接口，完成请求体解析+请求头映射的逻辑：

@Component
public class RequestBodyAndHeaderArgumentResolver implements HandlerMethodArgumentResolver {

    private final ObjectMapper objectMapper;

    public RequestBodyAndHeaderArgumentResolver(ObjectMapper objectMapper) {
        this.objectMapper = objectMapper;
    }

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        // 只处理带有@RequestBodyAndHeader注解的参数
        return parameter.hasParameterAnnotation(RequestBodyAndHeader.class);
    }

    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
        HttpServletRequest request = webRequest.getNativeRequest(HttpServletRequest.class);
        assert request != null;
        
        // 第一步：解析请求体为POJO实例
        Class<?> paramType = parameter.getParameterType();
        Object pojo = objectMapper.readValue(request.getInputStream(), paramType);
        
        // 第二步：遍历POJO字段，将对应请求头的值设置进去
        Field[] fields = paramType.getDeclaredFields();
        for (Field field : fields) {
            HeaderMapping headerMapping = field.getAnnotation(HeaderMapping.class);
            if (headerMapping != null) {
                String headerValue = request.getHeader(headerMapping.value());
                // 如果请求头存在，或者字段为必填，则赋值
                if (headerValue != null || headerMapping.required()) {
                    field.setAccessible(true);
                    field.set(pojo, headerValue);
                }
            }
        }
        
        return pojo;
    }
}

4. 注册自定义解析器 #

通过WebMvcConfigurer将自定义解析器添加到Spring的参数解析器列表：

@Configuration
public class WebConfig implements WebMvcConfigurer {

    private final RequestBodyAndHeaderArgumentResolver resolver;

    public WebConfig(RequestBodyAndHeaderArgumentResolver resolver) {
        this.resolver = resolver;
    }

    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
        resolvers.add(resolver);
    }
}

5. 改造Controller方法 #

使用@RequestBodyAndHeader注解替代@RequestBody，无需再手动处理请求头：

@GetMapping("/api/headers")
public ResponseEntity<Customer> getCarAuto(@RequestBodyAndHeader Customer customer) {
    return ResponseEntity.ok(customer);
}

扩展说明 #

• 如果需要支持非String类型的请求头字段（如Integer、Date），可以在解析器中添加类型转换逻辑，借助ConversionService完成转换
• 若请求体和请求头存在同名字段，当前逻辑是请求头值覆盖请求体值，可根据业务需求调整赋值顺序
• 可以给@HeaderMapping添加defaultValue属性，支持请求头缺失时设置默认值

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