使用 Lombok 的 @Builder 注释时出现 Javadoc“找不到符号”错误

Question

我有一个如下所示的课程：

@Data
@Builder
public class Foo {
    private String param;

    /** My custom builder.*/
    public static FooBuilder builder(String _param){
        return builder().param(_param);
    }
}

我收到以下错误：

[错误] 无法在项目 foo 上执行目标 org.apache.maven.plugins:maven-javadoc-plugin:2.10.4:javadoc (default-cli)：JavaDocs 报告生成时出错：
[错误] 退出代码：1 - /home/workspace/foo/src/main/java/com/foo/Foo.java:34：错误：找不到符号
[错误] public static FooBuilder builder(String _param)
[错误] ^
[错误] 符号：类 FooBuilder
[错误] 位置：Foo 类

Answer 1

更新

如果你使用 maven-javadoc-plugin 3.2.0+，你可以这样配置：

  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>3.2.0</version>
    <configuration>
      <doclint>none</doclint>
    </configuration>
  </plugin>

doclint 配置将使 javadoc 插件不再抛出错误。它也会禁用 lint，但如果你觉得这可能是最好的方法，而不是 delombok。

如果您使用任何 CI 工具来构建和编译您的项目，您可以创建一个单独的作业来检查 javadoc lint。

对我来说，在构建中禁用 lint 并不是一件坏事。 Javadoc 很重要，但不应仅仅因为我使用 Lombok 就阻止我构建我的应用程序。

Answer 2

Lombok 实际上能够填充部分定义的构建器类，因此您可以声明足够多的构建器以使 Javadoc 满意，然后将其保留。无需delombok。

在这种情况下，以下内容对我有用：

@Data
@Builder
public class Foo {
    private String param;

    /** My custom builder.*/
    public static FooBuilder builder(String _param){
        return builder().param(_param);
    }

    public static class FooBuilder {}

}

旁注：您实际上可以使用这种技术来添加一些客户构建器方法，因此它有好处。当我有集合时，我喜欢重载构建器方法，这样我就可以一次一个项目。可能已经有一些技术可以做到这一点，但很高兴知道您可以手动改进构建器。

Answer 3

为了解决这个问题，我必须使用 Lombok 的 delombok 功能（参见：https://projectlombok.org/features/delombok）。

lombok 并未涵盖所有工具。例如，lombok 不能插入在 java 源上运行的 javadoc ...。 Delombok 仍然允许您通过这些工具使用 lombok，方法是将您的 java 代码预处理为已应用 lombok 的所有转换的 java 代码。

我使用 Maven 通过添加以下插件来做到这一点：

<plugin>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok-maven-plugin</artifactId>
    <version>1.18.0.0</version>
    <configuration>
        <sourceDirectory>${project.basedir}/src/main/java</sourceDirectory>
        <outputDirectory>${delombok.output}</outputDirectory>
        <addOutputDirectory>false</addOutputDirectory>
    </configuration>
    <executions>
        <execution>
            <phase>generate-sources</phase>
            <goals>
                <goal>delombok</goal>
            </goals>
        </execution>
    </executions>
</plugin>
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9</version>
    <configuration>
        <sourcepath>${delombok.output}</sourcepath>
    </configuration>
</plugin>