使用 Java Bean 驗證注釋從 POJO 生成文檔

Question

我們有使用 JAXB 從 XSD 生成的現有 bean。 有很多（真的）XSD 文件，因此該部分的編譯需要一些時間。 我們有一個自定義 Maven 插件，它通過讀取 XSD 生成所有 bean 的 HTML 目錄。

我們想擺脫 JAXB，因為 XSD 中的文檔沒有保存在生成​​的 bean 中，並且一些用 XML 表示的約束沒有正確轉換為 Java 或沒有足夠強的執行。

我們想使用 Java Bean Validation 注解（必要時使用自定義注解）。

您是否知道現有的插件/庫/任何將現有 Javadoc 注釋與從 Java Bean 驗證注釋生成的文檔合並的東西？

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 個字符之間。

Answer 1

您應該嘗試使用 JAutoDoc 插件來生成 Javadoc（eclipse、STS 等）。 它有生成選擇：替換現有、完全現有、保持現有。 最重要的是，您可以自定義各種選擇。 鏈接市場： https : //marketplace.eclipse.org/content/jautodoc

Answer 2

Bean Validation 約束注釋已經是生成的 JavaDoc 的一部分（或任何真正使用@Documented元注釋的注釋）。 如果這還不夠，您可以考慮編寫一個自定義 doclet，它添加了該約束元數據的文本表示。