С помощью maven-javadoc-plugin, как загрузить класс, в котором содержится ссылка на тэглет?

Question

Я разработал пользовательский тег Javadoc, который использует отражение через API для получения информации о классе, на который ссылается теглет. Он загружает класс с помощьюClass.forName(String)".

Я смог заставить это работать в проекте для самого тега, даже до момента запуска интеграционных тестов с использованием "ToolProvider.getSystemDocumentationTool()"и проверка полученного содержимого.

Я установил этот артефакт на нашем сервере Nexus и пытаюсь сослаться на него из класса, созданного с помощью Maven и maven-javadoc-plugin,

Когда я впервые запустил сборку, в которой на мой тег ссылались в "Foo.java", я увидел исключение ClassNotFound в коде моего тега, сказав, что он не может найти указанный класс.

Это говорит мне, что он входит в мой код тэглета, но не может загрузить файл класса для рассматриваемого класса. Это иронично, так как единственный способ получить это - найти и проанализировать исходный файл, связанный с классом.

Итак, я отредактировал конфигурацию maven-javadoc-plugin, добавив "additionalDependencies"блок, указывающий артефакт, содержащий файл класса, который ссылается на тег.

Я также установилverbosemsgstr "флаг, и я увидел, что в результате вывода, когда он напечатал"search path for class files"Я нашел сосуд с артефактом с указанным классом в конце этого списка.

Тем не менее, я все еще получаю ошибку.

Что еще может быть не так?

Вот некоторые выдержки из соответствующего кода:

        <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]

Я осмотрел банку в конце списка и убедился, что рассматриваемый класс там.

Answer 1

Я решил, что добавление "AdditionalDependency", кажется, ничего не делает, что я вижу.

Что важно, чего я не ожидал, так это добавить зависимость как еще один "tagletArtifact". Я полагаю, если вы думаете об этом, это зависимость, необходимая для taglet. Когда я добавил GAV для артефакта, который производит сам POM, это наконец сработало.