0

タグレットが参照されているクラスに関する情報を取得するために、API を介してリフレクションを使用するカスタム javadoc タグレットを開発しました。クラスに " " をロードしますClass.forName(String)。

ToolProvider.getSystemDocumentationTool()「 」を使用して統合テストを実行し、結果のコンテンツを検証するところまで、タグレット自体のプロジェクトでこれを機能させることができました。

このアーティファクトを nexus サーバーにインストールしました。Maven と で構築されたクラスから参照しようとしていmaven-javadoc-pluginます。

タグが "Foo.java" で参照されているビルドを最初に実行したとき、指定されたクラスが見つからないことを示す ClassNotFound 例外がタグレット コードに表示されました。

これは、タグレット コードに侵入していることを示していますが、問題のクラスのクラス ファイルをロードできません。これはちょっと皮肉なことです。ここにたどり着く唯一の方法は、クラスに関連付けられたソース ファイルを見つけて解析することです。

そこで、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