如何为枚举类型添加自定义校验失败提示信息？

因为Spring在将请求参数绑定到枚举类型时，会先执行类型转换，这个过程发生在@Valid注解的校验之前，所以自定义校验注解无法拦截转换失败的异常。以下是几种可行的解决方案：

方法一：自定义枚举转换器+全局异常处理 #

自定义转换器接管枚举的转换逻辑，转换失败时抛出带自定义消息的异常，再通过全局异常处理器统一返回友好提示。

1. 实现自定义转换器 #

import org.springframework.core.convert.converter.Converter;
import org.springframework.stereotype.Component;

@Component
public class EngineTypeConverter implements Converter<String, EngineType> {
    @Override
    public EngineType convert(String source) {
        if (source == null || source.length() != 1) {
            throw new IllegalArgumentException("发动机类型无效，请输入F/B/Q其中一个");
        }
        char id = source.charAt(0);
        for (EngineType type : EngineType.values()) {
            if (type.getId() == id) {
                return type;
            }
        }
        throw new IllegalArgumentException("发动机类型无效，请输入F/B/Q其中一个");
    }
}

2. 全局异常处理器捕获异常 #

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;

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler({IllegalArgumentException.class, MethodArgumentTypeMismatchException.class})
    public ResponseEntity<String> handleEnumConversionError(Exception e) {
        return new ResponseEntity<>(e.getMessage(), HttpStatus.BAD_REQUEST);
    }
}

方法二：全局注册自定义PropertyEditor #

通过@InitBinder为枚举类型注册自定义编辑器，直接在转换阶段抛出自定义错误信息。

import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.beans.PropertyEditorSupport;

@RestControllerAdvice
public class GlobalBinderConfig {

    @InitBinder
    public void initBinder(WebDataBinder binder) {
        binder.registerCustomEditor(EngineType.class, new PropertyEditorSupport() {
            @Override
            public void setAsText(String text) throws IllegalArgumentException {
                if (text == null || text.length() != 1) {
                    throw new IllegalArgumentException("发动机类型只能是F、B或Q");
                }
                char id = text.charAt(0);
                for (EngineType type : EngineType.values()) {
                    if (type.getId() == id) {
                        setValue(type);
                        return;
                    }
                }
                throw new IllegalArgumentException("发动机类型只能是F、B或Q");
            }
        });
    }
}

方法三：枚举静态工厂方法（单枚举场景） #

在枚举类中添加静态工厂方法处理转换，适合单个枚举的特殊场景，但通用性较差。

1. 枚举类添加静态方法 #

public enum EngineType{
  FOO('F'),
  BAR('B'),
  QUX('Q');
  private char id;

  EngineType(char id) {
    this.id = id;
  }

  public char getId() {
    return this.id;
  }

  public static EngineType fromId(String idStr) {
      if (idStr == null || idStr.length() != 1) {
          throw new IllegalArgumentException("无效的发动机类型");
      }
      char id = idStr.charAt(0);
      for (EngineType type : values()) {
          if (type.getId() == id) {
              return type;
          }
      }
      throw new IllegalArgumentException("无效的发动机类型");
  }
}

2. 控制器参数指定转换方法 #

@PostMapping("/details")
public String saveDetails(@RequestParam("myEnum") EngineType myEnum) {
    // 业务逻辑处理
    return "success";
}

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