如何在spring boot中从无效的enum请求param抛出有意义的错误信息？

Question

我接受API的枚举参数，但当我通过Postman使用无效参数时，我得到空白的400错误请求响应。我想要一条有意义的错误消息，如：“无效类型，请插入…”

 public ResponseEntity<JsonNode> getForType(

    @Parameter(name = "type") @Valid @RequestParam @EnumString(enumClass =  RequestParams.Type.class) RequestParams.Type type,
...

枚举字符串.java：

public @interface EnumString {
    Class<? extends Enum<?>> enumClass();
    String message() default "must be any of enum {enumClass}";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

EnumStringValidator.java：

public class EnumStringValidator implements ConstraintValidator<EnumString, Enum> {
    private List<String> acceptedValues;

    @Override
    public void initialize(EnumString annotation) {
        acceptedValues = Stream.of(annotation.enumClass().getEnumConstants())
                .map(Enum::name)
                .collect(Collectors.toList());
    }

    @Override
    public boolean isValid(Enum value, ConstraintValidatorContext context) {
        if (value == null) {
            return true;
        }

        return acceptedValues.contains(value.name());
    }
}
}

我创建了一个自定义验证器EnumString和EnumStringValidator，但类型甚至没有到达验证器。如果它是无效类型，那么它甚至不会进入验证。如何将参数保留为“类型枚举”，如果用户传递了无效的参数，我又如何抛出错误消息？

Answer 1

您的枚举代码遗漏了一些重要的元信息。

@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy=EnumStringValidator.class)
public @interface EnumString {
    Class<? extends Enum<?>> enumClass();
    String message() default "must be any of enum {enumClass}";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

Answer 2

我最终将输入参数改为字符串，而不是enum类型。我还使用了@ Schema(implementation = request params。Type.class)来大摇大摆地维护下拉列表。然后，我在java代码中添加了一些验证，以检查它是否与enum匹配，从而抛出一个正确的错误消息。

@Parameter(name = "type") @Valid @RequestParam @Schema(implementation = RequestParams.Type.class) String type