使用Java Bean验证注释生成POJO的文档

时间:2017-09-26 08:45:43

标签: java javadoc bean-validation

我们有从XSD和JAXB生成的现有bean。 有很多(真的)XSD文件,因此该部分的编译需要一些时间。我们有一个自定义Maven插件,通过读取XSD生成所有bean的HTML目录。

我们希望摆脱JAXB,因为XSD中的文档没有保存在生成​​的bean中,而且用XML表示的某些约束没有正确地转换为Java或者没有足够强制执行。

我们希望使用Java Bean验证注释(必要时使用自定义注释)。

您是否了解现有的插件/库/将现有Javadoc注释与Java Bean Validation注释中生成的文档合并的内容?

import lombok.Getter;
import lombok.Setter;

import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

/**
 * Documentation...
 */
@Getter
@Setter
public class Bean {

    /**
     * Documentation with javadoc annotations
     */
    @NotNull
    @Size(min = 3, max = 20)
    private String message;

}

例如,对于message属性,文档将如下所示:

  

带有javadoc注释的文档
  "消息"不应该为空。
  "消息"大小必须在3到20个字符之间。

2 个答案:

答案 0 :(得分:0)

您应该尝试使用JAutoDoc插件生成Javadoc(eclipse,STS,..)。它有生成选择:替换现有的,完整的现有的,保持现有的。最重要的是,您可以自定义各种选择。 链接市场:https://marketplace.eclipse.org/content/jautodoc

答案 1 :(得分:0)

Bean Validation约束注释已经是生成的JavaDoc(或任何带有@Documented元注释的注释的一部分)。如果这还不够,您可以考虑编写一个自定义doclet,添加该约束元数据的文本表示。