[英]Convert JSR-303 validation errors to Spring's BindingResult
我在 Spring 控制器中有以下代码:
@Autowired
private javax.validation.Validator validator;
@RequestMapping(value = "/submit", method = RequestMethod.POST)
public String submitForm(CustomForm form) {
Set<ConstraintViolation<CustomForm>> errors = validator.validate(form);
...
}
是否可以将errors
映射到 Spring 的BindingResult
对象,而无需手动检查所有错误并将它们添加到BindingResult
? 像这样的东西:
// NOTE: this is imaginary code
BindingResult bindingResult = BindingResult.fromConstraintViolations(errors);
我知道可以使用@Valid
注释CustomForm
参数并让 Spring 注入BindingResult
作为另一个方法的参数,但在我的情况下这不是一个选项。
// I know this is possible, but doesn't work for me
public String submitForm(@Valid CustomForm form, BindingResult bindingResult) {
...
}
一种更简单的方法可能是使用 Spring 的抽象org.springframework.validation.Validator
,您可以通过在上下文中使用此 bean 来获取验证器:
<bean id="jsr303Validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean" />
@Autowired @Qualifier("jsr303Validator") Validator validator;
有了这个抽象,你就可以这样使用验证器,传入你的 bindingResult :
validator.validate(obj, bindingResult);
Spring 使用 SpringValidatorAdapter 将 javax.validation.ConstraintViolation 对象转换为 ObjectError 或 FieldError 对象,如绑定结果中所示。 然后 BindStatus 使用消息源(如 Web 应用程序上下文本身)来转换错误。 简而言之,你可以这样做:
SpringValidatorAdapter springValidator = new SpringValidatorAdapter(validator);
BindingResult bindingResult= new BeanPropertyBindingResult(myBeanToValidate, "myBeanName");
springValidator.validate(myBeanToValidate, bindingResult);
这在编写单元测试时更容易,因为您甚至不需要创建 Spring 上下文。
@RequestMapping(value = "/submit", method = RequestMethod.POST)
public String submitForm(CustomForm form) {
Set<ConstraintViolation<CustomForm>> errors = validator.validate(form);
BindingResult bindingResult = toBindingResult(errors, form, "form");
...
}
private BindingResult toBindingResult(ConstraintViolationException e, Object object, String objectName) {
BindingResult bindingResult = new BeanPropertyBindingResult(object, objectName);
new AddConstraintViolationsToErrors().addConstraintViolations(e.getConstraintViolations(), bindingResult);
return bindingResult;
}
private static class AddConstraintViolationsToErrors extends SpringValidatorAdapter {
public AddConstraintViolationsToErrors() {
super(Validation.buildDefaultValidatorFactory().getValidator()); // Validator is not actually used
}
@SuppressWarnings({"rawtypes", "unchecked"})
public void addConstraintViolations(Set<? super ConstraintViolation<?>> violations, Errors errors) {
// Using raw type since processConstraintViolations specifically expects ConstraintViolation<Object>
super.processConstraintViolations((Set) violations, errors);
}
}
与此问题的其他答案不同,此解决方案处理已经存在需要转换为BindingResult
的Set<ConstraintViolation<?>>
的BindingResult
。
Spring 提供SpringValidatorAdapter
类来执行 bean 验证,将结果存储在Errors
实例中(注意BindingResult
扩展Errors
)。 此类的正常手动使用是使用它通过validate
方法执行验证:
Validator beanValidator = Validation.buildDefaultValidatorFactory().getValidator();
SpringValidatorAdapter validatorAdapter = new SpringValidatorAdapter(beanValidator);
BindException bindException = new BindException(form, "form");
validatorAdapter.validate(form, bindException);
但是,这在已经存在需要转换为BindingResult
的Set<ConstraintViolation<?>>
的情况下BindingResult
。
仍然有可能实现这个目标,尽管它确实需要跳过几个额外的箍。 SpringValidatorAdapter
包含一个processConstraintViolations
方法,该方法将ConstraintViolation
对象转换为适当的 Spring ObjectError
子类型,并将它们存储在Errors
对象上。 然而,这个方法是受保护的,限制了它对子类的访问。
可以通过创建SpringValidatorAdapter
的自定义子类来解决此限制,该子类委托或公开受保护的方法。 这不是典型的用法,但它有效。
public class AddConstraintViolationsToErrors extends SpringValidatorAdapter {
public AddConstraintViolationsToErrors() {
super(Validation.buildDefaultValidatorFactory().getValidator()); // Validator is not actually used
}
@SuppressWarnings({"rawtypes", "unchecked"})
public void addConstraintViolations(Set<? super ConstraintViolation<?>> violations, Errors errors) {
// Using raw type since processConstraintViolations specifically expects ConstraintViolation<Object>
super.processConstraintViolations((Set) violations, errors);
}
}
这个自定义类可用于填充新创建的BindingResult
,实现创建目标BindingResult
从Set<ConstraintViolation<?>>
。
private BindingResult toBindException(ConstraintViolationException e, Object object, String objectName) {
BindingResult bindingResult = new BeanPropertyBindingResult(object, objectName);
new AddConstraintViolationsToErrors().addConstraintViolations(e.getConstraintViolations(), bindingResult);
return bindingResult;
}
扩展 Kristiaan 的答案,出于测试目的,没有必要创建 spring 上下文来使用 Spring 的 bindingResult 进行验证。 下面是一个例子:
public class ValidatorTest {
javax.validation.Validator javaxValidator = Validation.buildDefaultValidatorFactory().getValidator();
org.springframework.validation.Validator springValidator = new SpringValidatorAdapter(javaxValidator);
@Test
public void anExampleTest() {
JSR303AnnotatedClassToTest ctt = new JSR303AnnotatedClassToTest( ..init vars..)
... test setup...
WebDataBinder dataBinder = new WebDataBinder(ctt);
dataBinder.setValidator(springValidator);
dataBinder.validate();
BindingResult bindingResult = dataBinder.getBindingResult();
... test analysis ...
}
}
这种方法不需要提前创建绑定结果,dataBinder 会为您构建正确的结果。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.