强制验证批注提供消息

Question

我正在使用Hibernate验证器进行POJO验证，并且我还创建了一些自定义验证。这是一个例子：

//lombok annotations
public class Address {
  @NotNull // standard
  @State //Custom created
  String country;
}

我们需要用特定的代码而不是消息来表示所有的验证错误。为了实现这一点，我们决定在使用的每个注释中指定代码。上面的示例现在看起来像这样：

//lombok annotations
public class Address {
  @NotNull(message="ERR_001")
  @State(message="ERR_002")
  String country;
}

但是这种方法有一个问题。我们不能强迫在注释中一直提供消息(在我们的例子中是错误代码)。对于自定义注释，它仍然是可以的，因为我们不提供默认消息，但是对于标准注释，有可能会错过它，如果我们不小心错过了提供自定义消息，就会悄悄地生成一个字符串消息。

是否有一种方法可以强制在注释中始终提供消息。保持一致性可能会有所帮助。

Answer 1

我找不到一个好办法来处理它。但目前我已经实施了一项测试，让我们对它有一些控制。这不是最好的解决方案，但目前解决了这个问题。

我使用classgraph来读取包内POJO类的所有注释，并在javax验证时对其进行过滤，如果默认消息似乎来自< code>javax.validation，那么我将添加到一个列表中。在稍后的单元测试中，我检查这个列表是否为空。

private List<String> getAnnotationProperties(String appliedOn, AnnotationInfoList annotationInfos) {
    return annotationInfos.stream()
            .filter(annotationInfo -> annotationInfo.getName().contains("javax.validation.constraints"))
            .filter(annotationInfo -> ((String) annotationInfo.getParameterValues().getValue("message")).contains("javax.validation.constraints"))
            .map(annotationInfo -> annotationInfo.getName())
            .collect(Collectors.toList());
    }

Answer 2

VII ntu-Checkstyle为Checkstyle提供了额外的检查，包括检查注释是否与所有必需的参数一起使用。

<module name="RequiredParameterForAnnotation">
  <property name="annotationName" value="NotNull"/>
  <property name="requiredParameters" value="message"/>
</module>

Answer 3

据我所知，没有办法做到这一点。也许最好的选择是创建自己的注释并使属性成为必需的。