2. 使用許可API一覧作成ツール¶

2.1. 概要¶

本ツールは、使用不許可APIチェックツールの設定ファイルとなる公開APIの一覧と、公開APIのJavadocを生成する。

生成される使用許可API一覧をそのまま「使用不許可APIチェックツール」の設定ファイルとして利用することで、 プロジェクトで実装した基盤部品などについて、業務アプリからの利用を想定していない非公開APIが利用されていないかどうかを使用不許可APIチェックツールを利用してチェックすることができる。

Nablarchが提供する公開APIの一覧は、以下のURLから取得できる。 使用しているNablarchバージョンに対応したファイルをtagから取得すること。

https://github.com/nablarch/nablarch-single-module-archetype/tree/master/nablarch-web/tools/static-analysis/findbugs/published-config (外部サイト)

各ファイルの詳細は 使用不許可APIチェックツール を参照すること。

2.2. ツール配置場所¶

本ツールはnablarch-toolbox-XXX.jarの一部であり、maven antrun plugin を使用してantのJavadocタスクとして実行する。[1] 詳細は、使用方法の項を参照。

2.3. 使用方法¶

本ツールは、Javadocを生成する際に利用するDocletとして提供される。

Javadoc生成時に以下のDocletを利用し、必要なオプションを渡すことで使用許可API一覧および使用許可APIのみが出力されているJavadocが生成される。

本ツールが提供するDoclet

nablarch.tool.published.doclet.PublishedDoclet

必要な引数

出力対象

nablarch.core.util.annotation.Publishedアノテーションの付与された、

• クラス
• コンストラクタ
• メソッド
• フィールド
• アノテーション

が出力対象となる。

引数tagに出力対象タグが指定されている場合、該当するtag属性が指定されているPublishedアノテーションが付与されたものと、 tag属性が指定されていないPublishedアノテーションが付与されたものが出力対象となる。

引数tagが指定されない場合には、tag属性が指定されていないPublishedアノテーションが付与されたものが出力対象となる。

<target name="PublishedDoclet">
  <javadoc sourcepath="${executed.project.basedir}/src/main/java"
           destdir="${executed.project.basedir}/target/apidocs"
           Encoding="UTF-8"
           classpathref="classpath.common"
           failonerror="false" >
    <!-- docletタグで、使用許可API一覧作成ツールのDocletクラスと、必要なクラスパスを設定する。 -->
    <doclet name="nablarch.tool.published.doclet.PublishedDoclet" pathref="classpath.common">
      <!-- 出力対象とするタグを指定する。指定しない場合には不要。 -->
      <param name="-tag" value="${publish_config_tag}"/>
      <!-- 使用許可API一覧の出力先ファイルを指定する。 -->
      <param name="-output" value="${nablarch.tools.dir}/static-analysis/findbugs/published-config/production/${publish_config_name}.config"/>
    </doclet>
  </javadoc>
</target>

mvn antrun:run -Dtarget=PublishedDoclet -Dpublish_config_name=Test -Dpublish_config_tag=architect