如何在Bean Validation验证请求体失败时返回自定义响应POJO？能否覆盖Spring默认响应？

这个问题我太有共鸣了——Spring默认的Bean Validation错误响应确实又长又冗余，完全没必要把那些内部的codes、arguments细节返回给前端。想要自定义响应结构，甚至完全替换掉默认的响应POJO，核心思路就是通过全局异常处理器拦截校验失败抛出的异常，然后返回我们自己定义的简洁响应。下面是具体的实现步骤：

1. 定义自定义响应POJO #

先写一个符合你需求的响应类，比如只包含错误信息的键值对结构：

public class CustomValidationErrorResponse {
    private Map<String, String> errors;

    // 构造方法、Getter/Setter
    public CustomValidationErrorResponse(Map<String, String> errors) {
        this.errors = errors;
    }

    public Map<String, String> getErrors() {
        return errors;
    }
}

2. 编写全局异常处理器 #

Spring在请求体验证失败时会抛出MethodArgumentNotValidException，我们用@RestControllerAdvice注解创建全局异常处理器，拦截这个异常并转换成自定义响应：

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.HashMap;
import java.util.Map;

@RestControllerAdvice
public class CustomValidationExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<CustomValidationErrorResponse> handleValidationExceptions(
            MethodArgumentNotValidException ex) {
        Map<String, String> errors = new HashMap<>();
        // 遍历所有校验错误，提取字段名和对应的错误提示
        ex.getBindingResult().getAllErrors().forEach(error -> {
            String fieldName = ((FieldError) error).getField();
            String errorMessage = error.getDefaultMessage();
            errors.put(fieldName, errorMessage);
        });
        return new ResponseEntity<>(new CustomValidationErrorResponse(errors), HttpStatus.BAD_REQUEST);
    }
}

3. 测试效果 #

现在当校验失败时，返回的响应就会变成简洁的键值对结构，比如：

{
  "errors": {
    "xyz": "xyz is mandatory parameter , please provide appropriate value"
  }
}

额外补充：覆盖GET请求参数校验的响应 #

如果你的项目里有GET请求参数的校验（比如用@Validated修饰Controller类），校验失败会抛出ConstraintViolationException，可以在同一个处理器里添加对应的处理方法，保证响应格式统一：

@ExceptionHandler(ConstraintViolationException.class)
public ResponseEntity<CustomValidationErrorResponse> handleConstraintViolationExceptions(
        ConstraintViolationException ex) {
    Map<String, String> errors = new HashMap<>();
    ex.getConstraintViolations().forEach(violation -> {
        // 提取请求参数名
        String fieldName = violation.getPropertyPath().toString();
        String errorMessage = violation.getMessage();
        errors.put(fieldName, errorMessage);
    });
    return new ResponseEntity<>(new CustomValidationErrorResponse(errors), HttpStatus.BAD_REQUEST);
}

这种方式已经完全覆盖了Spring的默认响应逻辑，所有校验失败的场景都会返回你自定义的POJO结构。

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