Spring Boot中如何用单个@ExceptionHandler处理多枚举验证异常

核心思路 #

要实现多枚举错误的统一返回，核心是先收集所有非法枚举字段的错误信息，再一次性抛出包含全部错误的异常，而不是遇到单个错误就终止校验流程。

具体实现步骤 #

1. 改造自定义异常类 NotValidEnumTypeException #

让异常类支持存储多个错误信息，用集合保存每条错误的字段和非法值描述：

public class NotValidEnumTypeException extends RuntimeException {
    private final List<String> errorDetails;

    public NotValidEnumTypeException(List<String> errorDetails) {
        super("存在多个非法枚举参数");
        this.errorDetails = errorDetails;
    }

    public List<String> getErrorDetails() {
        return errorDetails;
    }
}

2. 实现批量枚举校验（推荐用JSR380自定义注解） #

放弃在参数绑定阶段直接抛异常的方式，改用自定义校验注解实现批量校验：

// 自定义枚举校验注解
@Target(FIELD)
@Retention(RUNTIME)
@Constraint(validatedBy = EnumValueValidator.class)
public @interface ValidEnumValue {
    Class<? extends Enum<?>> enumClass();
    String message() default "非法枚举值";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

// 注解校验器实现
public class EnumValueValidator implements ConstraintValidator<ValidEnumValue, String> {
    private Set<String> validEnumValues;

    @Override
    public void initialize(ValidEnumValue constraintAnnotation) {
        Class<? extends Enum<?>> enumClazz = constraintAnnotation.enumClass();
        validEnumValues = Arrays.stream(enumClazz.getEnumConstants())
                .map(Enum::name)
                .collect(Collectors.toSet());
    }

    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (value == null) {
            return true; // 如需禁止空值，此处返回false并自定义提示
        }
        return validEnumValues.contains(value);
    }
}

然后在UserDTO的枚举字段上标记注解：

public class UserDTO {
    @ValidEnumValue(enumClass = UserTypeEnum.class, message = "用户类型仅支持ADMIN/USER")
    private String userType;

    @ValidEnumValue(enumClass = GenderEnum.class, message = "性别仅支持MALE/FEMALE")
    private String gender;
    // 其他字段
}

3. 改造全局异常处理器 #

在@RestControllerAdvice中捕获校验框架抛出的MethodArgumentNotValidException，提取所有错误信息并封装成统一响应：

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, Object>> handleValidationErrors(MethodArgumentNotValidException ex) {
        List<String> errorList = ex.getBindingResult()
                .getAllErrors()
                .map(DefaultMessageSourceResolvable::getDefaultMessage)
                .collect(Collectors.toList());

        Map<String, Object> response = new HashMap<>();
        response.put("code", 400);
        response.put("msg", "参数校验失败");
        response.put("errorDetails", errorList);

        return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
    }

    // 兼容自定义抛出的多错误异常
    @ExceptionHandler(NotValidEnumTypeException.class)
    public ResponseEntity<Map<String, Object>> handleMultiEnumErrors(NotValidEnumTypeException ex) {
        Map<String, Object> response = new HashMap<>();
        response.put("code", 400);
        response.put("msg", "枚举参数非法");
        response.put("errorDetails", ex.getErrorDetails());

        return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
    }
}

4. 开启Controller参数校验 #

在接收UserDTO的接口方法上添加@Valid或@Validated注解，触发批量校验：

@PostMapping("/users")
public ResponseEntity<UserVO> createUser(@RequestBody @Valid UserDTO userDTO) {
    // 业务逻辑处理
    return ResponseEntity.ok(userService.saveUser(userDTO));
}

最终效果 #

当请求同时传入非法的userType和gender时，返回的响应示例：

{
    "code": 400,
    "msg": "参数校验失败",
    "errorDetails": [
        "用户类型仅支持ADMIN/USER",
        "性别仅支持MALE/FEMALE"
    ]
}

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