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

Question

我有一个类，如下所示：

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

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

我得到以下错误：

[错误]无法执行目标组织。阿帕奇。专家插件：maven javadoc插件：2.10。4:project foo上的javadoc（默认cli）：JavaDocs报告生成中发生错误：
[错误]退出代码：1-/home/workspace/foo/src/main/java/com/foo/foo。java:34:错误：找不到symbol
[error]公共静态FooBuilder生成器（字符串参数）
[error]^
[error]符号：类FooBuilder
[error]位置：类Foo

Answer 1

使现代化

如果您使用maven javadoc插件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的delombok特性（参见：https://projectlombok.org/features/delombok）。

lombok不包括所有工具。例如，lombok无法插入javadoc。。。在java源代码上运行。Delombok仍然允许您通过将java代码预处理为java代码并应用lombok的所有转换，将lombok与这些工具一起使用。

我通过添加以下插件使用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>

Answer 3

Lombok实际上能够填充一个部分定义的构建器类，因此您可以声明足够多的构建器，以使Javadoc满意，并将其保留。不需要去德隆博克。

在这种情况下，以下几点对我起了作用：

@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 {}

}

旁注：您实际上可以使用此技术添加一些customer builder方法，因此它具有额外的功能。当我有集合时，我喜欢重载构建器方法，以便一次只能加载一个项。可能已经有一些技术可以做到这一点，但很高兴知道您可以手动改进构建器。