Spring Boot无效枚举请求参数如何返回有意义的错误信息

Spring MVC的请求参数处理链路顺序为类型转换优先于JSR-380（@Valid）校验执行。当前接口直接将参数声明为RequestParams.Type枚举类型，传入无效字符串值时，Spring内置的枚举转换器会在类型转换阶段直接抛出TypeMismatchException，请求被框架直接拦截返回空响应体的400状态，完全不会进入自定义的EnumStringValidator校验逻辑。

方案1：全局捕获枚举类型转换异常，返回明确提示 #

通过@RestControllerAdvice实现全局异常处理器，专门拦截枚举转换失败的场景，自动拼接当前枚举允许传入的值返回，不需要修改现有接口代码，可覆盖所有接口的枚举参数校验场景。

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
import java.util.Arrays;
import java.util.stream.Collectors;

@RestControllerAdvice
public class GlobalParamExceptionHandler {

    @ExceptionHandler(MethodArgumentTypeMismatchException.class)
    public ResponseEntity<String> handleEnumConvertError(MethodArgumentTypeMismatchException ex) {
        Class<?> targetType = ex.getRequiredType();
        // 仅针对枚举类型的转换失败生成明确提示
        if (targetType != null && targetType.isEnum()) {
            String validValues = Arrays.stream(targetType.getEnumConstants())
                    .map(item -> ((Enum<?>) item).name())
                    .collect(Collectors.joining(", "));
            String errorTip = String.format("invalid %s please insert any of values: %s",
                    ex.getName(), validValues);
            return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(errorTip);
        }
        // 其他类型转换错误返回通用提示
        return ResponseEntity.status(HttpStatus.BAD_REQUEST)
                .body("invalid parameter: " + ex.getName());
    }
}

方案2：自定义枚举转换器，替换Spring默认转换逻辑 #

如果需要自定义枚举匹配规则（比如支持大小写不敏感、忽略首尾空格），可以实现自定义的String转枚举转换器工厂，替换Spring默认的枚举转换逻辑，转换失败时直接抛出携带明确提示的异常，再配合全局异常捕获返回响应：

import org.springframework.core.convert.converter.Converter;
import org.springframework.core.convert.converter.ConverterFactory;
import org.springframework.stereotype.Component;
import java.util.Arrays;
import java.util.stream.Collectors;

@Component
public class CustomStringToEnumConverterFactory implements ConverterFactory<String, Enum> {
    @Override
    public <T extends Enum> Converter<String, T> getConverter(Class<T> targetEnumType) {
        return source -> {
            if (source == null || source.isBlank()) {
                return null;
            }
            String trimSource = source.trim();
            // 匹配枚举值，支持大小写不敏感
            for (T enumConstant : targetEnumType.getEnumConstants()) {
                if (enumConstant.name().equalsIgnoreCase(trimSource)) {
                    return enumConstant;
                }
            }
            // 匹配失败抛出带明确提示的异常
            String validValues = Arrays.stream(targetEnumType.getEnumConstants())
                    .map(Enum::name)
                    .collect(Collectors.joining(", "));
            throw new IllegalArgumentException(
                    String.format("invalid value please insert any of: %s", validValues)
            );
        };
    }
}

将该转换器注册到Spring MVC配置后即可生效，不需要修改原有接口的参数声明。

注意：你提供的EnumStringValidator代码末尾多了一个多余的闭合大括号}，修复后可与上述方案配合使用：空值场景走@EnumString的校验逻辑，非法值场景走类型转换阶段的错误提示，覆盖全部参数异常场景。

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