Java中如何在ValidationException处理中获取错误字段名称

首先，javax.validation.ValidationException是验证异常的顶层父类，实际触发验证失败时抛出的通常是它的子类ConstraintViolationException——这个子类包含了具体的约束违规详情（包括字段名、错误信息等）。我们可以通过捕获这个子类来提取字段名，生成符合需求的自定义错误消息。

具体实现步骤 #

• 将异常处理器的参数改为ConstraintViolationException（或在方法内判断异常类型）
• 从ConstraintViolationException中获取Set<ConstraintViolation<?>>集合，每个元素对应一个违规字段的信息
• 通过ConstraintViolation的getPropertyPath()方法获取违规字段的名称
• 拼接包含字段名的自定义错误消息

修改后的代码示例（单字段违规场景） #

import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;

/**
 * Exception handler for validation exceptions.
 * Handles exceptions related to validation data, such as validation errors.
 * Returns a ResponseEntity with the appropriate error code, message, and HTTP
 * status code 400 (Bad Request).
 */
@ExceptionHandler(ConstraintViolationException.class)
public ResponseEntity<ApiError> handleValidationException(ConstraintViolationException exception) {
    // 获取第一个违规字段的信息
    ConstraintViolation<?> violation = exception.getConstraintViolations().iterator().next();
    String fieldName = violation.getPropertyPath().toString();
    
    // 拼接自定义错误消息
    String errorMessage = String.format("The number must be a whole number between 0 & %d for the field %s", 
            Long.MAX_VALUE, fieldName);
    
    return buildResponseEntity(ErrorCodes.INVALID_NUMBER, errorMessage, null, HttpStatus.BAD_REQUEST);
}

多字段违规场景处理 #

如果需要返回所有违规字段的错误信息，可以遍历ConstraintViolation集合拼接完整消息：

@ExceptionHandler(ConstraintViolationException.class)
public ResponseEntity<ApiError> handleValidationException(ConstraintViolationException exception) {
    StringBuilder errorMessage = new StringBuilder();
    for (ConstraintViolation<?> violation : exception.getConstraintViolations()) {
        String fieldName = violation.getPropertyPath().toString();
        errorMessage.append(String.format("The number must be a whole number between 0 & %d for the field %s; ", 
                Long.MAX_VALUE, fieldName));
    }
    // 移除末尾多余的分号和空格
    if (errorMessage.length() > 0) {
        errorMessage.setLength(errorMessage.length() - 2);
    }
    
    return buildResponseEntity(ErrorCodes.INVALID_NUMBER, errorMessage.toString(), null, HttpStatus.BAD_REQUEST);
}

补充：处理请求体验证异常 #

如果你的验证是基于Spring的@Valid注解在请求体上，抛出的可能是MethodArgumentNotValidException，需单独处理：

import org.springframework.validation.BindingResult;
import org.springframework.web.bind.MethodArgumentNotValidException;

@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity<ApiError> handleMethodArgumentNotValid(MethodArgumentNotValidException exception) {
    BindingResult result = exception.getBindingResult();
    // 获取第一个错误字段
    String fieldName = result.getFieldErrors().get(0).getField();
    String errorMessage = String.format("The number must be a whole number between 0 & %d for the field %s", 
            Long.MAX_VALUE, fieldName);
    
    return buildResponseEntity(ErrorCodes.INVALID_NUMBER, errorMessage, null, HttpStatus.BAD_REQUEST);
}

内容的提问来源于stack exchange，提问作者J.C