javax的参数化错误消息。验证。限制。模式注释？

Question

我有一个具有类型为String的字段的实体，在该字段上我定义了一个@Pattern注释，强制执行与给定正则表达式匹配的字段内容。现在我想知道，是否可以参数化约束，例如在定义的验证错误消息中显示与正则表达式不匹配的第一个字符。

更糟糕的是，要显示的约束违反错误消息不是直接在注释中定义的，而是在属性文件中定义的，如下面所示的示例：

示例类：

public class Address {
  @Pattern(regexp="[a-zA-Z]*", message="paremeterizedMessage")
  private String street;
}

示例属性文件：

parameterizedMessage = Invalid character {0}. Only characters a-z, A-Z allowed.

有可能用javax做这样的事情吗。验证？我假设@Pattern注释无法参数化错误消息。但也许可以用参数化的验证消息定义我自己的ConstraintValidator？

Answer 1

考虑到一些验证注释，如@Size（min=1，max=5）允许参数化错误消息及其注释参数，如字符串的长度必须为{min}到{max}个字符，我找到了一个解决方案，可以解决带有占位符的参数化错误消息，例如{0}，{1}，…：

定义自己的验证约束，例如：

@Constraint(validatedBy=OnlyCharactersAllowedValidator.class)
@Documented
@Target({ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface OnlyCharactersAllowed {
    String message() default "parameterizedMessage";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

在验证器类中，反射可以用来扩展存储所有注释参数的映射（例如@size的min和max），并且可以为键0，1等添加其他参数：

public class OnlyCharactersAllowedValidator implements ConstraintValidator<OnlyCharactersAllowed,String>
{
    private static final String validCharacters = "abcdefghijklmnopqrstuvwxyz";
    @Override
    public boolean isValid(String text, ConstraintValidatorContext constraintContext)
    {
        for (int index = 0; index < text.length; index++) {
            String aCharacter = text.substring(index, index+1);
            if (validCharacters.indexOf(aCharacter) < 0) {
                /* Within this message call the magic happens: {0} is mapped to the invalid character. */
                addMessageParameter(constraintContext, aCharacter);
                /* Create violation message manually and suppress the default message. */   constraintContext.buildConstraintViolationWithTemplate(constraintContext.getDefaultConstraintMessageTemplate()).addConstraintViolation();
                constraintContext.disableDefaultConstraintViolation();
                /* No further validation: show only one error message for invalid characters. */
                break;
            }
        }
    }

    private void addMessageParameter(ConstraintValidatorContext constraintContext, Object... parameter)
    {
        try
        {
            /* Get map for parameters (reflection necessary). */
            Field descriptorField = ConstraintValidatorContextImpl.class.getDeclaredField("constraintDescriptor");
            descriptorField.setAccessible(true);
            @SuppressWarnings("unchecked")
            ConstraintDescriptorImpl<OnlyCharactersAllowed> descriptor = (ConstraintDescriptorImpl<OnlyCharactersAllowed>) descriptorField.get(constraintContext);

            Map<String,Object> attributes = descriptor.getAttributes();

            /* Copy immutable Map to new Map. */
            Map<String,Object> newAttributes = new HashMap<String,Object>(attributes.size() + parameter.length);
            for (String key : attributes.keySet())
            {
                newAttributes.put(key, attributes.get(key));
            }

            /* Add given parameters to attributes. */
            Integer parameterCounter = 0;
            for (Object param : parameter)
            {
                newAttributes.put(parameterCounter.toString(), param);
                parameterCounter++;
            }

            /* Set new Map in Descriptor (reflection necessary). */
            Field attributesField = ConstraintDescriptorImpl.class.getDeclaredField("attributes");
            attributesField.setAccessible(true);
            attributesField.set(descriptor, newAttributes);
        }
        catch (NoSuchFieldException | IllegalAccessException | SecurityException | ClassCastException e1)
        {
            /* Do nothing in case of exception. Unparameterized message is shown. */
        }
    }
}

即使验证消息是在属性文件（例如）中定义的，此解决方案也可以工作。

parameterizedMessage = Invalid character: Do not use the {0} character.