Spring Boot 处理javax.validation.ConstraintViolationException最佳方案

实现思路 #

采用Spring提供的@RestControllerAdvice注解实现全局异常统一处理，无需在每个Controller中重复编写异常处理逻辑，返回结果默认序列化为JSON格式，完全匹配需求。

具体实现步骤 #

1. 定义统一错误响应结构 #

先创建POJO类封装返回的错误信息：

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class ErrorResponse {
    // HTTP状态码
    private Integer code;
    // 错误提示信息
    private String message;
    // 异常发生时间戳
    private Long timestamp;
}

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

创建全局异常处理类，同时覆盖你遇到的两种异常场景：

import org.springframework.http.HttpStatus;
import org.springframework.transaction.TransactionSystemException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.util.stream.Collectors;

@RestControllerAdvice
public class GlobalExceptionHandler {

    // 直接处理参数校验异常
    @ExceptionHandler(ConstraintViolationException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public ErrorResponse handleConstraintViolationException(ConstraintViolationException e) {
        // 提取精简的校验错误信息，替代默认冗长的异常信息
        String errorMsg = e.getConstraintViolations()
                .stream()
                .map(ConstraintViolation::getMessage)
                .collect(Collectors.joining("；"));
        return new ErrorResponse(HttpStatus.BAD_REQUEST.value(), errorMsg, System.currentTimeMillis());
    }

    // 处理事务切面包裹导致的校验异常转换场景
    @ExceptionHandler(TransactionSystemException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public ErrorResponse handleTransactionSystemException(TransactionSystemException e) {
        // 校验根异常是否为参数校验异常
        if (e.getRootCause() instanceof ConstraintViolationException violationEx) {
            String errorMsg = violationEx.getConstraintViolations()
                    .stream()
                    .map(ConstraintViolation::getMessage)
                    .collect(Collectors.joining("；"));
            return new ErrorResponse(HttpStatus.BAD_REQUEST.value(), errorMsg, System.currentTimeMillis());
        }
        // 非校验导致的事务异常返回500错误
        return new ErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR.value(), "服务器内部错误", System.currentTimeMillis());
    }
}

额外优化建议 #

• 建议将参数校验逻辑前移到Controller层，给请求参数添加@Valid/@Validated注解，这样请求到达Service层之前就完成校验，不会触发事务异常的转换问题，性能和逻辑合理性更高。
• 可在全局异常处理器中补充MethodArgumentNotValidException的处理逻辑，覆盖@RequestBody参数校验的场景，实现所有参数校验异常的统一处理。

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