3.4. Java静的解析ツール

Javaの静的解析に使用するツールを説明する。

次のことを目的として、NablarchではJavaの静的解析ツールをNablarch開発環境構築ガイドに従って構築した環境（以後、デフォルトの環境）に設定して提供する。

  • Nablarchが定めるJavaコーディング規約に沿ったコーディングをアプリケーションプログラマに要求する。

  • 業務アプリケーション作成過程に埋め込んでしまった潜在的な不具合を検出する。

    重要

    デフォルトの環境に設定したJava静的解析ツールでは上記の目的をすべて保証することはできない。

    • アプリケーションプログラマに、「Nablarch アプリケーション開発標準」に沿ったコーディングを行うことを求める。
    • ソースコードレビューのレビュアーに、「Nablarch アプリケーション開発標準」に沿ったコーディングが行われていることを観点に入れレビューすることを求める。

デフォルトの環境に設定したJava静的解析ツールは次の2つである。

ツール名 公式サイト
FindBugs http://findbugs.sourceforge.net/
Checkstyle http://checkstyle.sourceforge.net/

これらのツールの詳細な設定方法、使用方法は公式サイトを参照のこと。

ちなみに

デフォルトの環境とは異なる環境を構築する場合、「Nablarch アプリケーション開発標準 => コーディング規約チェックツール設定ファイル」にあるFindBugsとCheckstyleの設定ファイルを使用すること。 これらの設定ファイルにより、デフォルトの環境と同一のチェックを行える。

Nablarchが定める使用許可API以外のAPI使用を検知する方法として、NablarchはFindbugsのカスタムルールを提供する。このツールの仕様および使用方法は下記を参照のこと。