如何基于注释属性创建自定义验证消息？

Question

我正在使用Hibernate@NotNull验证器，我正在尝试创建自定义消息来告诉用户哪个字段在空时产生了错误。类似这样的东西：

notNull.custom = The field {0} can't be null.

（这将在我的ValidationMessages.properties文件中）。

其中，{0}应该是通过以下方式传递给验证程序的字段名：

@NotNull(field="field name")

我有办法做到吗？

Answer 1

如果您的需求可以通过插入Hibernate消息来满足，那么您可以像这样创建/命名您的*属性文件：

ValidationMessages.properties

在这里面：

javax.validation.constraints.NotNull.message = CUSTOMIZED MESSAGE WHEN NOTNULL is violated!

默认情况下，Hibernate搜索名为ValidationMessages的ResourceBundle。还可能涉及区域设置：ValidationMessages\u en，ValidationMessages\u de，

Hibernate将通过interpolatedMessage参数提供您自定义的消息，因此将显示所有ConstraintViolationExc0019相关信息（包括您的消息）。因此您的消息将是真正异常的一部分。将提供一些笨重的信息！

如果您想创建自定义异常（无默认ConstraintViolationException行为），请查看以下内容：

使用<代码> GANGIKAOD概念，考虑以下内容

  public void saveOrUpdate(IEntity<?> entity) {
      try {
          if(entity.getId == null) {
            em.persist(entity);
          } else {
            em.merge(entity)l
          }
      } catch(ConstraintViolationException cve) {
          throw new ConstraintViolationEx(constructViolationMessage(cve.getConstraintViolations()));
      }
  }

 private String constructMessage(Set<ConstraintViolation<?>> pConstraintViolations) {
    StringBuilder customMessages = new StringBuilder();
    for(ConstraintViolation<?> violation : pConstraintViolations) {
        String targetAnnotation = violation.getConstraintDescriptor().getAnnotation().annotationType().getSimpleName();
        if(supportsCustomMessage(targetAnnotation)) {
            applyMessage(violation, targetAnnotation, customMessages);
        } else {
            // do something with not customized constraints' messages e.g. append it to existing container
        }
    }
    return customMessages.toString();
 }

 private void applyMessage(ConstraintViolation<?> pViolation, String pTargetAnnotation, StringBuilder pCustomMessages) {
     String targetClass = pViolation.getRootBean().getClass().getName();
     String targetField = pViolation.getPropertyPath().toString();
     pCustomMessages.append(MessageFormat.format(getMessageByAnnotation(pTargetAnnotation), targetClass, targetField));
     pCustomMessages.append(System.getProperty("line.separator"));
 }


 private String getBundleKey() {
     return "ValidationMessages"; //FIXME: hardcoded - implement your true key
 }

 private String getMessageByAnnotation(String pTargetAnnotation) {
     ResourceBundle messages = ResourceBundle.getBundle(getBundleKey());
     switch(pTargetAnnotation) {
     case "NotNull":
         return messages.getString(pTargetAnnotation + ".message");
     default:
         return "";
     }
 }

 private boolean supportsCustomMessage(String pTargetAnnotation) {
     return customizedConstraintsTypes.contains(pTargetAnnotation);
 }

产生的结果：

test.model.exceptions.ConstraintViolationEx
    test.model.Person : name cannot be null
    test.model.Person : surname cannot be null

一个hibernateConstraintViolation提供了关于根类和受限字段的相关信息。如您所见，它适用于所有hibernate支持的约束，因此您需要检查当前注释是否可以由支持自定义CustomMessage（

您需要做的就是实现不受支持的约束逻辑。例如，它可以附加它的原因消息或插入默认消息（真正的异常会进入*日志文件）

Answer 2

要自定义注释消息，需要在isValid（）方法中禁用现有的违规消息，并生成新的违规消息并添加它。

constraintContext.disableDefaultConstraintViolation();
constraintContext.buildConstraintViolationWithTemplate(message).addConstraintViolation();

在下面给出的示例中，我根据“无效日期”、“不能大于今天日期”和“日期格式是否正确”创建了一个用于输入日期验证的注释。

@CheckDateIsValid(displayPattern = "DD/MM/YYYY", programPattern = "dd/MM/yyyy", groups = Order2.class)
    private String fromDate;

注释界面-

public @interface CheckDateIsValid {

    String message() default "default message";

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

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

    String displayPattern();

    String programPattern();
}

注释实现类-

    public class CheckDateIsValidValidator implements ConstraintValidator<CheckDateIsValid, String> {
    @Value("${app.country.timeZone}")
    private String timeZone;
    private String displayPattern;
    private String programPattern;

    @Override
    public void initialize(CheckDateIsValid constraintAnnotation) {
        this.displayPattern = constraintAnnotation.displayPattern();
        this.programPattern = constraintAnnotation.programPattern();
    }

    @Override
    public boolean isValid(String object, ConstraintValidatorContext constraintContext) {
        try {
            // disable existing violation message
            constraintContext.disableDefaultConstraintViolation();

            if (object == null) {
                return true;
            }

            final DateTimeFormatter formatter = DateTimeFormatter.ofPattern(programPattern);
            LocalDateTime time = LocalDate.parse(object, formatter).atStartOfDay();

            ZoneOffset zoneOffSet = ZoneOffset.of(timeZone);
            OffsetDateTime todayDateTime = OffsetDateTime.now(zoneOffSet);

            if (time == null) {
                customMessageForValidation(constraintContext, "date is not valid");
                return false;
            } else if (todayDateTime.isBefore(time.atOffset(zoneOffSet))) {
                customMessageForValidation(constraintContext, "can't be greater than today date");
                return false;
            }

            return time != null;
        } catch (Exception e) {
            customMessageForValidation(constraintContext, "date format should be like " + displayPattern);
            return false;
        }
    }

    private void customMessageForValidation(ConstraintValidatorContext constraintContext, String message) {
        // build new violation message and add it
        constraintContext.buildConstraintViolationWithTemplate(message).addConstraintViolation();
    }
}