Checkstyleについて

Checkstyleとは

Javaプログラミング言語向けのソースコード静的解析ツールの1つ。
プログラムコードの品質やスタイルに関するルールに従ってソースコードを自動的に検査し、コーディング規約やベストプラクティスに適合しているかどうかを確認。
開発者がソースコードの品質を向上させ、一貫性を保つのに役立つ。
実際にプロジェクトへ導入する流れを説明していく。

インストール

個人的にプロジェクトではいつもgradleを使用するため、Checkstyleもgradleでインストールする。
(直接サイトからインストールすることも可能)
build.gradle内で以下コードを追記。
(2023/11の最新バージョンは10系があるためそれを使用。)

レポートを出力し画面で確認するため、以下も追記しておく。

設定ファイルと実行

config/checkstyle配下に設定ファイルcheckstyle.xmlを用意するため、チェック項目のベースとなるgoogle_checks.xmlをダウンロードしてきてcheckstyle.xmlにリネームする。
これが一般的に使われる設定ファイルで、複数人で開発する際に一貫性のあるコーディングスタイルを守って開発できる。
gradlew check or buildコマンドでcheckstyleを実行すると、build/reports/checkstyle/配下にHTMLファイルが作成されるため、それをブラウザで表示。チェック結果を以下のようなページで確認できる。

(画面サンプルは参考元から引用。)

まとめ

checkstyleとは、複数人で開発する時に簡単にコーディングスタイルを統一できるソースコード静的解析ツール。
設定も上記のように簡単にできるため、とても便利。
実際に開発中に実行しコーディングスタイルに違反する場合はレポートに出力されるため、コーディング後はレポートを確認し修正するといい。