Spring 的 @RequestParam 与枚举

Question

我有这个枚举：

public enum SortEnum {
    asc, desc;
}

我想用作休息请求的参数：

@RequestMapping(value = "/events", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE)
public List<Event> getEvents(@RequestParam(name = "sort", required = false) SortEnum sort) {

当我发送这些请求时它工作正常

/events 
/events?sort=asc
/events?sort=desc

但是当我发送时：

/events?sort=somethingElse

我收到 500 响应，控制台中显示这条消息：

2016-09-29 17:20:51.600 DEBUG 5104 --- [  XNIO-2 task-6] com.myApp.aop.logging.LoggingAspect   : Enter: com.myApp.web.rest.errors.ExceptionTranslator.processRuntimeException() with argument[s] = [org.springframework.web.method.annotation.MethodArgumentTypeMismatchException: Failed to convert value of type [java.lang.String] to required type [com.myApp.common.SortEnum]; nested exception is org.springframework.core.convert.ConversionFailedException: Failed to convert from type [java.lang.String] to type [@org.springframework.web.bind.annotation.RequestParam com.myApp.common.SortEnum] for value 'somethingElse'; nested exception is java.lang.IllegalArgumentException: No enum constant com.myApp.common.SortEnum.somethingElse]
2016-09-29 17:20:51.600 DEBUG 5104 --- [  XNIO-2 task-6] com.myApp.aop.logging.LoggingAspect   : Exit: com.myApp.web.rest.errors.ExceptionTranslator.processRuntimeException() with result = <500 Internal Server Error,com.myApp.web.rest.errors.ErrorVM@1e3343c9,{}>
2016-09-29 17:20:51.601  WARN 5104 --- [  XNIO-2 task-6] .m.m.a.ExceptionHandlerExceptionResolver : Resolved exception caused by Handler execution: org.springframework.web.method.annotation.MethodArgumentTypeMismatchException: Failed to convert value of type [java.lang.String] to required type [com.myApp.common.SortEnum]; nested exception is org.springframework.core.convert.ConversionFailedException: Failed to convert from type [java.lang.String] to type [@org.springframework.web.bind.annotation.RequestParam com.myApp.common.SortEnum] for value 'somethingElse'; nested exception is java.lang.IllegalArgumentException: No enum constant com.myApp.common.SortEnum.somethingElse

有没有办法防止 spring 抛出这些异常并将枚举设置为空？

编辑

Strelok 接受的答案有效。但是，我决定处理 MethodArgumentTypeMismatchException。

@ControllerAdvice
public class ExceptionTranslator {

    @ExceptionHandler(MethodArgumentTypeMismatchException.class)
    @ResponseBody
    public ResponseEntity<Object> handleMethodArgumentTypeMismatchException(MethodArgumentTypeMismatchException e) {
        Class<?> type = e.getRequiredType();
        String message;
        if(type.isEnum()){
            message = "The parameter " + e.getName() + " must have a value among : " + StringUtils.join(type.getEnumConstants(), ", ");
        }
        else{
            message = "The parameter " + e.getName() + " must be of type " + type.getTypeName();
        }
        return buildResponse(HttpStatus.UNPROCESSABLE_ENTITY, message);
    }

Answer 1

您可以创建一个自定义转换器，在提供无效值时将 return null 而不是异常。

像这样：

@Configuration
public class MyConfig extends WebMvcConfigurationSupport {
   @Override
   public FormattingConversionService mvcConversionService() {
       FormattingConversionService f = super.mvcConversionService();
       f.addConverter(new MyCustomEnumConverter());
       return f;
   }
}

一个简单的转换器可能如下所示：

public class MyCustomEnumConverter implements Converter<String, SortEnum> {
    @Override
    public SortEnum convert(String source) {
       try {
          return SortEnum.valueOf(source);
       } catch(Exception e) {
          return null; // or SortEnum.asc
       }
    }
}

Answer 2

您需要执行以下操作

@InitBinder
public void initBinder(WebDataBinder dataBinder) {
    dataBinder.registerCustomEditor(YourEnum.class, new YourEnumConverter());
}

参考以下内容：https://machiel.me/post/java-enums-as-request-parameters-in-spring-4/

Answer 3

目前提供的答案并不完整。这是一个对我有用的分步答案示例：-

1st 在端点签名（订阅类型）中定义枚举。
示例：

public ResponseEntity v1_getSubscriptions(@PathVariable String agencyCode,
                                          @RequestParam(value = "uwcompany", required = false) String uwCompany,
                                          @RequestParam(value = "subscriptiontype", required = false) SubscriptionType subscriptionType,
                                          @RequestParam(value = "alert", required = false) String alert,

2nd 定义一个自定义属性编辑器，用于将字符串转换为枚举：

import java.beans.PropertyEditorSupport;

public class SubscriptionTypeEditor extends PropertyEditorSupport {

    public void setAsText(String text) {
        try {
            setValue(SubscriptionType.valueOf(text.toUpperCase()));
        } catch (Exception ex) {
            setValue(null);
        }
    }
}

3rd 向控制器注册属性编辑器：

@InitBinder ("subscriptiontype")
public void initBinder(WebDataBinder dataBinder) {
    dataBinder.registerCustomEditor(SubscriptionType.class, new SubscriptionTypeEditor());
}

从字符串到枚举的转换现在应该完美无缺了。

Answer 4

如果您使用 Spring 启动，this is the reason 您不应该使用 WebMvcConfigurationSupport。

最佳实践，您应该实现接口 org.springframework.core.convert.converter.Converter，并带有注解 @Component。然后 Spring Boot 将自动加载所有 Converter 的 bean。 Spring Boot code

@Component
public class GenderEnumConverter implements Converter<String, GenderEnum> {
    @Override
    public GenderEnum convert(String value) {
        return GenderEnum.of(Integer.valueOf(value));
    }
}

Demo Project

Answer 5

您可以使用 String 而不是 SortEnum 参数

@RequestParam(name = "sort", required = false) String sort

并使用

转换它

SortEnum se;
try {
   se = SortEnum.valueOf(source);
} catch(IllegalArgumentException e) {
   se = null;
}

在 getEvents(...) 端点方法内部失去了优雅，但获得了对转换和可能的错误处理的更多控制。

Answer 6

如果您已经在实施 WebMvcConfigurer，而不是 WebMvcConfigurationSupport，您可以通过实施方法 addFormatters

添加新转换器]

  @Override
  public void addFormatters(FormatterRegistry registry) {
    registry.addConverter(new MyCustomEnumConverter());
  }

Answer 7

如果您有多个枚举，那么如果您遵循其他答案，您最终将为每个枚举创建一个转换器。

这是适用于所有枚举的解决方案。

Converter 或 PropertyEditorSupport 在这种情况下不合适，因为它们不允许我们知道目标 class。

在此示例中，我使用了 Jackson ObjectMapper，但您可以通过反射调用静态方法来替换这部分，或者将对 values() 的调用移至转换器。

@Component
public class JacksonEnumConverter implements GenericConverter {

    private ObjectMapper mapper;

    private Set<ConvertiblePair> set;

    @Autowired
    public JacksonEnumConverter(ObjectMapper mapper) {
        set = new HashSet<>();
        set.add(new ConvertiblePair(String.class, Enum.class));
        this.mapper = mapper;
    }

    @Override
    public Set<ConvertiblePair> getConvertibleTypes() {
        return set;
    }

    @Override
    public Object convert(Object source, TypeDescriptor sourceType, TypeDescriptor targetType) {
        if (source == null) {
            return null;
        }
        try {
            return mapper.readValue("\"" + source + "\"", targetType.getType());
        } catch (IOException e) {
            throw new InvalidFieldException(targetType.getName(),source.toString());
        }
    }
}

在这种情况下，因为我使用的是 Jackson，枚举 class 必须有一个用 @JsonCreator 注释的静态方法，这样我就可以使用值而不是常量名称进行映射：

public enum MyEnum {

    VAL_1("val-1"), VAL_2("val-2");

    private String value;

    MyEnum(String value) {
        this.value = value;
    }

    @JsonValue
    public String getValue() {
        return value;
    }

    @JsonCreator(mode = JsonCreator.Mode.DELEGATING)
    public static MyEnum fromValue(String value) {
        for (MyEnum e : values()) {
            if (e.value.equalsIgnoreCase(value)) {
                return e;
            }
        }
        throw new InvalidFieldException("my-enum", value);
    }
}

与其返回 null，不如抛出异常。

Answer 8

您可以在 ENUM 中使用 @JsonValue 注释。检查这个 - https://www.baeldung.com/jackson-serialize-enums

Answer 9

使用一些最近的 Spring 版本，根据 2021 年 8 月，以下代码最简单并且可以正常工作。唯一棘手的部分是 deserializeByName() 方法，您需要将其添加到枚举中，其余代码通常。

public enum WorkplanGenerationMode {

    AppendWorktypes("AppendWorktypes"),
    New("New");

    private String value;

    WorkplanGenerationMode(String value) {
        this.value = value;
    }

    @JsonValue
    public String getValue() {
        return value;
    }

    @JsonCreator
    public static WorkplanGenerationMode deserializeByName(@JsonProperty("name") String name) {
        return WorkplanGenerationMode.valueOf(name);
    }


}

然后到下面的端点一个字符串值进来，并被转换成正确的枚举值，java 枚举成员用它初始化。

public ResponseEntity<List<WorkplanGenerationProgressDTO>> generate(@RequestBody WorkplanFromBaseRequest request) {

注意！ WorkplanGenerationMode 是 WorkplanFromBaseRequest 的任何成员的类型，如下所示：

@Data
public class WorkplanFromBaseRequest {

    private WorkplanGenerationMode mode;

Spring 的 @RequestParam 与枚举

Spring's @RequestParam with Enum

java

spring

spring-boot

spring-web