はじめに
Javaの開発において、コードスタイルの統一は非常に重要です。チーム開発ではもちろん、個人開発でも一貫したコーディングスタイルを保つことで、可読性の高いコードを維持できます。
今回は、EclipseでCheckstyleを導入し、ファイル保存時に自動でコードチェックを実行する方法をご紹介します。
🎯 この記事でできるようになること
- EclipseにCheckstyleプラグインをインストールする
- ファイル保存時に自動でスタイルチェックを実行する
- コーディング規約違反を即座に発見できる環境を構築する
📦 1. Checkstyleプラグインのインストール
まずはEclipseにCheckstyleプラグインをインストールしましょう。
手順
- Eclipseのメニューから Help → Eclipse Marketplace を開く
- 検索ボックスに「Checkstyle」と入力して検索
- 「Checkstyle Plug-in」の Install ボタンをクリック
- ライセンスに同意してインストールを進める
- インストール完了後、Eclipseを再起動
💡 Tips: すでにインストール済みの場合は、この手順はスキップしてください。
⚙️ 2. プロジェクトでCheckstyleを有効化
プラグインをインストールしただけでは、まだCheckstyleは動作しません。
プロジェクトごとに有効化する必要があります。
手順
- 対象のプロジェクトを右クリック → Properties を選択
- 左側のメニューから Checkstyle をクリック
- ✅ 「Checkstyle active for this project」 にチェックを入れる
- 使用する Configuration(チェックスタイル設定)を選択
- Apply and Close をクリック
[プロジェクト右クリック]
└── Properties
└── Checkstyle
└── ✅ Checkstyle active for this project
💡 Configurationについて
デフォルトでは以下の設定が用意されています:
| Configuration名 | 説明 |
|---|---|
| Sun Checks | Sun Microsystems(現Oracle)のコーディング規約 |
| Google Checks | Googleのコーディング規約 |
チーム独自のルールを使いたい場合は、カスタム設定ファイル(checkstyle.xml)を読み込むこともできます。
🔄 3. 自動ビルドを有効にする
ここが最も重要なポイントです!
Checkstyleはビルド時に実行されるため、自動ビルドが有効になっていないと、ファイル保存時にチェックが走りません。
確認手順
- Eclipseのメニューから Project をクリック
- 「Build Automatically」 に✅チェックが入っているか確認
Project
└── ✅ Build Automatically ← これにチェック!
⚠️ 注意: この設定がオフになっていると、ファイルを保存してもCheckstyleが実行されません。
🔧 4. 【トラブルシューティング】動作しない場合
上記の設定を行っても動作しない場合は、Buildersの設定を確認しましょう。
確認手順
- プロジェクトを右クリック → Properties
- 左メニューから Builders を選択
- リストに「Checkstyle Builder」が存在するか確認
- チェックボックスが有効になっているか確認
Builders
└── ✅ Checkstyle Builder ← 有効になっているか確認
└── ✅ Java Builder
✨ 動作確認
設定が完了したら、実際に動作確認してみましょう。
- Javaファイルを開く
- わざとスタイル違反のコードを書く(例:インデントを崩す、行末にスペースを入れる等)
- ファイルを保存(
Ctrl + S) - 違反箇所に黄色い警告マークや赤いエラーマークが表示されればOK!
// 例:スペースの問題があるコード
public class Sample{ // ← {の前にスペースがない
public void test(){
int x=1; // ← =の前後にスペースがない
}
}
📝 まとめ
| 手順 | 内容 |
|---|---|
| Step 1 | Checkstyleプラグインをインストール |
| Step 2 | プロジェクトでCheckstyleを有効化 |
| Step 3 | 「Build Automatically」を有効にする |
| Step 4 | (必要に応じて)Buildersの設定を確認 |
この設定により、ファイルを保存するたびに自動でコードスタイルがチェックされ、違反があれば即座に警告が表示されるようになります。
コードレビューの負担軽減や、品質の高いコードを維持するために、ぜひCheckstyleを活用してみてください!
🔗 参考リンク
最後まで読んでいただきありがとうございました!
この記事が参考になりましたら、ぜひ「いいね」をお願いします 👍