如何在Spring Boot 2.x中复用默认错误处理器的BindingResult渲染并整合验证JSON

我来帮你搞定这个问题！在Spring Boot 2.0.1.RELEASE中，要把默认的验证错误结构嵌入到自定义的API失败响应里，核心思路是捕获Spring抛出的MethodArgumentNotValidException（这是@RequestBody参数验证失败时的标准异常），提取其中的验证详情，再封装到你符合API契约的响应结构中。下面是具体的实现方案：

1. 定义自定义响应DTO #

首先创建一个符合你API失败契约的响应类，专门用来封装错误信息，同时预留字段嵌入Spring的验证错误详情：

import lombok.Data;
import java.util.List;

@Data
public class ApiErrorResponse {
    // 自定义业务错误码
    private String errorCode;
    // 自定义错误提示文案
    private String errorMessage;
    // 嵌入Spring的验证错误详情列表
    private List<ValidationError> validationErrors;

    // 内部类用来映射Spring的字段验证错误
    @Data
    public static class ValidationError {
        // 验证失败的字段名
        private String field;
        // 错误提示信息（对应@NotBlank等注解的message）
        private String message;
        // 被拒绝的输入值
        private Object rejectedValue;
        // 验证规则的code（比如NotBlank、Size等）
        private String code;
    }
}

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

用@RestControllerAdvice定义全局异常处理类，专门捕获MethodArgumentNotValidException，提取验证错误并封装到自定义响应中：

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.List;
import java.util.stream.Collectors;

@RestControllerAdvice
public class GlobalValidationExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<ApiErrorResponse> handleValidationFailure(MethodArgumentNotValidException ex) {
        // 从异常中提取所有字段级验证错误，转换成自定义的ValidationError列表
        List<ApiErrorResponse.ValidationError> validationErrors = ex.getBindingResult()
                .getFieldErrors()
                .stream()
                .map(this::convertToCustomValidationError)
                .collect(Collectors.toList());

        // 构建符合你API契约的错误响应
        ApiErrorResponse errorResponse = new ApiErrorResponse();
        errorResponse.setErrorCode("PARAM_VALIDATION_FAILED");
        errorResponse.setErrorMessage("请求参数验证不通过，请检查输入");
        errorResponse.setValidationErrors(validationErrors);

        // 返回400 Bad Request状态码和自定义响应
        return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
    }

    // 把Spring的FieldError转换成自定义的ValidationError
    private ApiErrorResponse.ValidationError convertToCustomValidationError(FieldError fieldError) {
        ApiErrorResponse.ValidationError customError = new ApiErrorResponse.ValidationError();
        customError.setField(fieldError.getField());
        customError.setMessage(fieldError.getDefaultMessage());
        customError.setRejectedValue(fieldError.getRejectedValue());
        customError.setCode(fieldError.getCode());
        return customError;
    }
}

3. 验证效果 #

假设你的请求DTO是这样的：

import lombok.Data;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.Size;

@Data
public class UserCreateRequest {
    @NotBlank(message = "用户名不能为空")
    private String username;

    @Size(min = 6, message = "密码长度不能少于6位")
    private String password;
}

控制器方法：

import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid;

@RestController
@RequestMapping("/api/users")
public class UserController {

    @PostMapping
    public String createUser(@RequestBody @Valid UserCreateRequest request) {
        // 业务逻辑处理
        return "用户创建成功";
    }
}

当你发送一个不符合验证规则的请求（比如{"username":"", "password":"123"}），返回的响应会是这样的，完全符合你的自定义契约，同时嵌入了详细的验证错误：

{
  "errorCode": "PARAM_VALIDATION_FAILED",
  "errorMessage": "请求参数验证不通过，请检查输入",
  "validationErrors": [
    {
      "field": "username",
      "message": "用户名不能为空",
      "rejectedValue": "",
      "code": "NotBlank"
    },
    {
      "field": "password",
      "message": "密码长度不能少于6位",
      "rejectedValue": "123",
      "code": "Size"
    }
  ]
}

额外说明 #

• 如果需要处理全局级别的验证错误（不是字段级的），可以在异常处理方法中加入对ex.getBindingResult().getGlobalErrors()的处理，转换成对应的自定义错误结构即可。
• 如果你想更贴近Spring默认的错误结构，可以在ValidationError中添加codes、arguments等字段，直接从FieldError中获取对应值。
• 这个方案在Spring Boot 2.0.1.RELEASE中完全兼容，不需要额外的配置，@RestControllerAdvice会自动生效。

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