【问题标题】:How to customize Bean Validations ConstraintViolationException?如何自定义 Bean Validations ConstraintViolationException?
【发布时间】:2017-08-03 00:23:31
【问题描述】:

我想在我的 Spring @RestController 中验证端点的 @RequestBody。所以我创建了一个这样的方法:

@RequestMapping(value = ...)
public ResponseEntity<...> myPostMethod(@RequestBody MyBean myBean) throws Exception {

MyBean 用自定义的@Constraint 装饰,其各自的验证逻辑在我创建的ConstraintValidator 类上实现。这个验证器有一个类似的方法:

@Override
public boolean isValid(MyBean value, ConstraintValidatorContext context) {

这是所有验证逻辑发生的地方。当它失败时,isValid 返回false,我可以使用该context 参数以我想要的方式构建验证错误消息。此外,myPostMethod 也因自动(因为我自己不扔)MethodArgumentNotValidException 而失败,我将在全局处理程序上捕获它以呈现通用ResponseEntity。这一切都按预期工作。 问题是:如何不仅自定义验证错误消息,还自定义整个ConstraintViolationException?我想在异常中提供更多数据(来自我的业务域)以在响应正文 json 中呈现。

【问题讨论】:

    标签: java spring rest bean-validation


    【解决方案1】:

    我找到了答案:

    https://docs.jboss.org/hibernate/validator/5.4/api/org/hibernate/validator/constraintvalidation/HibernateConstraintValidatorContext.html#withDynamicPayload-java.lang.Object-

    public boolean isValid(MyBean value, ConstraintValidatorContext constraintValidatorContext) {
        HibernateConstraintValidatorContext context = constraintValidatorContext.unwrap(HibernateConstraintValidatorContext.class);
    
        // (...)
    
        context.buildConstraintViolationWithTemplate( "{foo}" )
            .withDynamicPayload(anyAdditionalInfo)
            .addConstraintViolation();
    
        return false;
    }
    

    【讨论】:

      【解决方案2】:

      假设您要传递的附加参数称为myParam。

      首先,在你的 Constraint 接口中为该参数声明一个访问器;

      public @interface MyConstraint {
      
          String message();
      
          Class<?>[] groups() default {};
      
          Class<? extends Payload>[] payload() default {};
      
          String myParam() default "some.value";
      }
      

      然后在ConstraintValidator 中,您可以访问这些参数,例如:

      public class MyValidator implements ConstraintValidator<MyConstraint, String> {
      
          private String myParam;
      
      
          @Override
          public void initialize(OpcoConstraint parameters) {
              code = parameters.myParam();
          }
      
          @Override
          public boolean isValid(String value, ConstraintValidatorContext context) {
      
              HibernateConstraintValidatorContext hibernateContext = context.unwrap(
                      HibernateConstraintValidatorContext.class
              );
      
              // you can pass any object as the payload
              hibernateContext.withDynamicPayload(Map.of("myParam", myParam));
          }
      }
      

      如果您从异常处理程序中捕获ConstraintViolationException 并希望从异常本身访问参数:

      要从ConstraintViolationException 中检索ConstraintViolation,请使用:

      constraintViolationException.getConstraintViolations();
      

      然后从ConstraintViolation 中检索动态负载:

      (Map) ((ConstraintViolationImpl) constraintViolation).getDynamicPayload(Map.class))
      

      【讨论】:

        猜你喜欢
        • 1970-01-01
        • 2021-11-23
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 2023-04-04
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        相关资源
        最近更新 更多