我正在创建一个Spring-Boot微服务REST API,它需要@RequestParam
类型的List<String>
。如何验证列表是否包含最小值和最大值?
到目前为止,我已经尝试使用@Size(min=1, max=2)
,它也应该支持集合(javax.validation.constraints.Size
)。
我也尝试添加@Valid
和BindingResult
参数以及@Size
注释,但没有成功。
我更喜欢使用类似于第一个例子的解决方案,使用更紧凑和整洁的@Size(min=1, max=2)
。这是针对Spring-Boot 2.1.2.RELEASE。
@RestController
public class MyApi {
@GetMapping(value = "/myApi", produces = { APPLICATION_JSON_VALUE })
public ResponseEntity<List<MyObject>> getSomething(@Valid @RequestParam(value = "programEndTime", required = false) @Size(min = 1, max = 2) List<String> programEndTime, BindingResult result) {
if (result.hasErrors()) {
System.out.println("Error");
} else {
System.out.println("OK");
}
}
}
我希望能够达到System.out.println("Error")
线,但它实际上已被跳过。
如果您正在使用方法参数验证,则应使用@Validated
为the documentation注释您的控制器:
要获得Spring驱动的方法验证资格,所有目标类都需要使用Spring的
@Validated
注释进行注释。 (或者,您也可以声明要使用的验证组。)有关Hibernate Validator和Bean Validation 1.1提供程序的设置详细信息,请参阅MethodValidationPostProcessor
javadoc。
这意味着您应该将代码更改为:
@Validated // Add this
@RestController
public class MyApi {
// ...
}
之后,如果验证不匹配,它将抛出ContraintViolationException
。
请注意,因为你只有一个@Size()
注释,如果你不提供programEndTime
,该集合将是null
,这也将是有效的。如果你不想这样,你也应该添加一个@NotNull
注释,或者从required = false
中删除@RequestParam
值。
您不能使用BindingResult
来检索错误,因为这仅适用于模型属性或请求主体。你能做什么,是为ConstraintViolationException
定义一个异常处理程序:
@ExceptionHandler(ConstraintViolationException.class)
public void handleConstraint(ConstraintViolationException ex) {
System.out.println("Error");
}
您可以使用Class和@RequestBody进行参数验证,这与我一样成功。
public class Test {
@Size(min = 1 , max = 5)
private List<String> programEndTime;
public List<String> getProgramEndTime() {
return programEndTime;
}
public void setProgramEndTime(List<String> programEndTime) {
this.programEndTime = programEndTime;
}
}
@PostMapping("test")
public void test( @Valid @RequestBody Test test,
BindingResult result){
if (result.hasErrors()) {
System.out.println("Error");
} else {
System.out.println("OK");
}
System.out.println(",.,.");
}
根据Bean Validator 2.0,Hibernate Validator 6.x,您可以直接在参数化类型上使用约束。
@GetMapping(path = "/myApi", produces = { APPLICATION_JSON_VALUE })
public ResponseEntity<List<MyObject>> getSomething(@RequestParam(value = "programEndTime", required = false) List<@Size(min = 1, max = 2) String> programEndTimes)
有关更多信息,请查看Container element constraints。