1. 効率的なJava静的チェック¶

コードの品質と保守性を高めるために次の３つを実践する。

上記を行うために、NablarchではJetBrains社製のIDEである IntelliJ IDEA(外部サイト) の使用を推奨している。本ページでは、IntelliJ IDEAを用いた効率的なJava静的チェックの方法を説明する。

1.1. 構文チェックを行う ¶

構文のチェックには、IntelliJ IDEAの静的検査機能(Inspection)を使用する。 Inspectionは、Javaコーディングの慣例に沿っているか、潜在的なバグが含まれていないかなどをチェックし、リアルタイムに警告する機能である。

Nablarch開発に使用したInspectionの設定ファイルをプロジェクト向けに提供している。以下のファイルをダウンロードし PROJECT_ROOT/.idea/inspectionProfiles 配下に配置することでInspectionの設定が適用される。

重要

開発者間で同一の構文チェックが行われるようにするため、Inspectionの設定ファイルはVCSの管理対象とすること。

重要

Inspectionの設定内容は、警告された箇所から参照可能で、IDE上で効率よく確認できる。そのため、チェック内容の一覧など、別資料を作らないこと。

補足

InspectionはPJで必要に応じてカスタマイズできる。カスタマイズした設定は PROJECT_ROOT/.idea/inspectionProfiles 配下の設定ファイルに反映される。

IntelliJ IDEAのInspectionはデフォルトで設定が有効になっており、コードを書いた際にリアルタイムに実行される。詳細は、IntelliJのマニュアルを参照。

IntelliJ IDEAのInspectionは、CI(Jenkins)サーバでも実行することができる。設定方法はこちら(外部サイト) を参照。

フォーマットを統一するためには、IntelliJ IDEAのデフォルトのCode Styleを使用してフォーマットを行う。詳細は、IntelliJのマニュアルを参照。

重要

Code Styleの設定内容は、IDE上で効率よく確認できる。そのため、コーディング規約など、別資料を作らないこと。

IntelliJ IDEAでは、VCSへのコミット時にコミット対象のファイルに対してフォーマット処理を行う機能を有している。これを有効活用することで、確実にCode Styleに従ったコードをコミットできる。

このチェックにはIntelliJ IDEAのプラグインとIntelliJ IDEAに依存しないSpotBugsプラグインの2種類のツールを提供している。

nablarch-intellij-plugin はNablarch開発を支援するためのIntelliJ IDEA用のプラグインであり、下記の機能を有している。

使用不許可APIチェックツールはSpotBugsのプラグインとして作成されたツールである。詳細な仕様と実行方法は Nablarchスタイルガイドの解説を参照。なお、ブランクプロジェクトには Mavenで実行するための設定をあらかじめ設定してあるため、すぐにチェックを実施することが可能である。