0

我开发了一个自定义 javadoc taglet，它通过 API 使用反射来获取有关 taglet 在其中引用的类的信息。它用“”加载类Class.forName(String)。

我能够让它在 taglet 本身的项目中工作，甚至可以使用“ ToolProvider.getSystemDocumentationTool()”运行集成测试并验证结果内容。

我现在已经在我们的 nexus 服务器中安装了这个工件，我试图从一个用 Maven 和maven-javadoc-plugin.

当我第一次运行在“Foo.java”中引用了我的标签的构建时，我在我的 taglet 代码中看到了 ClassNotFound 异常，说它找不到指定的类。

这告诉我它正在进入我的 taglet 代码，但它无法加载相关类的类文件。这有点讽刺，因为它可以到达这里的唯一方法是查找和解析与该类关联的源文件。

因此，我随后编辑了 maven-javadoc-plugin 配置，添加了一个“ additionalDependencies”块，指定包含引用该标记的类文件的工件。

我还设置了“ verbose”标志，我看到在结果输出中，当它打印“ search path for class files”时，我在该列表的末尾找到了带有相关类的工件 jar。

但是，我仍然收到错误消息。

这里还有什么问题？

以下是相关代码的一些摘录：

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>2.10.4</version>
            <configuration>
                <verbose>true</verbose>
                <additionalDependencies>
                    <additionalDependency>
                        <groupId>our.group.id</groupId>
                        <artifactId>our.artifact.id</artifactId>
                        <version>${current.pom.version}</version>
                    </additionalDependency>
                </additionalDependencies>
                <additionalparam>-Xdoclint:none</additionalparam>
                <taglets>
                    <taglet>
                        <tagletClass>packagepath.taglet.ValidationConstraintsTaglet</tagletClass>
                    </taglet>
                    <taglet>
                        <tagletClass>packagepath.taglet.ValidationConstraintsCombinedTaglet</tagletClass>
                    </taglet>
                </taglets>
                <tagletArtifact>
                    <groupId>our.group.id.taglets</groupId>
                    <artifactId>validationJavadocTaglet</artifactId>
                    <version>0.0.1-SNAPSHOT</version>
                </tagletArtifact>
            </configuration>
            <executions>
                <execution>
                    <id>module-javadoc-jar</id>
                    <phase>package</phase>
                    <goals>
                        <goal>jar</goal>
                    </goals>
                    <configuration>
                        <show>protected</show>
                        <detectLinks>false</detectLinks>
                    </configuration>
                </execution>
            </executions>
        </plugin>

下面是 Taglet 类中的部分代码，显示了包含类的加载：

@Override
public String toString(Tag tag) {
    String  className   = tag.holder().toString();

    StringBuilder   sb  = new StringBuilder();
    sb.append("<dt><b>Validation Constraints</b></dt>");
    sb.append("<dd>");
    sb.append("<table border=1><thead><tr><th>Property</th><th>Message</th></tr></thead>");
    sb.append("<tbody>");

    try {
        Class<?>    clazz   = Class.forName(className);

当我运行构建时，我看到了这个输出：

Generating C:\...\...\target\apidocs\help-doc.html...
[done in 2593 ms]
[WARNING] Javadoc Warnings
[WARNING] java.lang.ClassNotFoundException: ...Foo
[WARNING] at java.net.URLClassLoader.findClass(URLClassLoader.java:381)
[WARNING] at java.lang.ClassLoader.loadClass(ClassLoader.java:424)
[WARNING] at java.lang.ClassLoader.loadClass(ClassLoader.java:357)
[WARNING] at java.lang.Class.forName0(Native Method)
[WARNING] at java.lang.Class.forName(Class.java:264)
[WARNING] at ....taglet.ValidationConstraintsTaglet.toString(ValidationConstraintsTaglet.java:69)

我注意到输出中的以下行（详细打开）：

[search path for class files: C:\Program Files\Java\jdk1.8.0_102\jre\lib\resources.jar,...,C:\...\our.artifact.id\target\our.artifact.id-2.7.0-SNAPSHOT.jar]

我检查了列表末尾的 jar，并确认有问题的类在那里。

4

1 回答 1

0

我确定添加“additionalDependency”似乎没有做任何我能看到的事情。

重要的是，我没想到的是，将依赖项添加为另一个“tagletArtifact”。我想如果您考虑一下，它是 taglet 所需的依赖项。当我为 POM 本身正在生成的工件添加 GAV 时，这终于奏效了。

于 2017-07-19T15:49:16.120 回答