时间戳

首页 > 解决方案 > 如何验证@QueryParam？

spring - 如何验证@QueryParam？

问题描述

我有一个简单的 REST 资源，它接受几个查询参数。我想验证其中一个参数，并ConstraintValidator为此目的而遇到。REST 资源期望查询参数territoryId是 a UUID，所以我想验证它确实是一个有效的UUID.

我创建了一个@IsValidUUID注释和一个相应的IsValidUUIDValidator（即 a ConstraintValidator）。就我现在所拥有的而言，没有任何东西得到验证并getSuggestions接受我扔给它的任何东西。很明显我做错了什么。

我究竟做错了什么？

REST 资源现在如下所示：

@Component
@Path("/search")
public class SearchResource extends AbstractResource {

    @GET
    @Path("/suggestions")
    @Produces(MediaType.APPLICATION_XML)
    public Response getSuggestions(
            @QueryParam("phrase") List<String> phrases, 
            @IsValidUUID @QueryParam("territoryId") String territoryId) {

        [...]

    }
}

IsValidUUID

@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Constraint(validatedBy = {IsValidUUIDValidator.class})
public @interface IsValidUUID {

    String message() default "Invalid UUID";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

}

IsValidUUIDValidator

public class IsValidUUIDValidator implements ConstraintValidator<IsValidUUID, String> {

    @Override
    public void initialize(IsValidUUID constraintAnnotation) {

    }

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

        try {
            UUID.fromString(value);
            return true;

        } catch (Exception e) {
            context.disableDefaultConstraintViolation();
            context.buildConstraintViolationWithTemplate("The provided UUID is not valid")
                    .addConstraintViolation();

            return false;
        }

    }

}

标签： springvalidationspring-4

解决方案

您需要使用以下注释在 IsValidUUID 上设置支持的目标。

@SupportedValidationTarget(ValidationTarget.ANNOTATED_ELEMENT)

或者

@SupportedValidationTarget(ValidationTarget.PARAMETERS)

编辑：

抱歉，我无法直接在 RequestParam 上使其工作。但是，如果可以，请尝试创建一个 POJO，您可以将请求参数绑定到该 POJO，并使用您的约束来注释绑定字段。这对我有用。

public class MyModel {

    @IsValidUUID
    private String territoryId;

    public String getTerritoryId() {
        return territoryId;
    }
    public void setTerritoryId(String territoryId) {
        this.territoryId = territoryId;
    }

}

@GET
    @Path("/suggestions")
    @Produces(MediaType.APPLICATION_XML)
    public Response getSuggestions(
            @QueryParam("phrase") List<String> phrases, 
            @Valid @ModelAttribute MyModel myModel) {

        [...]

    }

推荐阅读